Try it now and let us know what you think. Switch to the new look >>
You can return to the original look by selecting English in the language selector above.
GetKeyPolicy
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.
Request Syntax
{ "KeyId": "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.
Note
In the following list, the required parameters are described first.
- KeyId
-
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: Yes
-
- PolicyName
-
Specifies the name of the key policy. The only valid name is
default. To get the names of key policies, use ListKeyPolicies.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w]+Required: Yes
Response Syntax
{ "Policy": "string" }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Policy
-
A key policy document in JSON format.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 131072.
Pattern:
[\u0009\u000A\u000D\u0020-\u00FF]+
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 CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
HTTP Status Code: 400
- NotFoundException
-
The request was rejected because the specified entity or resource could not be found.
HTTP Status Code: 400
Examples
The following examples are formatted for legibility.
Example Request
POST / HTTP/1.1 Host: kms.us-east-2.amazonaws.com Content-Length: 74 X-Amz-Target: TrentService.GetKeyPolicy X-Amz-Date: 20161114T225546Z Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256\ Credential=AKIAI44QH8DHBEXAMPLE/20161114/us-east-2/kms/aws4_request,\ SignedHeaders=content-type;host;x-amz-date;x-amz-target,\ Signature=a88e20eebfbea3bf62d1512d0d2987e2d233becc7631a442237d3661df623a40 { "PolicyName": "default", "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" }
Example Response
HTTP/1.1 200 OK Server: Server Date: Mon, 14 Nov 2016 22:55:47 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 326 Connection: keep-alive x-amzn-RequestId: 7b105e7b-aabd-11e6-8039-3123b558b719 {"Policy":"{\n \"Version\" : \"2012-10-17\",\n \"Id\" : \"key-default-1\",\n \"Statement\" : [ {\n \"Sid\" : \"Enable IAM User Permissions\",\n \"Effect\" : \"Allow\",\n \"Principal\" : {\n \"AWS\" : \"arn:aws:iam::111122223333:root\"\n },\n \"Action\" : \"kms:*\",\n \"Resource\" : \"*\"\n } ]\n }"}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
