/ - Amazon Simple Systems Manager (SSM)

List all versions for a document.

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \ --header 'X-Amz-Target;' \ --header 'Content-Type: application/json' \ --data-raw '{ "Name": "string", "MaxResults": 0, "NextToken": "string" }'

Request

Query Params

MaxResults

string

optional

Pagination limit

NextToken

string

optional

Pagination token

Header Params

X-Amz-Target

string

required

Body Params application/json

Name

string

required

The name of the document. You can specify an Amazon Resource Name (ARN).

Match pattern:

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

MaxResults

integer

optional

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

>= 1<= 50

NextToken

string

optional

The token for the next set of items to return. (You received this token from a previous call.)

Examples

Responses

🟢200Success

application/json

Body

DocumentVersions

array[object (DocumentVersionInfo) {10}]

optional

The document versions.

>= 1 items

Name

string

optional

The document name.

Match pattern:

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

DisplayName

string

optional

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.

<= 1024 characters

Match pattern:

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

DocumentVersion

string

optional

The document version.

Match pattern:

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

VersionName

string

optional

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.

Match pattern:

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

CreatedDate

string <date-time>

optional

The date the document was created.

IsDefaultVersion

boolean

optional

An identifier for the default version of the document.

DocumentFormat

enum<string>

optional

The document format, either JSON or YAML.

Allowed values:

YAMLJSONTEXT

Status

enum<string>

optional

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

Allowed values:

CreatingActiveUpdatingDeletingFailed

StatusInformation

string

optional

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

ReviewStatus

enum<string>

optional

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

Allowed values:

APPROVEDNOT_REVIEWEDPENDINGREJECTED

NextToken

string

optional

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

🟠480InternalServerError

🟠481InvalidNextToken

🟠482InvalidDocument