Struct aws_sdk_ssm::types::DocumentDescription

#[non_exhaustive]
pub struct DocumentDescription {

    pub sha1: Option<String>,
    pub hash: Option<String>,
    pub hash_type: Option<DocumentHashType>,
    pub name: Option<String>,
    pub display_name: Option<String>,
    pub version_name: Option<String>,
    pub owner: Option<String>,
    pub created_date: Option<DateTime>,
    pub status: Option<DocumentStatus>,
    pub status_information: Option<String>,
    pub document_version: Option<String>,
    pub description: Option<String>,
    pub parameters: Option<Vec<DocumentParameter>>,
    pub platform_types: Option<Vec<PlatformType>>,
    pub document_type: Option<DocumentType>,
    pub schema_version: Option<String>,
    pub latest_version: Option<String>,
    pub default_version: Option<String>,
    pub document_format: Option<DocumentFormat>,
    pub target_type: Option<String>,
    pub tags: Option<Vec<Tag>>,
    pub attachments_information: Option<Vec<AttachmentInformation>>,
    pub requires: Option<Vec<DocumentRequires>>,
    pub author: Option<String>,
    pub review_information: Option<Vec<ReviewInformation>>,
    pub approved_version: Option<String>,
    pub pending_review_version: Option<String>,
    pub review_status: Option<ReviewStatus>,
    pub category: Option<Vec<String>>,
    pub category_enum: Option<Vec<String>>,
}

Describes an Amazon Web Services Systems Manager document (SSM document).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

sha1: Option<String>

The SHA1 hash of the document, which you can use for verification.

hash: Option<String>

The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

hash_type: Option<DocumentHashType>

The hash type of the document. Valid values include Sha256 or Sha1.

Sha1 hashes have been deprecated.

name: Option<String>

The name of the SSM document.

display_name: Option<String>

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.

version_name: Option<String>

The version of the artifact associated with the document.

owner: Option<String>

The Amazon Web Services user that created the document.

created_date: Option<DateTime>

The date when the document was created.

status: Option<DocumentStatus>

The status of the SSM document.

status_information: Option<String>

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."

document_version: Option<String>

The document version.

description: Option<String>

A description of the document.

parameters: Option<Vec<DocumentParameter>>

A description of the parameters for a document.

platform_types: Option<Vec<PlatformType>>

The list of operating system (OS) platforms compatible with this SSM document.

document_type: Option<DocumentType>

The type of document.

schema_version: Option<String>

The schema version.

latest_version: Option<String>

The latest version of the document.

default_version: Option<String>

The default version.

document_format: Option<DocumentFormat>

The document format, either JSON or YAML.

target_type: Option<String>

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.

tags: Option<Vec<Tag>>

The tags, or metadata, that have been applied to the document.

attachments_information: Option<Vec<AttachmentInformation>>

Details about the document attachments, including names, locations, sizes, and so on.

requires: Option<Vec<DocumentRequires>>

A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

author: Option<String>

The user in your organization who created the document.

review_information: Option<Vec<ReviewInformation>>

Details about the review of a document.

approved_version: Option<String>

The version of the document currently approved for use in the organization.

pending_review_version: Option<String>

The version of the document that is currently under review.

review_status: Option<ReviewStatus>

The current status of the review.

category: Option<Vec<String>>

The classification of a document to help you identify and categorize its use.

category_enum: Option<Vec<String>>

The value that identifies a document's category.

Implementations

impl DocumentDescription

pub fn sha1(&self) -> Option<&str>

The SHA1 hash of the document, which you can use for verification.

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.

pub fn hash_type(&self) -> Option<&DocumentHashType>

The hash type of the document. Valid values include Sha256 or Sha1.

Sha1 hashes have been deprecated.

pub fn name(&self) -> Option<&str>

The name of the SSM document.

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.

pub fn version_name(&self) -> Option<&str>

The version of the artifact associated with the document.

pub fn owner(&self) -> Option<&str>

The Amazon Web Services user that created the document.

pub fn created_date(&self) -> Option<&DateTime>

The date when the document was created.

pub fn status(&self) -> Option<&DocumentStatus>

The status of the SSM document.

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."

pub fn document_version(&self) -> Option<&str>

The document version.

pub fn description(&self) -> Option<&str>

A description of the document.

pub fn parameters(&self) -> &[DocumentParameter]

A description of the parameters for a document.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .parameters.is_none().

pub fn platform_types(&self) -> &[PlatformType]

The list of operating system (OS) platforms compatible with this SSM document.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .platform_types.is_none().

pub fn document_type(&self) -> Option<&DocumentType>

The type of document.

pub fn schema_version(&self) -> Option<&str>

The schema version.

pub fn latest_version(&self) -> Option<&str>

The latest version of the document.

pub fn default_version(&self) -> Option<&str>

The default version.

pub fn document_format(&self) -> Option<&DocumentFormat>

The document format, either JSON or YAML.

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.

pub fn tags(&self) -> &[Tag]

The tags, or metadata, that have been applied to the document.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn attachments_information(&self) -> &[AttachmentInformation]

Details about the document attachments, including names, locations, sizes, and so on.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .attachments_information.is_none().

pub fn requires(&self) -> &[DocumentRequires]

A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .requires.is_none().

pub fn author(&self) -> Option<&str>

The user in your organization who created the document.

pub fn review_information(&self) -> &[ReviewInformation]

Details about the review of a document.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .review_information.is_none().

pub fn approved_version(&self) -> Option<&str>

The version of the document currently approved for use in the organization.

pub fn pending_review_version(&self) -> Option<&str>

The version of the document that is currently under review.

pub fn review_status(&self) -> Option<&ReviewStatus>

The current status of the review.

pub fn category(&self) -> &[String]

The classification of a document to help you identify and categorize its use.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .category.is_none().

pub fn category_enum(&self) -> &[String]

The value that identifies a document's category.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .category_enum.is_none().

impl DocumentDescription

pub fn builder() -> DocumentDescriptionBuilder

Creates a new builder-style object to manufacture DocumentDescription.

Trait Implementations

impl Clone for DocumentDescription

fn clone(&self) -> DocumentDescription

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DocumentDescription

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DocumentDescription

fn eq(&self, other: &DocumentDescription) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DocumentDescription