Struct DocumentVersionInfo

#[non_exhaustive]
pub struct DocumentVersionInfo {
    pub name: Option<String>,
    pub display_name: Option<String>,
    pub document_version: Option<String>,
    pub version_name: Option<String>,
    pub created_date: Option<DateTime>,
    pub is_default_version: bool,
    pub document_format: Option<DocumentFormat>,
    pub status: Option<DocumentStatus>,
    pub status_information: Option<String>,
    pub review_status: Option<ReviewStatus>,
}

Version information about the 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.

name: Option<String>

The document name.

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.

document_version: Option<String>

The document version.

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.

created_date: Option<DateTime>

The date the document was created.

is_default_version: bool

An identifier for the default version of the document.

document_format: Option<DocumentFormat>

The document format, either JSON or YAML.

status: Option<DocumentStatus>

The status of the SSM document, such as Creating, Active, 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."

review_status: Option<ReviewStatus>

The current status of the approval review for the latest version of the document.

Implementations

impl DocumentVersionInfo

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

The document name.

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

The document version.

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 created_date(&self) -> Option<&DateTime>

The date the document was created.

pub fn is_default_version(&self) -> bool

An identifier for the default version of the document.

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

The document format, either JSON or YAML.

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

The status of the SSM document, such as Creating, Active, 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 review_status(&self) -> Option<&ReviewStatus>

The current status of the approval review for the latest version of the document.

impl DocumentVersionInfo

pub fn builder() -> DocumentVersionInfoBuilder

Creates a new builder-style object to manufacture DocumentVersionInfo.

Trait Implementations

impl Clone for DocumentVersionInfo

fn clone(&self) -> DocumentVersionInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentVersionInfo

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

Formats the value using the given formatter.

impl PartialEq for DocumentVersionInfo

fn eq(&self, other: &DocumentVersionInfo) -> 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 StructuralPartialEq for DocumentVersionInfo