List Key Policies
| kms_list_key_policies | R Documentation |
Gets the names of the key policies that are attached to a KMS key¶
Description¶
Gets the names of the key policies that are attached to a KMS key. 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 KMS key in a different Amazon Web Services account.
Required permissions: kms:ListKeyPolicies (key policy)
Related operations:
-
get_key_policy -
put_key_policy
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
Usage¶
kms_list_key_policies(KeyId, Limit, Marker)
Arguments¶
KeyId |
[required] Gets the names of key policies for the specified KMS key. Specify the key ID or key ARN of the KMS key. For example:
To get the key ID and key ARN for a KMS key, use
|
Limit |
Use this parameter to specify the maximum number of items to return. When this value is present, 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
|
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¶
## Not run:
# The following example lists key policies for the specified KMS key.
svc$list_key_policies(
KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab"
)
## End(Not run)