@aws-sdk/client-ssm

GetDocumentCommandOutput Interface

The output of GetDocumentCommand.

Members

Name
Type
Details
$metadata RequiredResponseMetadata
Metadata pertaining to this request.
AttachmentsContent AttachmentContent[] | undefined

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

Content string | undefined

The contents of the SSM document.

CreatedDate Date | undefined

The date the SSM document was created.

DisplayName string | undefined

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.

DocumentFormat DocumentFormat | undefined

The document format, either JSON or YAML.

DocumentType DocumentType | undefined

The document type.

DocumentVersion string | undefined

The document version.

Name string | undefined

The name of the SSM document.

Requires DocumentRequires[] | undefined

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

ReviewStatus ReviewStatus | undefined

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.

Status DocumentStatus | undefined

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

StatusInformation string | undefined

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

VersionName string | undefined

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.

Full Signature

export interface GetDocumentCommandOutput extends GetDocumentResult, MetadataBearer