Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

ListDocumentVersions

List all versions for a document.

Request Syntax


{
   "MaxResults": number,
   "Name": "string",
   "NextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

MaxResults

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

Name

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

Type: String

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

Required: Yes

NextToken

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

Type: String

Required: No

Response Syntax


{
   "DocumentVersions": [ 
      { 
         "CreatedDate": number,
         "DisplayName": "string",
         "DocumentFormat": "string",
         "DocumentVersion": "string",
         "IsDefaultVersion": boolean,
         "Name": "string",
         "ReviewStatus": "string",
         "Status": "string",
         "StatusInformation": "string",
         "VersionName": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DocumentVersions

The document versions.

Type: Array of DocumentVersionInfo objects

Array Members: Minimum number of 1 item.

NextToken

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

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500

InvalidDocument

The specified SSM document doesn't exist.

HTTP Status Code: 400

InvalidNextToken

The specified token isn't valid.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of ListDocumentVersions.

Sample Request


POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.ListDocumentVersions
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240325T151751Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 30

{
    "Name": "AWS-UpdateSSMAgent"
}

Sample Response


{
    "DocumentVersions": [
        {
            "CreatedDate": 1486594364.541,
            "DisplayName": "ExampleDoc",
            "DocumentFormat": "JSON",
            "DocumentVersion": "1",
            "IsDefaultVersion": true,
            "Name": "AWS-UpdateSSMAgent",
            "Status": "Active"
        }
    ]
}