/

The Amazon SSM multi-region endpoint

http://ssm.{region}.amazonaws.com

POST

Updates information related to approval reviews for a specific version of a change template in Change Manager.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Name": "string",
    "DocumentVersion": "string",
    "DocumentReviews": {
        "Action": "SendForReview",
        "Comment": []
    }
}'

Response Example

200 - Example 1

{}

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

Name

string

required

The name of the change template for which a version's metadata is to be updated.

Match pattern:

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

DocumentVersion

string

optional

The version of a change template in which to update approval metadata.

Match pattern:

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

DocumentReviews

object

required

The change template review details to update.

Action

enum<string>

required

The action to take on a document approval review request.

Allowed values:

SendForReviewUpdateReviewApproveReject

Comment

array[object (DocumentReviewCommentSource) {2}]

optional

A comment entered by a user in your organization about the document review request.

>= 0 items<= 1 items

Examples

Responses

🟢200Success

application/json

Body

object {0}

🟠480InternalServerError

🟠481InvalidDocument

🟠482InvalidDocumentOperation

🟠483InvalidDocumentVersion