Class: Aws::SSM::Types::GetDocumentResult

Inherits:

Struct

• Object
• Struct
• Aws::SSM::Types::GetDocumentResult

Defined in:

(unknown)

Overview

Returned by:

• Client#get_document

See Also:

• AWS API Documentation

Instance Attribute Summary

• #attachments_content ⇒ Array<Types::AttachmentContent>

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

• #content ⇒ String

  The contents of the Systems Manager document.

• #document_format ⇒ String

  The document format, either JSON or YAML.

• #document_type ⇒ String

  The document type.

• #document_version ⇒ String

  The document version.

• #name ⇒ String

  The name of the Systems Manager document.

• #requires ⇒ Array<Types::DocumentRequires>

  A list of SSM documents required by a document.

• #status ⇒ String

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

• #status_information ⇒ String

  A message returned by AWS Systems Manager that explains the Status value.

• #version_name ⇒ String

  The version of the artifact associated with the document.

Instance Attribute Details

#attachments_content ⇒ Array<Types::AttachmentContent>

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

Returns:

• (Array<Types::AttachmentContent>) —

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

#content ⇒ String

The contents of the Systems Manager document.

Returns:

• (String) —

  The contents of the Systems Manager document.

#document_format ⇒ String

The document format, either JSON or YAML.

Possible values:

• YAML
• JSON
• TEXT

Returns:

• (String) —

  The document format, either JSON or YAML.

#document_type ⇒ String

The document type.

Possible values:

• Command
• Policy
• Automation
• Session
• Package
• ApplicationConfiguration
• ApplicationConfigurationSchema
• DeploymentStrategy
• ChangeCalendar

Returns:

• (String) —

  The document type.

#document_version ⇒ String

The document version.

Returns:

• (String) —

  The document version.

#name ⇒ String

The name of the Systems Manager document.

Returns:

• (String) —

  The name of the Systems Manager document.

#requires ⇒ Array<Types::DocumentRequires>

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

Returns:

• (Array<Types::DocumentRequires>) —

  A list of SSM documents required by a document.

#status ⇒ String

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

Possible values:

• Creating
• Active
• Updating
• Deleting
• Failed

Returns:

• (String) —

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

#status_information ⇒ String

A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, \"The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct.\"

Returns:

• (String) —

  A message returned by AWS Systems Manager that explains the Status value.

#version_name ⇒ String

The version of the artifact associated with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and cannot be changed.

Returns:

• (String) —

  The version of the artifact associated with the document.