SSM / Client / list_document_metadata_history

list_document_metadata_history

SSM.Client.list_document_metadata_history(**kwargs)

Warning

Amazon Web Services Systems Manager Change Manager will no longer be open to new customers starting November 7, 2025. If you would like to use Change Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services Systems Manager Change Manager availability change.

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

See also: AWS API Documentation

Request Syntax

response = client.list_document_metadata_history(
    Name='string',
    DocumentVersion='string',
    Metadata='DocumentReviews',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • Name (string) –

    [REQUIRED]

    The name of the change template.

  • DocumentVersion (string) – The version of the change template.

  • Metadata (string) –

    [REQUIRED]

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

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

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

Return type:

dict

Returns:

Response Syntax

{
    'Name': 'string',
    'DocumentVersion': 'string',
    'Author': 'string',
    'Metadata': {
        'ReviewerResponse': [
            {
                'CreateTime': datetime(2015, 1, 1),
                'UpdatedTime': datetime(2015, 1, 1),
                'ReviewStatus': 'APPROVED'|'NOT_REVIEWED'|'PENDING'|'REJECTED',
                'Comment': [
                    {
                        'Type': 'Comment',
                        'Content': 'string'
                    },
                ],
                'Reviewer': 'string'
            },
        ]
    },
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • 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 (dict) –

      Information about the response to the change template approval request.

      • ReviewerResponse (list) –

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

        • (dict) –

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

          • CreateTime (datetime) –

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

          • UpdatedTime (datetime) –

            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.

            • (dict) –

              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.

Exceptions