Struct aws_sdk_ssm::operation::get_document::GetDocumentOutput

#[non_exhaustive]
pub struct GetDocumentOutput {

    pub name: Option<String>,
    pub created_date: Option<DateTime>,
    pub display_name: Option<String>,
    pub version_name: Option<String>,
    pub document_version: Option<String>,
    pub status: Option<DocumentStatus>,
    pub status_information: Option<String>,
    pub content: Option<String>,
    pub document_type: Option<DocumentType>,
    pub document_format: Option<DocumentFormat>,
    pub requires: Option<Vec<DocumentRequires>>,
    pub attachments_content: Option<Vec<AttachmentContent>>,
    pub review_status: Option<ReviewStatus>,
    /* private fields */
}

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.

name: Option<String>

The name of the SSM document.

created_date: Option<DateTime>

The date the SSM document was created.

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. For example, 12.6. This value is unique across all versions of a document, and can't be changed.

document_version: Option<String>

The document version.

status: Option<DocumentStatus>

The status of the SSM document, such as Creating, Active, Updating, Failed, and Deleting.

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

content: Option<String>

The contents of the SSM document.

document_type: Option<DocumentType>

The document type.

document_format: Option<DocumentFormat>

The document format, either JSON or YAML.

requires: Option<Vec<DocumentRequires>>

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

attachments_content: Option<Vec<AttachmentContent>>

A description of the document attachments, including names, locations, sizes, and so on.

review_status: Option<ReviewStatus>

The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.

Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.

Only one version of an SSM document can be in review, or PENDING, at a time.

Implementations

impl GetDocumentOutput

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

The name of the SSM document.

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

The date the SSM document was created.

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. For example, 12.6. This value is unique across all versions of a document, and can't be changed.

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

The document version.

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

The status of the SSM document, such as Creating, Active, Updating, Failed, and Deleting.

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 content(&self) -> Option<&str>

The contents of the SSM document.

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

The document type.

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

The document format, either JSON or YAML.

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 attachments_content(&self) -> &[AttachmentContent]

A description of 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_content.is_none().

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

The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.

Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.

Only one version of an SSM document can be in review, or PENDING, at a time.

impl GetDocumentOutput

pub fn builder() -> GetDocumentOutputBuilder

Creates a new builder-style object to manufacture GetDocumentOutput.

Trait Implementations

impl Clone for GetDocumentOutput

fn clone(&self) -> GetDocumentOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetDocumentOutput

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

Formats the value using the given formatter.

impl PartialEq for GetDocumentOutput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl RequestId for GetDocumentOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for GetDocumentOutput