Skip to content

update_ops_metadata

update_ops_metadata(
    ops_metadata_arn: OpsMetadataArn,
    *,
    config_overrides: Optional[SSMClientConfig] = None,
    metadata_to_update: Optional[MetadataMap] = None,
    keys_to_delete: Optional[MetadataKeysToDeleteList] = None,
) -> UpdateOpsMetadataResult

Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.

Parameters:

  • ops_metadata_arn (OpsMetadataArn) –

    The Amazon Resource Name (ARN) of the OpsMetadata Object to update.

  • metadata_to_update (Optional[MetadataMap], default: None ) –

    Metadata to add to an OpsMetadata object.

  • keys_to_delete (Optional[MetadataKeysToDeleteList], default: None ) –

    The metadata keys to delete from the OpsMetadata object.

Raises:

Source code in docs_src/capo_ssm/_services/ssm.py
def update_ops_metadata(
    self,
    ops_metadata_arn: "capo_ssm.types.ops_metadata_arn.OpsMetadataArn",
    *,
    config_overrides: Optional[SSMClientConfig] = None,
    metadata_to_update: Optional["capo_ssm.types.metadata_map.MetadataMap"] = None,
    keys_to_delete: Optional[
        "capo_ssm.types.metadata_keys_to_delete_list.MetadataKeysToDeleteList"
    ] = None,
) -> "capo_ssm.types.update_ops_metadata_result.UpdateOpsMetadataResult":
    """<p>Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.</p>

    Args:
        ops_metadata_arn: <p>The Amazon Resource Name (ARN) of the OpsMetadata Object to update.</p>
        metadata_to_update: <p>Metadata to add to an OpsMetadata object.</p>
        keys_to_delete: <p>The metadata keys to delete from the OpsMetadata object. </p>

    Raises:
        capo_ssm.errors.internal_server_error.InternalServerError: <p>An error occurred on the server side.</p>
        capo_ssm.errors.ops_metadata_invalid_argument_exception.OpsMetadataInvalidArgumentException: <p>One of the arguments passed is invalid. </p>
        capo_ssm.errors.ops_metadata_key_limit_exceeded_exception.OpsMetadataKeyLimitExceededException: <p>The OpsMetadata object exceeds the maximum number of OpsMetadata keys that you can assign to an application in Application Manager.</p>
        capo_ssm.errors.ops_metadata_not_found_exception.OpsMetadataNotFoundException: <p>The OpsMetadata object doesn't exist. </p>
        capo_ssm.errors.ops_metadata_too_many_updates_exception.OpsMetadataTooManyUpdatesException: <p>The system is processing too many concurrent updates. Wait a few moments and try again.</p>
        capo_ssm.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ssm.types.update_ops_metadata_request.UpdateOpsMetadataRequest]",
    ) -> OperationResponse[
        "capo_ssm.types.update_ops_metadata_result.UpdateOpsMetadataResult"
    ]:
        import capo_ssm._operations.amazon_ssm.update_ops_metadata

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateOpsMetadata")
    )
    input_: capo_ssm.types.update_ops_metadata_request.UpdateOpsMetadataRequest = {
        "ops_metadata_arn": ops_metadata_arn
    }
    if metadata_to_update is not None:
        input_["metadata_to_update"] = metadata_to_update
    if keys_to_delete is not None:
        input_["keys_to_delete"] = keys_to_delete

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