kms_get_key_policy: Gets a key policy attached to the specified customer master...

Description Usage Arguments Request syntax Examples

View source: R/kms_operations.R

Description

Gets a key policy attached to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.

Usage

1
kms_get_key_policy(KeyId, PolicyName)

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.

PolicyName

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

Request syntax

1
2
3
4
svc$get_key_policy(
  KeyId = "string",
  PolicyName = "string"
)

Examples

1
2
3
4
5
6
# 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"
)

paws.security.identity documentation built on Jan. 14, 2020, 5:08 p.m.