kms_list_key_policies: Gets the names of the key policies that are attached to a customer master key (CMK)

Description

Gets the names of the key policies that are attached to a customer master key (CMK). This operation is designed to get policy names that you can use in a get_key_policy operation. However, the only valid policy name is default.

Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

Required permissions: kms:ListKeyPolicies (key policy)

Related operations:

get_key_policy
put_key_policy

Usage

kms_list_key_policies(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 list_keys or describe_key.

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 1000, inclusive. If you do not include a value, it defaults to 100.

Only one policy can be attached to a key.

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.

Value

A list with the following syntax:

list(
  PolicyNames = list(
    "string"
  ),
  NextMarker = "string",
  Truncated = TRUE|FALSE
)

Request syntax

svc$list_key_policies(
  KeyId = "string",
  Limit = 123,
  Marker = "string"
)

Examples

Run this code

# NOT RUN {
# The following example lists key policies for the specified CMK.
svc$list_key_policies(
  KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab"
)
# }
# NOT RUN {
# }