Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

update_document_metadata

update_document_metadata(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.update_document_metadata(
    Name='string',
    DocumentVersion='string',
    DocumentReviews={
        'Action': 'SendForReview'|'UpdateReview'|'Approve'|'Reject',
        'Comment': [
            {
                'Type': 'Comment',
                'Content': 'string'
            },
        ]
    }
)
Parameters
  • Name (string) --

    [REQUIRED]

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

  • DocumentVersion (string) -- The version of a change template in which to update approval metadata.
  • DocumentReviews (dict) --

    [REQUIRED]

    The change template review details to update.

    • Action (string) -- [REQUIRED]

      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.

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

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • SSM.Client.exceptions.InternalServerError
  • SSM.Client.exceptions.InvalidDocument
  • SSM.Client.exceptions.InvalidDocumentOperation
  • SSM.Client.exceptions.InvalidDocumentVersion