paws.security.identity (version 0.1.12)

kms_get_key_policy: Gets a key policy attached to the specified customer master key (CMK)

Description

Gets a key policy attached to the specified customer master key (CMK).

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

Required permissions: kms:GetKeyPolicy (key policy)

Related operations: put_key_policy

Usage

kms_get_key_policy(KeyId, PolicyName)

Value

A list with the following syntax:

list(
  Policy = "string"
)

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.

PolicyName

[required] Specifies the name of the key policy. The only valid name is default. To get the names of key policies, use list_key_policies.

Request syntax

svc$get_key_policy(
  KeyId = "string",
  PolicyName = "string"
)

Examples

if (FALSE) {
# The following example retrieves the key policy for the specified
# customer master key (CMK).
svc$get_key_policy(
  KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab",
  PolicyName = "default"
)
}