update_document_metadata ¶

def update_document_metadata(
    self,
    name: "capo_ssm.types.document_name.DocumentName",
    document_reviews: "capo_ssm.types.document_reviews.DocumentReviews",
    *,
    config_overrides: Optional[SSMClientConfig] = None,
    document_version: Optional[
        "capo_ssm.types.document_version.DocumentVersion"
    ] = None,
) -> "capo_ssm.types.update_document_metadata_response.UpdateDocumentMetadataResponse":
    """<important> <p>Amazon Web Services Systems Manager Change Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/change-manager-availability-change.html">Amazon Web Services Systems Manager Change Manager availability change</a>.</p> </important> <p>Updates information related to approval reviews for a specific version of a change template in Change Manager.</p>

    Args:
        name: <p>The name of the change template for which a version's metadata is to be updated.</p>
        document_version: <p>The version of a change template in which to update approval metadata.</p>
        document_reviews: <p>The change template review details to update.</p>

    Raises:
        capo_ssm.errors.internal_server_error.InternalServerError: <p>An error occurred on the server side.</p>
        capo_ssm.errors.invalid_document.InvalidDocument: <p>The specified SSM document doesn't exist.</p>
        capo_ssm.errors.invalid_document_operation.InvalidDocumentOperation: <p>You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.</p>
        capo_ssm.errors.invalid_document_version.InvalidDocumentVersion: <p>The document version isn't valid or doesn't exist.</p>
        capo_ssm.errors.too_many_updates.TooManyUpdates: <p>There are concurrent updates for a resource that supports one update at a time.</p>
        capo_ssm.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ssm.types.update_document_metadata_request.UpdateDocumentMetadataRequest]",
    ) -> OperationResponse[
        "capo_ssm.types.update_document_metadata_response.UpdateDocumentMetadataResponse"
    ]:
        import capo_ssm._operations.amazon_ssm.update_document_metadata

        output, http_response = (
            capo_ssm._operations.amazon_ssm.update_document_metadata.update_document_metadata(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateDocumentMetadata")
    )
    input_: capo_ssm.types.update_document_metadata_request.UpdateDocumentMetadataRequest = {
        "name": name,
        "document_reviews": document_reviews,
    }
    if document_version is not None:
        input_["document_version"] = document_version

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output