Documentation

Describes a Amazon Web Services Systems Manager document (SSM document).

See: newDocumentDescription smart constructor.

Create a value of DocumentDescription with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:DocumentDescription', documentDescription_status - The status of the SSM document.

$sel:documentType:DocumentDescription', documentDescription_documentType - The type of document.

$sel:hash:DocumentDescription', documentDescription_hash - The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

$sel:versionName:DocumentDescription', documentDescription_versionName - The version of the artifact associated with the document.

$sel:schemaVersion:DocumentDescription', documentDescription_schemaVersion - The schema version.

$sel:sha1:DocumentDescription', documentDescription_sha1 - The SHA1 hash of the document, which you can use for verification.

$sel:reviewStatus:DocumentDescription', documentDescription_reviewStatus - The current status of the review.

$sel:attachmentsInformation:DocumentDescription', documentDescription_attachmentsInformation - Details about the document attachments, including names, locations, sizes, and so on.

$sel:defaultVersion:DocumentDescription', documentDescription_defaultVersion - The default version.

$sel:targetType:DocumentDescription', documentDescription_targetType - The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

$sel:owner:DocumentDescription', documentDescription_owner - The Amazon Web Services user account that created the document.

$sel:platformTypes:DocumentDescription', documentDescription_platformTypes - The list of OS platforms compatible with this SSM document.

$sel:createdDate:DocumentDescription', documentDescription_createdDate - The date when the document was created.

$sel:documentFormat:DocumentDescription', documentDescription_documentFormat - The document format, either JSON or YAML.

$sel:pendingReviewVersion:DocumentDescription', documentDescription_pendingReviewVersion - The version of the document that is currently under review.

$sel:name:DocumentDescription', documentDescription_name - The name of the SSM document.

$sel:hashType:DocumentDescription', documentDescription_hashType - The hash type of the document. Valid values include Sha256 or Sha1.

Sha1 hashes have been deprecated.

$sel:parameters:DocumentDescription', documentDescription_parameters - A description of the parameters for a document.

$sel:documentVersion:DocumentDescription', documentDescription_documentVersion - The document version.

$sel:author:DocumentDescription', documentDescription_author - The user in your organization who created the document.

$sel:displayName:DocumentDescription', documentDescription_displayName - 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.

$sel:statusInformation:DocumentDescription', documentDescription_statusInformation - 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."

$sel:description:DocumentDescription', documentDescription_description - A description of the document.

$sel:requires:DocumentDescription', documentDescription_requires - A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

$sel:reviewInformation:DocumentDescription', documentDescription_reviewInformation - Details about the review of a document.

$sel:tags:DocumentDescription', documentDescription_tags - The tags, or metadata, that have been applied to the document.

$sel:latestVersion:DocumentDescription', documentDescription_latestVersion - The latest version of the document.

$sel:approvedVersion:DocumentDescription', documentDescription_approvedVersion - The version of the document currently approved for use in the organization.

The status of the SSM document.

The type of document.

The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

The version of the artifact associated with the document.

The schema version.

The SHA1 hash of the document, which you can use for verification.

The current status of the review.

Details about the document attachments, including names, locations, sizes, and so on.

The default version.

The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

The Amazon Web Services user account that created the document.

The list of OS platforms compatible with this SSM document.

The date when the document was created.

The document format, either JSON or YAML.

The version of the document that is currently under review.

The name of the SSM document.

The hash type of the document. Valid values include Sha256 or Sha1.

Sha1 hashes have been deprecated.

A description of the parameters for a document.

The document version.

The user in your organization who created the document.

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.

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

A description of the document.

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

Details about the review of a document.

The tags, or metadata, that have been applied to the document.

The latest version of the document.

The version of the document currently approved for use in the organization.