Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Interface GetKeyPolicyCommandInputProtected

The input for GetKeyPolicyCommand.

Hierarchy

Properties

Properties

KeyId: undefined | string

Gets the key policy for the specified KMS key.

Specify the key ID or key ARN of the KMS key.

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 KMS key, use ListKeys or DescribeKey.

PolicyName: undefined | string

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