UntagResource - AWS Key Management Service


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


Tagging or untagging a CMK can allow or deny permission to the CMK. For details, see Using ABAC in AWS KMS in the AWS 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 CMK, 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 AWS KMS, see Tagging keys. For general information about tags, including the format and syntax, see Tagging AWS resources in the Amazon Web Services General Reference.

The CMK that you use for this operation must be in a compatible key state. For details, see Key state: Effect on your CMK 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

Request Syntax

{ "KeyId": "string", "TagKeys": [ "string" ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


In the following list, the required parameters are described first.


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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: Yes


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

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.


For information about the errors that are common to all actions, see Common Errors.


The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.

HTTP Status Code: 400


The request was rejected because an internal exception occurred. The request can be retried.

HTTP Status Code: 500


The request was rejected because the state of the specified resource is not valid for this request.

For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .

HTTP Status Code: 400


The request was rejected because the specified entity or resource could not be found.

HTTP Status Code: 400


The request was rejected because one or more tags are not valid.

HTTP Status Code: 400


Example Request

The following example is formatted for legibility.

POST / HTTP/1.1 Host: kms.us-east-2.amazonaws.com Content-Length: 87 X-Amz-Target: TrentService.UntagResource X-Amz-Date: 20170109T200704Z Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256\ Credential=AKIAI44QH8DHBEXAMPLE/20170109/us-east-2/kms/aws4_request,\ SignedHeaders=content-type;host;x-amz-date;x-amz-target,\ Signature=f1c9c01e545fa02e2dba096b66d5f697800a1b8e06a1776058206dc393b8d1b4 { "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", "TagKeys": [ "Purpose", "CostCenter" ] }

Example Response

This example illustrates one usage of UntagResource.

HTTP/1.1 200 OK Server: Server Date: Mon, 09 Jan 2017 20:07:04 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 0 Connection: keep-alive x-amzn-RequestId: 30b417a1-d6a7-11e6-a164-b5365990e84e

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: