AWS System Manager

Get document

Get the contents of the specified Amazon Web Services Systems Manager document (SSM document).

Inputs

Field

Type

Description

region [required]

enum

default: us-east-1

documentName [required]

string

The name of the SSM document.

Outputs

Expand All

Field

Type

Description

document [required]

object

name

string

The name of the SSM document.

createdDate

date-time

The date the SSM document was created.

displayName

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.

versionName

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.

documentVersion

string

The document version.

status

string

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

statusInformation

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."

content

string

The contents of the SSM document.

documentType

string

The document type.

documentFormat

string

The document format, either JSON or YAML.

requires

[object]

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

Name [required]

string

The name of the required SSM document. The name can be an Amazon Resource Name (ARN).

Version

string

The document version required by the current document.

RequireType

string

The document type of the required SSM document.

VersionName

string

An optional field specifying 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.

attachmentsContent

[object]

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

Name

string

The name of an attachment.

Size

number

The size of an attachment in bytes.

Hash

string

The cryptographic hash value of the document content.

HashType

string

The hash algorithm used to calculate the hash value.

Url

string

The URL location of the attachment content.

reviewStatus

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.

amzRequestId [required]

string