PutKeyPolicy
Attaches a key policy to the specified KMS key.
For more information about key policies, see Key Policies in the Amazon Key Management Service Developer Guide. For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Amazon Identity and Access Management User Guide . For examples of adding a key policy in multiple programming languages, see Setting a key policy in the Amazon 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
Request Syntax
{
"BypassPolicyLockoutSafetyCheck": boolean
,
"KeyId": "string
",
"Policy": "string
",
"PolicyName": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
In the following list, the required parameters are described first.
- KeyId
-
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: Yes
-
- Policy
-
The key policy to attach to the KMS key.
The key policy must meet the following criteria:
-
If you don't set
BypassPolicyLockoutSafetyCheck
to true, the key policy must allow the principal that is making thePutKeyPolicy
request to make a subsequentPutKeyPolicy
request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the Amazon Key Management Service Developer Guide. -
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to Amazon KMS. When you create a new Amazon principal (for example, an IAM user or role), 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 Amazon KMS. For more information, see Changes that I make are not always immediately visible in the Amazon 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 Amazon KMS in the Amazon Key Management Service Developer Guide. For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Amazon Identity and Access Management User Guide .
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32768.
Pattern:
[\u0009\u000A\u000D\u0020-\u00FF]+
Required: Yes
-
- PolicyName
-
The name of the key policy. The only valid value is
default
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w]+
Required: Yes
- BypassPolicyLockoutSafetyCheck
-
A flag to indicate whether to bypass the key policy lockout safety check.
Important 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, refer to the scenario in the Default Key Policy section in the Amazon 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.The default value is false.
Type: Boolean
Required: No
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- DependencyTimeoutException
-
The system timed out while trying to fulfill the request. The request can be retried.
HTTP Status Code: 500
- InvalidArnException
-
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
HTTP Status Code: 400
- KMSInternalException
-
The request was rejected because an internal exception occurred. The request can be retried.
HTTP Status Code: 500
- KMSInvalidStateException
-
The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a KMS key, see Key states of Amazon KMS keys in the Amazon Key Management Service Developer Guide .
HTTP Status Code: 400
- LimitExceededException
-
The request was rejected because a quota was exceeded. For more information, see Quotas in the Amazon Key Management Service Developer Guide.
HTTP Status Code: 400
- MalformedPolicyDocumentException
-
The request was rejected because the specified policy is not syntactically or semantically correct.
HTTP Status Code: 400
- NotFoundException
-
The request was rejected because the specified entity or resource could not be found.
HTTP Status Code: 400
- UnsupportedOperationException
-
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
HTTP Status Code: 400
Examples
Example Request
The following example is formatted for legibility.
POST / HTTP/1.1 Host: kms.us-east-2.amazonaws.com Content-Length: 2396 X-Amz-Target: TrentService.PutKeyPolicy X-Amz-Date: 20161207T203023Z Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256\ Credential=AKIAI44QH8DHBEXAMPLE/20161207/us-east-2/kms/aws4_request,\ SignedHeaders=content-type;host;x-amz-date;x-amz-target,\ Signature=e58ea91db06afc1bc7a1f204769cf6bc4d003ee090095a13caef361c69739ede { "Policy": "{ \"Version\": \"2012-10-17\", \"Id\": \"custom-policy-2016-12-07\", \"Statement\": [ { \"Sid\": \"Enable IAM User Permissions\", \"Effect\": \"Allow\", \"Principal\": { \"AWS\": \"arn:aws:iam::111122223333:root\" }, \"Action\": \"kms:*\", \"Resource\": \"*\" }, { \"Sid\": \"Allow access for Key Administrators\", \"Effect\": \"Allow\", \"Principal\": { \"AWS\": [ \"arn:aws:iam::111122223333:user/ExampleAdminUser\", \"arn:aws:iam::111122223333:role/ExampleAdminRole\" ] }, \"Action\": [ \"kms:Create*\", \"kms:Describe*\", \"kms:Enable*\", \"kms:List*\", \"kms:Put*\", \"kms:Update*\", \"kms:Revoke*\", \"kms:Disable*\", \"kms:Get*\", \"kms:Delete*\", \"kms:ScheduleKeyDeletion\", \"kms:CancelKeyDeletion\" ], \"Resource\": \"*\" }, { \"Sid\": \"Allow use of the key\", \"Effect\": \"Allow\", \"Principal\": { \"AWS\": \"arn:aws:iam::111122223333:role/ExamplePowerUserRole\" }, \"Action\": [ \"kms:Encrypt\", \"kms:Decrypt\", \"kms:ReEncrypt*\", \"kms:GenerateDataKey*\", \"kms:DescribeKey\" ], \"Resource\": \"*\" }, { \"Sid\": \"Allow attachment of persistent resources\", \"Effect\": \"Allow\", \"Principal\": { \"AWS\": \"arn:aws:iam::111122223333:role/ExamplePowerUserRole\" }, \"Action\": [ \"kms:CreateGrant\", \"kms:ListGrants\", \"kms:RevokeGrant\" ], \"Resource\": \"*\", \"Condition\": { \"Bool\": { \"kms:GrantIsForAWSResource\": \"true\" } } } ] }", "PolicyName": "default", "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" }
Example Response
This example illustrates one usage of PutKeyPolicy.
HTTP/1.1 200 OK Server: Server Date: Wed, 07 Dec 2016 20:30:23 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 0 Connection: keep-alive x-amzn-RequestId: fb114d4c-bcbb-11e6-82b3-e9e4af764a06
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: