kms_list_resource_tags: Returns a list of all tags for the specified customer master...

Description Usage Arguments Details Request syntax Examples

View source: R/kms_operations.R

Description

Returns a list of all tags for the specified customer master key (CMK).

Usage

1
kms_list_resource_tags(KeyId, Limit, Marker)

Arguments

KeyId

[required] A unique identifier for the customer master key (CMK).

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.

Limit

Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 50, inclusive. If you do not include a value, it defaults to 50.

Marker

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

Do not attempt to construct this value. Use only the value of NextMarker from the truncated response you just received.

Details

You cannot perform this operation on a CMK in a different AWS account.

Request syntax

1
2
3
4
5
svc$list_resource_tags(
  KeyId = "string",
  Limit = 123,
  Marker = "string"
)

Examples

1
2
3
4
# The following example lists tags for a CMK.
svc$list_resource_tags(
  KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab"
)

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