Skip to content

/AWS1/CL_KMS=>TAGRESOURCE()

About TagResource

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

Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.

Method Signature

IMPORTING

Required arguments:

iv_keyid TYPE /AWS1/KMSKEYIDTYPE /AWS1/KMSKEYIDTYPE

Identifies a customer managed key in the account and Region.

Specify the key ID or key ARN of the KMS key.

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 KMS key, use ListKeys or DescribeKey.

it_tags TYPE /AWS1/CL_KMSTAG=>TT_TAGLIST TT_TAGLIST

One or more tags. Each tag consists of a tag key and a tag value. The tag value can be an empty (null) string.

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

lo_client->/aws1/if_kms~tagresource(
  it_tags = VALUE /aws1/cl_kmstag=>tt_taglist(
    (
      new /aws1/cl_kmstag(
        iv_tagkey = |string|
        iv_tagvalue = |string|
      )
    )
  )
  iv_keyid = |string|
).

To tag a KMS key

The following example tags a KMS key.

lo_client->/aws1/if_kms~tagresource(
  it_tags = VALUE /aws1/cl_kmstag=>tt_taglist(
    (
      new /aws1/cl_kmstag(
        iv_tagkey = |Purpose|
        iv_tagvalue = |Test|
      )
    )
  )
  iv_keyid = |1234abcd-12ab-34cd-56ef-1234567890ab|
).