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.
A grant is a policy instrument that allows Amazon Web Services principals to use
KMS keys in cryptographic operations. It also can allow them to view a KMS key (DescribeKey) and create and manage grants. When authorizing access to a KMS key,
grants are considered along with key policies and IAM policies. Grants are often used for
temporary permissions because you can create one, use its permissions, and delete it without
changing your key policies or IAM policies.
For detailed information about grants, including grant terminology, see Grants in KMS in the
Key Management Service Developer Guide. For examples of working with grants in several
programming languages, see Programming grants.
The CreateGrant operation returns a GrantToken and a
GrantId.
When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout KMS. This state is known as eventual consistency. Once the grant has achieved eventual consistency, the grantee
principal can use the permissions in the grant without identifying the grant.
However, to use the permissions in the grant immediately, use the
GrantToken that CreateGrant returns. For details, see Using a
grant token in the Key Management Service Developer Guide.
The CreateGrant operation also returns a GrantId. You can
use the GrantId and a key identifier to identify the grant in the RetireGrant and RevokeGrant operations. To find the grant
ID, use the ListGrants or ListRetirableGrants
operations.
The KMS key that you use for this operation must be in a compatible key state. For
details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key
ARN in the value of the KeyId parameter.
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.
Base exception class for all service exceptions from KMS service.
Example
To create a grant
// The following example creates a grant that allows the specified IAM role to encrypt data with the specified KMS key. constinput = { "GranteePrincipal":"arn:aws:iam::111122223333:role/ExampleRole", "KeyId":"arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab", "Operations": [ "Encrypt", "Decrypt" ] }; constcommand = newCreateGrantCommand(input); constresponse = awaitclient.send(command); /* response == { "GrantId": "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60", "GrantToken": "AQpAM2RhZTk1MGMyNTk2ZmZmMzEyYWVhOWViN2I1MWM4Mzc0MWFiYjc0ZDE1ODkyNGFlNTIzODZhMzgyZjBlNGY3NiKIAgEBAgB4Pa6VDCWW__MSrqnre1HIN0Grt00ViSSuUjhqOC8OT3YAAADfMIHcBgkqhkiG9w0BBwaggc4wgcsCAQAwgcUGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMmqLyBTAegIn9XlK5AgEQgIGXZQjkBcl1dykDdqZBUQ6L1OfUivQy7JVYO2-ZJP7m6f1g8GzV47HX5phdtONAP7K_HQIflcgpkoCqd_fUnE114mSmiagWkbQ5sqAVV3ov-VeqgrvMe5ZFEWLMSluvBAqdjHEdMIkHMlhlj4ENZbzBfo9Wxk8b8SnwP4kc4gGivedzFXo-dwN8fxjjq_ZZ9JFOj2ijIbj5FyogDCN0drOfi8RORSEuCEmPvjFRMFAwcmwFkN2NPp89amA" } */ // example id: to-create-a-grant-1477972226782
Adds a grant to a KMS key.
A grant is a policy instrument that allows Amazon Web Services principals to use KMS keys in cryptographic operations. It also can allow them to view a KMS key (DescribeKey) and create and manage grants. When authorizing access to a KMS key, grants are considered along with key policies and IAM policies. Grants are often used for temporary permissions because you can create one, use its permissions, and delete it without changing your key policies or IAM policies.
For detailed information about grants, including grant terminology, see Grants in KMS in the Key Management Service Developer Guide . For examples of working with grants in several programming languages, see Programming grants.
The
CreateGrant
operation returns aGrantToken
and aGrantId
.When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout KMS. This state is known as eventual consistency. Once the grant has achieved eventual consistency, the grantee principal can use the permissions in the grant without identifying the grant.
However, to use the permissions in the grant immediately, use the
GrantToken
thatCreateGrant
returns. For details, see Using a grant token in the Key Management Service Developer Guide .The
CreateGrant
operation also returns aGrantId
. You can use theGrantId
and a key identifier to identify the grant in the RetireGrant and RevokeGrant operations. To find the grant ID, use the ListGrants or ListRetirableGrants operations.The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the
KeyId
parameter.Required permissions: kms:CreateGrant (key policy)
Related operations:
ListGrants
ListRetirableGrants
RetireGrant
RevokeGrant
Example
Use a bare-bones client and the command you need to make an API call.
Param
CreateGrantCommandInput
Returns
CreateGrantCommandOutput
See
input
shape.response
shape.config
shape.Throws
DependencyTimeoutException (server fault)
The system timed out while trying to fulfill the request. You can retry the request.
Throws
DisabledException (client fault)
The request was rejected because the specified KMS key is not enabled.
Throws
InvalidArnException (client fault)
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
Throws
InvalidGrantTokenException (client fault)
The request was rejected because the specified grant token is not valid.
Throws
KMSInternalException (server fault)
The request was rejected because an internal exception occurred. The request can be retried.
Throws
KMSInvalidStateException (client fault)
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.
Throws
LimitExceededException (client fault)
The request was rejected because a quota was exceeded. For more information, see Quotas in the Key Management Service Developer Guide.
Throws
NotFoundException (client fault)
The request was rejected because the specified entity or resource could not be found.
Throws
KMSServiceException
Base exception class for all service exceptions from KMS service.
Example
To create a grant