AWS Systems Manager
API Reference (API Version 2014-11-06)
AWS services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with AWS services in China.

DocumentDescription

Describes a Systems Manager document.

Contents

AttachmentsInformation

Details about the document attachments, including names, locations, sizes, etc.

Type: Array of AttachmentInformation objects

Required: No

CreatedDate

The date when the document was created.

Type: Timestamp

Required: No

DefaultVersion

The default version.

Type: String

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

Required: No

Description

A description of the document.

Type: String

Required: No

DocumentFormat

The document format, either JSON or YAML.

Type: String

Valid Values: YAML | JSON

Required: No

DocumentType

The type of document.

Type: String

Valid Values: Command | Policy | Automation | Session | Package

Required: No

DocumentVersion

The document version.

Type: String

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

Required: No

Hash

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

Note

Sha1 hashes have been deprecated.

Type: String

Length Constraints: Maximum length of 256.

Required: No

HashType

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

Note

Sha1 hashes have been deprecated.

Type: String

Valid Values: Sha256 | Sha1

Required: No

LatestVersion

The latest version of the document.

Type: String

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

Required: No

Name

The name of the Systems Manager document.

Type: String

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

Required: No

Owner

The AWS user account that created the document.

Type: String

Required: No

Parameters

A description of the parameters for a document.

Type: Array of DocumentParameter objects

Required: No

PlatformTypes

The list of OS platforms compatible with this Systems Manager document.

Type: Array of strings

Valid Values: Windows | Linux

Required: No

SchemaVersion

The schema version.

Type: String

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

Required: No

Sha1

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

Type: String

Required: No

Status

The status of the Systems Manager document.

Type: String

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

Required: No

StatusInformation

A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct."

Type: String

Required: No

Tags

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

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 AWS Resource Types Reference in the AWS CloudFormation User Guide.

Type: String

Length Constraints: Maximum length of 200.

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

Required: No

VersionName

The version of the artifact associated with the document.

Type: String

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

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: