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
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#attachments_content ⇒ Array<Types::AttachmentContent>
A description of the document attachments, including names, locations, sizes, and so on.
-
#content ⇒ String
The contents of the SSM document.
-
#created_date ⇒ Time
The date the SSM document was created.
-
#display_name ⇒ String
The friendly name of the SSM 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 SSM document.
-
#requires ⇒ Array<Types::DocumentRequires>
A list of SSM documents required by a document.
-
#review_status ⇒ String
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.
-
#status ⇒ String
The status of the SSM document, such as ‘Creating`, `Active`, `Updating`, `Failed`, and `Deleting`.
-
#status_information ⇒ String
A message returned by Amazon Web Services 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.
7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 |
# File 'lib/aws-sdk-ssm/types.rb', line 7673 class GetDocumentResult < Struct.new( :name, :created_date, :display_name, :version_name, :document_version, :status, :status_information, :content, :document_type, :document_format, :requires, :attachments_content, :review_status) SENSITIVE = [] include Aws::Structure end |
#content ⇒ String
The contents of the SSM document.
7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 |
# File 'lib/aws-sdk-ssm/types.rb', line 7673 class GetDocumentResult < Struct.new( :name, :created_date, :display_name, :version_name, :document_version, :status, :status_information, :content, :document_type, :document_format, :requires, :attachments_content, :review_status) SENSITIVE = [] include Aws::Structure end |
#created_date ⇒ Time
The date the SSM document was created.
7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 |
# File 'lib/aws-sdk-ssm/types.rb', line 7673 class GetDocumentResult < Struct.new( :name, :created_date, :display_name, :version_name, :document_version, :status, :status_information, :content, :document_type, :document_format, :requires, :attachments_content, :review_status) SENSITIVE = [] include Aws::Structure end |
#display_name ⇒ 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.
7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 |
# File 'lib/aws-sdk-ssm/types.rb', line 7673 class GetDocumentResult < Struct.new( :name, :created_date, :display_name, :version_name, :document_version, :status, :status_information, :content, :document_type, :document_format, :requires, :attachments_content, :review_status) SENSITIVE = [] include Aws::Structure end |
#document_format ⇒ String
The document format, either JSON or YAML.
7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 |
# File 'lib/aws-sdk-ssm/types.rb', line 7673 class GetDocumentResult < Struct.new( :name, :created_date, :display_name, :version_name, :document_version, :status, :status_information, :content, :document_type, :document_format, :requires, :attachments_content, :review_status) SENSITIVE = [] include Aws::Structure end |
#document_type ⇒ String
The document type.
7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 |
# File 'lib/aws-sdk-ssm/types.rb', line 7673 class GetDocumentResult < Struct.new( :name, :created_date, :display_name, :version_name, :document_version, :status, :status_information, :content, :document_type, :document_format, :requires, :attachments_content, :review_status) SENSITIVE = [] include Aws::Structure end |
#document_version ⇒ String
The document version.
7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 |
# File 'lib/aws-sdk-ssm/types.rb', line 7673 class GetDocumentResult < Struct.new( :name, :created_date, :display_name, :version_name, :document_version, :status, :status_information, :content, :document_type, :document_format, :requires, :attachments_content, :review_status) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of the SSM document.
7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 |
# File 'lib/aws-sdk-ssm/types.rb', line 7673 class GetDocumentResult < Struct.new( :name, :created_date, :display_name, :version_name, :document_version, :status, :status_information, :content, :document_type, :document_format, :requires, :attachments_content, :review_status) SENSITIVE = [] include Aws::Structure end |
#requires ⇒ Array<Types::DocumentRequires>
A list of SSM documents required by a document. For example, an ‘ApplicationConfiguration` document requires an `ApplicationConfigurationSchema` document.
7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 |
# File 'lib/aws-sdk-ssm/types.rb', line 7673 class GetDocumentResult < Struct.new( :name, :created_date, :display_name, :version_name, :document_version, :status, :status_information, :content, :document_type, :document_format, :requires, :attachments_content, :review_status) SENSITIVE = [] include Aws::Structure end |
#review_status ⇒ String
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.
7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 |
# File 'lib/aws-sdk-ssm/types.rb', line 7673 class GetDocumentResult < Struct.new( :name, :created_date, :display_name, :version_name, :document_version, :status, :status_information, :content, :document_type, :document_format, :requires, :attachments_content, :review_status) SENSITIVE = [] include Aws::Structure end |
#status ⇒ String
The status of the SSM document, such as ‘Creating`, `Active`, `Updating`, `Failed`, and `Deleting`.
7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 |
# File 'lib/aws-sdk-ssm/types.rb', line 7673 class GetDocumentResult < Struct.new( :name, :created_date, :display_name, :version_name, :document_version, :status, :status_information, :content, :document_type, :document_format, :requires, :attachments_content, :review_status) SENSITIVE = [] include Aws::Structure end |
#status_information ⇒ 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.”
7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 |
# File 'lib/aws-sdk-ssm/types.rb', line 7673 class GetDocumentResult < Struct.new( :name, :created_date, :display_name, :version_name, :document_version, :status, :status_information, :content, :document_type, :document_format, :requires, :attachments_content, :review_status) SENSITIVE = [] 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 can’t be changed.
7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 |
# File 'lib/aws-sdk-ssm/types.rb', line 7673 class GetDocumentResult < Struct.new( :name, :created_date, :display_name, :version_name, :document_version, :status, :status_information, :content, :document_type, :document_format, :requires, :attachments_content, :review_status) SENSITIVE = [] include Aws::Structure end |