ListDocumentMetadataHistory
Information about approval reviews for a version of a change template in Change Manager.
Request Syntax
{
"DocumentVersion": "string",
"MaxResults": number,
"Metadata": "string",
"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.
- DocumentVersion
-
The version of the change template.
Type: String
Pattern:
([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)Required: No
- 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
- Metadata
-
The type of data for which details are being requested. Currently, the only supported value is
DocumentReviews.Type: String
Valid Values:
DocumentReviewsRequired: Yes
- Name
-
The name of the change template.
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
{
"Author": "string",
"DocumentVersion": "string",
"Metadata": {
"ReviewerResponse": [
{
"Comment": [
{
"Content": "string",
"Type": "string"
}
],
"CreateTime": number,
"Reviewer": "string",
"ReviewStatus": "string",
"UpdatedTime": number
}
]
},
"Name": "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.
- Author
-
The user ID of the person in the organization who requested the review of the change template.
Type: String
- DocumentVersion
-
The version of the change template.
Type: String
Pattern:
([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$) - Metadata
-
Information about the response to the change template approval request.
Type: DocumentMetadataResponseInfo object
- Name
-
The name of the change template.
Type: String
Pattern:
^[a-zA-Z0-9_\-.]{3,128}$ - NextToken
-
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: 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
- InvalidDocumentVersion
-
The document version isn't valid or 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 ListDocumentMetadataHistory.
Sample Request
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.ListDocumentMetadataHistory
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: 20240730T154930Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240730/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 68
{
"Name": "MyChangeManagerTemplate",
"Metadata": "DocumentReviews"
}Sample Response
{
"Name": "MyChangeManagerTemplate",
"DocumentVersion": "1",
"Author": "arn:aws:iam::111122223333:user/JohnDoe",
"Metadata": {
"ReviewerResponse": [
{
"CreateTime": "2024-07-30T11:58:28.025000-07:00",
"UpdatedTime": "2024-07-30T12:01:19.274000-07:00",
"ReviewStatus": "APPROVED",
"Comment": [
{
"Type": "COMMENT",
"Content": "I approve this template version"
}
],
"Reviewer": "arn:aws:iam::111122223333:user/ShirleyRodriguez"
},
{
"CreateTime": "2024-07-30T11:58:28.025000-07:00",
"UpdatedTime": "2024-07-30T11:58:28.025000-07:00",
"ReviewStatus": "PENDING"
}
]
}
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
