Struct aws_sdk_ssm::model::DocumentDescription
source · [−]#[non_exhaustive]pub struct DocumentDescription { /* private fields */ }Expand description
Describes an Amazon Web Services Systems Manager document (SSM document).
Implementations
sourceimpl DocumentDescription
impl DocumentDescription
sourcepub fn sha1(&self) -> Option<&str>
pub fn sha1(&self) -> Option<&str>
The SHA1 hash of the document, which you can use for verification.
sourcepub fn hash(&self) -> Option<&str>
pub fn hash(&self) -> Option<&str>
The Sha256 or Sha1 hash created by the system when the document was created.
Sha1 hashes have been deprecated.
sourcepub fn hash_type(&self) -> Option<&DocumentHashType>
pub fn hash_type(&self) -> Option<&DocumentHashType>
The hash type of the document. Valid values include Sha256 or Sha1.
Sha1 hashes have been deprecated.
sourcepub fn display_name(&self) -> Option<&str>
pub fn display_name(&self) -> Option<&str>
The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.
sourcepub fn version_name(&self) -> Option<&str>
pub fn version_name(&self) -> Option<&str>
The version of the artifact associated with the document.
sourcepub fn owner(&self) -> Option<&str>
pub fn owner(&self) -> Option<&str>
The Amazon Web Services user account that created the document.
sourcepub fn created_date(&self) -> Option<&DateTime>
pub fn created_date(&self) -> Option<&DateTime>
The date when the document was created.
sourcepub fn status(&self) -> Option<&DocumentStatus>
pub fn status(&self) -> Option<&DocumentStatus>
The status of the SSM document.
sourcepub fn status_information(&self) -> Option<&str>
pub fn status_information(&self) -> Option<&str>
A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."
sourcepub fn document_version(&self) -> Option<&str>
pub fn document_version(&self) -> Option<&str>
The document version.
sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A description of the document.
sourcepub fn parameters(&self) -> Option<&[DocumentParameter]>
pub fn parameters(&self) -> Option<&[DocumentParameter]>
A description of the parameters for a document.
sourcepub fn platform_types(&self) -> Option<&[PlatformType]>
pub fn platform_types(&self) -> Option<&[PlatformType]>
The list of operating system (OS) platforms compatible with this SSM document.
sourcepub fn document_type(&self) -> Option<&DocumentType>
pub fn document_type(&self) -> Option<&DocumentType>
The type of document.
sourcepub fn schema_version(&self) -> Option<&str>
pub fn schema_version(&self) -> Option<&str>
The schema version.
sourcepub fn latest_version(&self) -> Option<&str>
pub fn latest_version(&self) -> Option<&str>
The latest version of the document.
sourcepub fn default_version(&self) -> Option<&str>
pub fn default_version(&self) -> Option<&str>
The default version.
sourcepub fn document_format(&self) -> Option<&DocumentFormat>
pub fn document_format(&self) -> Option<&DocumentFormat>
The document format, either JSON or YAML.
sourcepub fn target_type(&self) -> Option<&str>
pub fn target_type(&self) -> Option<&str>
The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
The tags, or metadata, that have been applied to the document.
sourcepub fn attachments_information(&self) -> Option<&[AttachmentInformation]>
pub fn attachments_information(&self) -> Option<&[AttachmentInformation]>
Details about the document attachments, including names, locations, sizes, and so on.
sourcepub fn requires(&self) -> Option<&[DocumentRequires]>
pub fn requires(&self) -> Option<&[DocumentRequires]>
A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
The user in your organization who created the document.
sourcepub fn review_information(&self) -> Option<&[ReviewInformation]>
pub fn review_information(&self) -> Option<&[ReviewInformation]>
Details about the review of a document.
sourcepub fn approved_version(&self) -> Option<&str>
pub fn approved_version(&self) -> Option<&str>
The version of the document currently approved for use in the organization.
sourcepub fn pending_review_version(&self) -> Option<&str>
pub fn pending_review_version(&self) -> Option<&str>
The version of the document that is currently under review.
sourcepub fn review_status(&self) -> Option<&ReviewStatus>
pub fn review_status(&self) -> Option<&ReviewStatus>
The current status of the review.
sourcepub fn category(&self) -> Option<&[String]>
pub fn category(&self) -> Option<&[String]>
The classification of a document to help you identify and categorize its use.
sourcepub fn category_enum(&self) -> Option<&[String]>
pub fn category_enum(&self) -> Option<&[String]>
The value that identifies a document's category.
sourceimpl DocumentDescription
impl DocumentDescription
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture DocumentDescription.
Trait Implementations
sourceimpl Clone for DocumentDescription
impl Clone for DocumentDescription
sourcefn clone(&self) -> DocumentDescription
fn clone(&self) -> DocumentDescription
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more