You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#attachments_contentArray<Types::AttachmentContent>

A description of the document attachments, including names, locations, sizes, etc.

Returns:

  • (Array<Types::AttachmentContent>)

    A description of the document attachments, including names, locations, sizes, etc.

#contentString

The contents of the Systems Manager document.

Returns:

  • (String)

    The contents of the Systems Manager document.

#document_formatString

The document format, either JSON or YAML.

Possible values:

  • YAML
  • JSON

Returns:

  • (String)

    The document format, either JSON or YAML.

#document_typeString

The document type.

Possible values:

  • Command
  • Policy
  • Automation
  • Session
  • Package

Returns:

  • (String)

    The document type.

#document_versionString

The document version.

Returns:

  • (String)

    The document version.

#nameString

The name of the Systems Manager document.

Returns:

  • (String)

    The name of the Systems Manager document.

#statusString

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_informationString

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_nameString

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.