paws.security.identity (version 0.1.10)

kms_untag_resource: Deletes tags from a customer managed CMK

Description

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

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

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

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

Required permissions: kms:UntagResource (key policy)

Related operations

• TagResource

• ListResourceTags

Usage

kms_untag_resource(KeyId, TagKeys)

Arguments

KeyId

[required] Identifies the CMK from which you are removing tags.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

TagKeys

[required] One or more tag keys. Specify only the tag keys, not the tag values.

Request syntax

svc$untag_resource(
  KeyId = "string",
  TagKeys = list(
    "string"
  )
)

Examples

# NOT RUN {
# The following example removes tags from a CMK.
svc$untag_resource(
  KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab",
  TagKeys = list(
    "Purpose",
    "CostCenter"
  )
)
# }
# NOT RUN {
# }