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

Inherits:

Struct

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

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-ssm/types.rb

Overview

See Also:

• AWS API Documentation

Instance Attribute Summary

• #attachments_content ⇒ Array<Types::AttachmentContent>

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

• #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.

• #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, etc.

Returns:

• (Array<Types::AttachmentContent>)

# File 'lib/aws-sdk-ssm/types.rb', line 6009

class GetDocumentResult < Struct.new(
  :name,
  :version_name,
  :document_version,
  :status,
  :status_information,
  :content,
  :document_type,
  :document_format,
  :attachments_content)
  include Aws::Structure
end

#content ⇒ String

The contents of the Systems Manager document.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 6009

class GetDocumentResult < Struct.new(
  :name,
  :version_name,
  :document_version,
  :status,
  :status_information,
  :content,
  :document_type,
  :document_format,
  :attachments_content)
  include Aws::Structure
end

#document_format ⇒ String

The document format, either JSON or YAML.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 6009

class GetDocumentResult < Struct.new(
  :name,
  :version_name,
  :document_version,
  :status,
  :status_information,
  :content,
  :document_type,
  :document_format,
  :attachments_content)
  include Aws::Structure
end

#document_type ⇒ String

The document type.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 6009

class GetDocumentResult < Struct.new(
  :name,
  :version_name,
  :document_version,
  :status,
  :status_information,
  :content,
  :document_type,
  :document_format,
  :attachments_content)
  include Aws::Structure
end

#document_version ⇒ String

The document version.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 6009

class GetDocumentResult < Struct.new(
  :name,
  :version_name,
  :document_version,
  :status,
  :status_information,
  :content,
  :document_type,
  :document_format,
  :attachments_content)
  include Aws::Structure
end

#name ⇒ String

The name of the Systems Manager document.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 6009

class GetDocumentResult < Struct.new(
  :name,
  :version_name,
  :document_version,
  :status,
  :status_information,
  :content,
  :document_type,
  :document_format,
  :attachments_content)
  include Aws::Structure
end

#status ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 6009

class GetDocumentResult < Struct.new(
  :name,
  :version_name,
  :document_version,
  :status,
  :status_information,
  :content,
  :document_type,
  :document_format,
  :attachments_content)
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-ssm/types.rb', line 6009

class GetDocumentResult < Struct.new(
  :name,
  :version_name,
  :document_version,
  :status,
  :status_information,
  :content,
  :document_type,
  :document_format,
  :attachments_content)
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-ssm/types.rb', line 6009

class GetDocumentResult < Struct.new(
  :name,
  :version_name,
  :document_version,
  :status,
  :status_information,
  :content,
  :document_type,
  :document_format,
  :attachments_content)
  include Aws::Structure
end