DocumentDescription

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

Type: String

Pattern: ([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)

Required: No

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

Type: Array of AttachmentInformation objects

Required: No

The user in your organization who created the document.

Type: String

Required: No

The classification of a document to help you identify and categorize its use.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 3 items.

Length Constraints: Maximum length of 128.

Required: No

The value that identifies a document's category.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 3 items.

Length Constraints: Maximum length of 128.

Required: No

The date when the document was created.

Type: Timestamp

Required: No

The default version.

Type: String

Pattern: ([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)

Required: No

A description of the document.

Type: String

Required: No

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.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: ^[\w\.\-\:\/ ]*$

Required: No

The document format, either JSON or YAML.

Type: String

Valid Values: YAML | JSON | TEXT

Required: No

The type of document.

Type: String

Valid Values: Command | Policy | Automation | Session | Package | ApplicationConfiguration | ApplicationConfigurationSchema | DeploymentStrategy | ChangeCalendar | Automation.ChangeTemplate | ProblemAnalysis | ProblemAnalysisTemplate | CloudFormation | ConformancePackTemplate | QuickSetup

Required: No

The document version.

Type: String

Pattern: ([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)

Required: No

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

Type: String

Length Constraints: Maximum length of 256.

Required: No

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

Type: String

Valid Values: Sha256 | Sha1

Required: No

The latest version of the document.

Type: String

Pattern: ([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)

Required: No

The name of the SSM document.

Type: String

Pattern: ^[a-zA-Z0-9_\-.:/]{3,128}$

Required: No

The Amazon Web Services user that created the document.

Type: String

Required: No

A description of the parameters for a document.

Type: Array of DocumentParameter objects

Required: No

The version of the document that is currently under review.

Type: String

Pattern: ([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)

Required: No

The list of operating system (OS) platforms compatible with this SSM document.

Type: Array of strings

Valid Values: Windows | Linux | MacOS

Required: No

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

Type: Array of DocumentRequires objects

Array Members: Minimum number of 1 item.

Required: No

Details about the review of a document.

Type: Array of ReviewInformation objects

Array Members: Minimum number of 1 item.

Required: No

The current status of the review.

Type: String

Valid Values: APPROVED | NOT_REVIEWED | PENDING | REJECTED

Required: No

The schema version.

Type: String

Pattern: ([0-9]+)\.([0-9]+)

Required: No

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

Type: String

Required: No

The status of the SSM document.

Type: String

Valid Values: Creating | Active | Updating | Deleting | Failed

Required: No

A message returned by Amazon 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."

Type: String

Required: No

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

Type: Array of Tag objects

Array Members: Maximum number of 1000 items.

Required: No

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 resource and property types reference in the Amazon CloudFormation User Guide.

Type: String

Length Constraints: Maximum length of 200.

Pattern: ^\/[\w\.\-\:\/]*$

Required: No

The version of the artifact associated with the document.

Type: String

Pattern: ^[a-zA-Z0-9_\-.]{1,128}$

Required: No