PutKeyPolicyCommand

Attaches a key policy to the specified KMS key.

For more information about key policies, see Key Policies  in the Key Management Service Developer Guide. For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference  in the Identity and Access Management User Guide . For examples of adding a key policy in multiple programming languages, see Setting a key policy  in the Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:PutKeyPolicy  (key policy)

Related operations: GetKeyPolicy

Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency .

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { KMSClient, PutKeyPolicyCommand } from "@aws-sdk/client-kms"; // ES Modules import
// const { KMSClient, PutKeyPolicyCommand } = require("@aws-sdk/client-kms"); // CommonJS import
const client = new KMSClient(config);
const input = { // PutKeyPolicyRequest
  KeyId: "STRING_VALUE", // required
  PolicyName: "STRING_VALUE",
  Policy: "STRING_VALUE", // required
  BypassPolicyLockoutSafetyCheck: true || false,
};
const command = new PutKeyPolicyCommand(input);
const response = await client.send(command);
// {};

Example Usage

 Loading code editor

PutKeyPolicyCommand Input

See PutKeyPolicyCommandInput for more details

Parameter
Type
Description
KeyId
Required
string | undefined

Sets the key policy on 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.

Policy
Required
string | undefined

The key policy to attach to the KMS key.

The key policy must meet the following criteria:

  • The key policy must allow the calling principal to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy  in the Key Management Service Developer Guide. (To omit this condition, set BypassPolicyLockoutSafetyCheck to true.)

  • Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal, you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible  in the Amazon Web Services Identity and Access Management User Guide.

A key policy document can include only the following characters:

  • Printable ASCII characters from the space character (u0020) through the end of the ASCII character range.

  • Printable characters in the Basic Latin and Latin-1 Supplement character set (through u00FF).

  • The tab (u0009), line feed (u000A), and carriage return (u000D) special characters

For information about key policies, see Key policies in KMS  in the Key Management Service Developer Guide.For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference  in the Identity and Access Management User Guide .

BypassPolicyLockoutSafetyCheck
boolean | undefined

Skips ("bypasses") the key policy lockout safety check. The default value is false.

Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.

For more information, see Default key policy  in the Key Management Service Developer Guide.

Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy  request on the KMS key.

PolicyName
string | undefined

The name of the key policy. If no policy name is specified, the default value is default. The only valid value is default.

PutKeyPolicyCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
DependencyTimeoutException
server

The system timed out while trying to fulfill the request. You can retry the request.

InvalidArnException
client

The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.

KMSInternalException
server

The request was rejected because an internal exception occurred. The request can be retried.

KMSInvalidStateException
client

The request was rejected because the state of the specified resource is not valid for this request.

This exceptions means one of the following:

  • The key state of the KMS key is not compatible with the operation.

    To find the key state, use the DescribeKey operation. For more information about which key states are compatible with each KMS operation, see Key states of KMS keys  in the Key Management Service Developer Guide .

  • For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.

LimitExceededException
client

The request was rejected because a quota was exceeded. For more information, see Quotas  in the Key Management Service Developer Guide.

MalformedPolicyDocumentException
client

The request was rejected because the specified policy is not syntactically or semantically correct.

NotFoundException
client

The request was rejected because the specified entity or resource could not be found.

UnsupportedOperationException
client

The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

KMSServiceException
Base exception class for all service exceptions from KMS service.