UpdateDocumentMetadata
Updates information related to approval reviews for a specific version of a change template in Change Manager.
Request Syntax
{
"DocumentReviews": {
"Action": "string",
"Comment": [
{
"Content": "string",
"Type": "string"
}
]
},
"DocumentVersion": "string",
"Name": "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.
- DocumentReviews
-
The change template review details to update.
Type: DocumentReviews object
Required: Yes
- DocumentVersion
-
The version of a change template in which to update approval metadata.
Type: String
Pattern:
([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)Required: No
- Name
-
The name of the change template for which a version's metadata is to be updated.
Type: String
Pattern:
^[a-zA-Z0-9_\-.]{3,128}$Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
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
- InvalidDocumentOperation
-
You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.
HTTP Status Code: 400
- InvalidDocumentVersion
-
The document version isn't valid or doesn't exist.
HTTP Status Code: 400
- TooManyUpdates
-
There are concurrent updates for a resource that supports one update at a time.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of UpdateDocumentMetadata.
Sample Request
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.UpdateDocumentMetadata
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
{
"DocumentReviews": [
{
"Action": "Approve",
"Comment": [
{
"Type": "Comment",
"Content": "Approved!"
}
]
}
]
}Sample Response
{}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
