Class TagResourceCommandProtected

Adds or edits tags on a customer managed 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.

Each tag consists of a tag key and a tag value, both of which are case-sensitive strings. The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value.

You can use this operation to tag a customer managed key, but you cannot tag an Amazon Web Services managed key, an Amazon Web Services owned key, a custom key store, or an alias.

You can also add tags to a KMS key while creating it (CreateKey) or replicating it (ReplicateKey).

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:TagResource (key policy)

Related operations

• CreateKey

• ListResourceTags

• ReplicateKey

• UntagResource

Example

Use a bare-bones client and the command you need to make an API call.

import { KMSClient, TagResourceCommand } from "@aws-sdk/client-kms"; // ES Modules import
// const { KMSClient, TagResourceCommand } = require("@aws-sdk/client-kms"); // CommonJS import
const client = new KMSClient(config);
const input = { // TagResourceRequest
  KeyId: "STRING_VALUE", // required
  Tags: [ // TagList // required
    { // Tag
      TagKey: "STRING_VALUE", // required
      TagValue: "STRING_VALUE", // required
    },
  ],
};
const command = new TagResourceCommand(input);
const response = await client.send(command);
// {};

Param

TagResourceCommandInput

Returns

TagResourceCommandOutput

See

• TagResourceCommandInput for command's input shape.
• TagResourceCommandOutput for command's response shape.
• config for KMSClient's config shape.

Throws

InvalidArnException (client fault)

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

Throws

KMSInternalException (server fault)

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

Throws

KMSInvalidStateException (client fault)

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

This exceptions means one of the following:

• The key state of the KMS key is not compatible with the operation.

  To find the key state, use the DescribeKey operation. For more information about which key states are compatible with each KMS operation, see Key states of KMS keys in the Key Management Service Developer Guide .

• For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.

Throws

LimitExceededException (client fault)

The request was rejected because a quota was exceeded. For more information, see Quotas in the Key Management Service Developer Guide.

Throws

NotFoundException (client fault)

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

Throws

TagException (client fault)

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

Throws

KMSServiceException

Base exception class for all service exceptions from KMS service.

Example

To tag a KMS key

// The following example tags a KMS key.
const input = {
  "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
  "Tags": [
    {
      "TagKey": "Purpose",
      "TagValue": "Test"
    }
  ]
};
const command = new TagResourceCommand(input);
await client.send(command);
// example id: to-tag-a-cmk-1483997246518