Updates information related to approval reviews for a specific version of a change template in Change Manager.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
update-document-metadata
--name <value>
[--document-version <value>]
--document-reviews <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--name
(string)
The name of the change template for which a version’s metadata is to be updated.
--document-version
(string)
The version of a change template in which to update approval metadata.
--document-reviews
(structure)
The change template review details to update.
Action -> (string)
The action to take on a document approval review request.
Comment -> (list)
A comment entered by a user in your organization about the document review request.
(structure)
Information about comments added to a document review request.
Type -> (string)
The type of information added to a review request. Currently, only the value
Comment
is supported.Content -> (string)
The content of a comment entered by a user who requests a review of a new document version, or who reviews the new version.
Shorthand Syntax:
Action=string,Comment=[{Type=string,Content=string},{Type=string,Content=string}]
JSON Syntax:
{
"Action": "SendForReview"|"UpdateReview"|"Approve"|"Reject",
"Comment": [
{
"Type": "Comment",
"Content": "string"
}
...
]
}
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Example: To approve the latest version of a change template
The following update-document-metadata
provides an approval for the latest version of a change template that has been submitted for review.
aws ssm update-document-metadata \
--name MyChangeManagerTemplate \
--document-reviews 'Action=Approve,Comment=[{Type=Comment,Content=Approved!}]'
This command produces no output.
For more information, see Reviewing and approving or rejecting change templates in the AWS Systems Manager User Guide.
None