DocumentVersionInfo - AWS Systems Manager

DocumentVersionInfo

Version information about the document.

Contents

CreatedDate

The date the document was created.

Type: Timestamp

Required: No

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 .

Type: String

Length Constraints: Maximum length of 1024.

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

Required: No

DocumentFormat

The document format, either JSON or YAML.

Type: String

Valid Values: YAML | JSON | TEXT

Required: No

DocumentVersion

The document version.

Type: String

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

Required: No

IsDefaultVersion

An identifier for the default version of the document.

Type: Boolean

Required: No

Name

The document name.

Type: String

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

Required: No

ReviewStatus

The current status of the approval review for the latest version of the document.

Type: String

Valid Values: APPROVED | NOT_REVIEWED | PENDING | REJECTED

Required: No

Status

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

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 doesn't exist. Verify that the URL of the S3 bucket is correct."

Type: String

Required: No

VersionName

The version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed.

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: