document_versions

Creates, updates, deletes, gets or lists a document_versions resource.

Overview

Name	document_versions
Type	Resource
Id	aws.ssm.document_versions

Fields

The following fields are returned by SELECT queries:

list_document_versions

Name	Datatype	Description
created_date	string (date-time)	The date the document was created.
display_name	string	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. (pattern: <code>^[\w.-:/ ]*$</code>)
document_format	string	The document format, either JSON or YAML. (YAML, JSON, TEXT)
document_version	string	The document version. (pattern: <code>([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)</code>)
is_default_version	boolean	An identifier for the default version of the document.
name	string	The document name. (pattern: <code>^[a-zA-Z0-9_-.]{3,128}$</code>)
review_status	string	The current status of the approval review for the latest version of the document. (APPROVED, NOT_REVIEWED, PENDING, REJECTED)
status	string	The status of the SSM document, such as Creating, Active, Failed, and Deleting. (Creating, Active, Updating, Deleting, Failed)
status_information	string	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."
version_name	string	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. (pattern: <code>^[a-zA-Z0-9_-.]{1,128}$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_document_versions	select	region		List all versions for a document.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_document_versions

List all versions for a document.

SELECT
created_date,
display_name,
document_format,
document_version,
is_default_version,
name,
review_status,
status,
status_information,
version_name
FROM aws.ssm.document_versions
WHERE region = '{{ region }}' -- required
;