kms_untag_resource: Removes the specified tags from the specified customer master...

Description Usage Arguments Details Request syntax Examples

View source: R/kms_operations.R

Description

Removes the specified tags from the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.

Usage

1
kms_untag_resource(KeyId, TagKeys)

Arguments

KeyId

[required] A unique identifier for 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.

Details

To remove a tag, specify the tag key. To change the tag value of an existing tag key, use TagResource.

The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Request syntax

1
2
3
4
5
6
svc$untag_resource(
  KeyId = "string",
  TagKeys = list(
    "string"
  )
)

Examples

1
2
3
4
5
6
7
8
# The following example removes tags from a CMK.
svc$untag_resource(
  KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab",
  TagKeys = list(
    "Purpose",
    "CostCenter"
  )
)

paws.security.identity documentation built on Oct. 30, 2019, 11:26 a.m.