Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ssm ]

list-document-metadata-history

Description

Information about approval reviews for a version of a change template in Change Manager.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-document-metadata-history
--name <value>
[--document-version <value>]
--metadata <value>
[--next-token <value>]
[--max-results <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the change template.

--document-version (string)

The version of the change template.

--metadata (string)

The type of data for which details are being requested. Currently, the only supported value is DocumentReviews .

Possible values:

  • DocumentReviews

--next-token (string)

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

--max-results (integer)

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.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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.

Examples

Example: To view approval history and status for a change template

The following list-document-metadata-history example returns the approval history for the specified Change Manager change template.

aws ssm list-document-metadata-history \
    --name MyChangeManageTemplate \
    --metadata DocumentReviews

Output:

{
    "Name": "MyChangeManagerTemplate",
    "DocumentVersion": "1",
    "Author": "arn:aws:iam::111222333444;:user/JohnDoe",
    "Metadata": {
        "ReviewerResponse": [
            {
                "CreateTime": "2021-07-30T11:58:28.025000-07:00",
                "UpdatedTime": "2021-07-30T12:01:19.274000-07:00",
                "ReviewStatus": "APPROVED",
                "Comment": [
                    {
                        "Type": "COMMENT",
                        "Content": "I approve this template version"
                    }
                ],
                "Reviewer": "arn:aws:iam::111222333444;:user/ShirleyRodriguez"
            },
            {
                "CreateTime": "2021-07-30T11:58:28.025000-07:00",
                "UpdatedTime": "2021-07-30T11:58:28.025000-07:00",
                "ReviewStatus": "PENDING"
            }
        ]
    }
}

For more information, see Reviewing and approving or rejecting change templates in the AWS Systems Manager User Guide.

Output

Name -> (string)

The name of the change template.

DocumentVersion -> (string)

The version of the change template.

Author -> (string)

The user ID of the person in the organization who requested the review of the change template.

Metadata -> (structure)

Information about the response to the change template approval request.

ReviewerResponse -> (list)

Details about a reviewer's response to a document review request.

(structure)

Information about a reviewer's response to a document review request.

CreateTime -> (timestamp)

The date and time that a reviewer entered a response to a document review request.

UpdatedTime -> (timestamp)

The date and time that a reviewer last updated a response to a document review request.

ReviewStatus -> (string)

The current review status of a new custom SSM document created by a member of your organization, or of the latest version of an existing SSM document.

Only one version of a document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.

Only one version of a document can be in review, or PENDING, at a time.

Comment -> (list)

The comment entered by a reviewer as part of their document review response.

(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.

Reviewer -> (string)

The user in your organization assigned to review a document request.

NextToken -> (string)

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.