[ aws . kms ]

untag-resource

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  untag-resource
--key-id <value>
--tag-keys <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--key-id (string)

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 .

--tag-keys (list)

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

(string)

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To delete a tag from an AWS KMS CMK

The following untag-resource example deletes the tag with the "Purpose" key from a customer managed CMK.

To specify the CMK, use the key-id parameter. This example uses a key ID value, but you can use a key ID or key ARN in this command. Before running this command, replace the example key ID with a valid key ID from your AWS account.

aws kms untag-resource \
    --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \
    --tag-key 'Purpose'

This command produces no output. To view the tags on an AWS KMS CMK, use the list-resource-tags command.

For more information about using tags in AWS KMS, see Tagging Keys in the AWS Key Management Service Developer Guide.

Output

None