Module Smaws_Client_KMS.UntagResource

val request : Smaws_Lib.Context.t -> untag_resource_request -> (unit, [> Smaws_Lib.Protocols.AwsJson.error | `InvalidArnException of invalid_arn_exception | `KMSInternalException of kms_internal_exception | `KMSInvalidStateException of kms_invalid_state_exception | `NotFoundException of not_found_exception | `TagException of tag_exception ]) Stdlib.result

Deletes tags from a customer managed key. To delete a tag, specify the tag key and the KMS key.

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.

When it succeeds, the UntagResource operation doesn't return any output. Also, if the specified tag key isn't found on the KMS key, it doesn't throw an exception or return a response. To confirm that the operation worked, use the ListResourceTags operation.

For information about using tags in KMS, see Tagging keys. For general information about tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:UntagResource (key policy)

Related operations

  • CreateKey
  • ListResourceTags
  • ReplicateKey
  • TagResource

Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.