public interface AWSKMS
AWS Key Management Service (AWS KMS) is an encryption and key management web service. This guide describes the AWS KMS operations that you can call programmatically. For general information about AWS KMS, see the AWS Key Management Service Developer Guide.
AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS KMS and other AWS services. For example, the SDKs take care of tasks such as signing requests (see below), managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.
We recommend that you use the AWS SDKs to make programmatic API calls to AWS KMS.
Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes.
Signing Requests
Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account (root) access key ID and secret key for everyday work with AWS KMS. Instead, use the access key ID and secret access key for an IAM user, or you can use the AWS Security Token Service to generate temporary security credentials that you can use to sign requests.
All AWS KMS operations require Signature Version 4.
Logging API Requests
AWS KMS supports AWS CloudTrail, a service that logs AWS API calls and related events for your AWS account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to AWS KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.
Additional Resources
For more information about credentials and request signing, see the following:
AWS Security Credentials - This topic provides general information about the types of credentials used for accessing AWS.
Temporary Security Credentials - This section of the IAM User Guide describes how to create and use temporary security credentials.
Signature Version 4 Signing Process - This set of topics walks you through the process of signing a request using an access key ID and a secret access key.
Commonly Used APIs
Of the APIs discussed in this guide, the following will prove the most useful for most applications. You will likely perform actions other than these, such as creating keys and assigning policies, by using the console.
Modifier and Type | Method and Description |
---|---|
CancelKeyDeletionResult |
cancelKeyDeletion(CancelKeyDeletionRequest cancelKeyDeletionRequest)
Cancels the deletion of a customer master key (CMK).
|
void |
createAlias(CreateAliasRequest createAliasRequest)
Creates a display name for a customer master key.
|
CreateGrantResult |
createGrant(CreateGrantRequest createGrantRequest)
Adds a grant to a key to specify who can use the key and under what
conditions.
|
CreateKeyResult |
createKey()
Creates a customer master key (CMK).
|
CreateKeyResult |
createKey(CreateKeyRequest createKeyRequest)
Creates a customer master key (CMK).
|
DecryptResult |
decrypt(DecryptRequest decryptRequest)
Decrypts ciphertext.
|
void |
deleteAlias(DeleteAliasRequest deleteAliasRequest)
Deletes the specified alias.
|
void |
deleteImportedKeyMaterial(DeleteImportedKeyMaterialRequest deleteImportedKeyMaterialRequest)
Deletes key material that you previously imported and makes the specified
customer master key (CMK) unusable.
|
DescribeKeyResult |
describeKey(DescribeKeyRequest describeKeyRequest)
Provides detailed information about the specified customer master key.
|
void |
disableKey(DisableKeyRequest disableKeyRequest)
Sets the state of a customer master key (CMK) to disabled, thereby
preventing its use for cryptographic operations.
|
void |
disableKeyRotation(DisableKeyRotationRequest disableKeyRotationRequest)
Disables rotation of the specified key.
|
void |
enableKey(EnableKeyRequest enableKeyRequest)
Marks a key as enabled, thereby permitting its use.
|
void |
enableKeyRotation(EnableKeyRotationRequest enableKeyRotationRequest)
Enables rotation of the specified customer master key.
|
EncryptResult |
encrypt(EncryptRequest encryptRequest)
Encrypts plaintext into ciphertext by using a customer master key.
|
GenerateDataKeyResult |
generateDataKey(GenerateDataKeyRequest generateDataKeyRequest)
Returns a data encryption key that you can use in your application to
encrypt data locally.
|
GenerateDataKeyWithoutPlaintextResult |
generateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest generateDataKeyWithoutPlaintextRequest)
Returns a data encryption key encrypted under a customer master key
(CMK).
|
GenerateRandomResult |
generateRandom()
Generates an unpredictable byte string.
|
GenerateRandomResult |
generateRandom(GenerateRandomRequest generateRandomRequest)
Generates an unpredictable byte string.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request,
typically used for debugging issues where a service isn't acting as
expected.
|
GetKeyPolicyResult |
getKeyPolicy(GetKeyPolicyRequest getKeyPolicyRequest)
Retrieves a policy attached to the specified key.
|
GetKeyRotationStatusResult |
getKeyRotationStatus(GetKeyRotationStatusRequest getKeyRotationStatusRequest)
Retrieves a Boolean value that indicates whether key rotation is enabled
for the specified key.
|
GetParametersForImportResult |
getParametersForImport(GetParametersForImportRequest getParametersForImportRequest)
Returns the items you need in order to import key material into AWS KMS
from your existing key management infrastructure.
|
ImportKeyMaterialResult |
importKeyMaterial(ImportKeyMaterialRequest importKeyMaterialRequest)
Imports key material into an AWS KMS customer master key (CMK) from your
existing key management infrastructure.
|
ListAliasesResult |
listAliases()
Lists all of the key aliases in the account.
|
ListAliasesResult |
listAliases(ListAliasesRequest listAliasesRequest)
Lists all of the key aliases in the account.
|
ListGrantsResult |
listGrants(ListGrantsRequest listGrantsRequest)
List the grants for a specified key.
|
ListKeyPoliciesResult |
listKeyPolicies(ListKeyPoliciesRequest listKeyPoliciesRequest)
Retrieves a list of policies attached to a key.
|
ListKeysResult |
listKeys()
Lists the customer master keys.
|
ListKeysResult |
listKeys(ListKeysRequest listKeysRequest)
Lists the customer master keys.
|
ListRetirableGrantsResult |
listRetirableGrants(ListRetirableGrantsRequest listRetirableGrantsRequest)
Returns a list of all grants for which the grant's
RetiringPrincipal matches the one specified. |
void |
putKeyPolicy(PutKeyPolicyRequest putKeyPolicyRequest)
Attaches a key policy to the specified customer master key (CMK).
|
ReEncryptResult |
reEncrypt(ReEncryptRequest reEncryptRequest)
Encrypts data on the server side with a new customer master key (CMK)
without exposing the plaintext of the data on the client side.
|
void |
retireGrant()
Retires a grant.
|
void |
retireGrant(RetireGrantRequest retireGrantRequest)
Retires a grant.
|
void |
revokeGrant(RevokeGrantRequest revokeGrantRequest)
Revokes a grant.
|
ScheduleKeyDeletionResult |
scheduleKeyDeletion(ScheduleKeyDeletionRequest scheduleKeyDeletionRequest)
Schedules the deletion of a customer master key (CMK).
|
void |
setEndpoint(java.lang.String endpoint)
Overrides the default endpoint for this client
("https://kms.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
setEndpoint(String) , sets the regional
endpoint for this client's service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
void |
updateAlias(UpdateAliasRequest updateAliasRequest)
Updates an alias to map it to a different key.
|
void |
updateKeyDescription(UpdateKeyDescriptionRequest updateKeyDescriptionRequest)
Updates the description of a customer master key (CMK).
|
void setEndpoint(java.lang.String endpoint) throws java.lang.IllegalArgumentException
Callers can pass in just the endpoint (ex: "kms.us-east-1.amazonaws.com")
or a full URL, including the protocol (ex:
"https://kms.us-east-1.amazonaws.com"). If the protocol is not specified
here, the default protocol from this client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint
- The endpoint (ex: "kms.us-east-1.amazonaws.com") or a
full URL, including the protocol (ex:
"https://kms.us-east-1.amazonaws.com") of the region specific
AWS endpoint this client will communicate with.java.lang.IllegalArgumentException
- If any problems are detected with the
specified endpoint.void setRegion(Region region) throws java.lang.IllegalArgumentException
setEndpoint(String)
, sets the regional
endpoint for this client's service calls. Callers can use this method to
control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol.
To use http instead, specify it in the ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region
- The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions)
for
accessing a given region.java.lang.IllegalArgumentException
- If the given region is null,
or if this service isn't available in the given region. See
Region.isServiceSupported(String)
Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class,
com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
CancelKeyDeletionResult cancelKeyDeletion(CancelKeyDeletionRequest cancelKeyDeletionRequest) throws AmazonClientException, AmazonServiceException
Cancels the deletion of a customer master key (CMK). When this operation
is successful, the CMK is set to the Disabled
state. To
enable a CMK, use EnableKey.
For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
cancelKeyDeletionRequest
- NotFoundException
InvalidArnException
DependencyTimeoutException
KMSInternalException
KMSInvalidStateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.void createAlias(CreateAliasRequest createAliasRequest) throws AmazonClientException, AmazonServiceException
Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).
The alias and the key it is mapped to must be in the same AWS account and the same region.
To map an alias to a different key, call UpdateAlias.
createAliasRequest
- DependencyTimeoutException
AlreadyExistsException
NotFoundException
InvalidAliasNameException
KMSInternalException
LimitExceededException
KMSInvalidStateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.CreateGrantResult createGrant(CreateGrantRequest createGrantRequest) throws AmazonClientException, AmazonServiceException
Adds a grant to a key to specify who can use the key and under what conditions. Grants are alternate permission mechanisms to key policies.
For more information about grants, see Grants in the AWS Key Management Service Developer Guide.
createGrantRequest
- NotFoundException
DisabledException
DependencyTimeoutException
InvalidArnException
KMSInternalException
InvalidGrantTokenException
LimitExceededException
KMSInvalidStateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.CreateKeyResult createKey(CreateKeyRequest createKeyRequest) throws AmazonClientException, AmazonServiceException
Creates a customer master key (CMK).
You can use a CMK to encrypt small amounts of data (4 KiB or less) directly, but CMKs are more commonly used to encrypt data encryption keys (DEKs), which are used to encrypt raw data. For more information about DEKs and the difference between CMKs and DEKs, see the following:
The GenerateDataKey operation
AWS Key Management Service Concepts in the AWS Key Management Service Developer Guide
createKeyRequest
- MalformedPolicyDocumentException
DependencyTimeoutException
InvalidArnException
UnsupportedOperationException
KMSInternalException
LimitExceededException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.DecryptResult decrypt(DecryptRequest decryptRequest) throws AmazonClientException, AmazonServiceException
Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following functions:
Note that if a caller has been granted access permissions to all keys
(through, for example, IAM user policies that grant Decrypt
permission on all resources), then ciphertext encrypted by using keys in
other accounts where the key grants access to the caller can be
decrypted. To remedy this, we recommend that you do not grant
Decrypt
access in an IAM user policy. Instead grant
Decrypt
access only in key policies. If you must grant
Decrypt
access in an IAM user policy, you should scope the
resource to specific keys or to specific trusted accounts.
decryptRequest
- NotFoundException
DisabledException
InvalidCiphertextException
KeyUnavailableException
DependencyTimeoutException
InvalidGrantTokenException
KMSInternalException
KMSInvalidStateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.void deleteAlias(DeleteAliasRequest deleteAliasRequest) throws AmazonClientException, AmazonServiceException
Deletes the specified alias. To map an alias to a different key, call UpdateAlias.
deleteAliasRequest
- DependencyTimeoutException
NotFoundException
KMSInternalException
KMSInvalidStateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.void deleteImportedKeyMaterial(DeleteImportedKeyMaterialRequest deleteImportedKeyMaterialRequest) throws AmazonClientException, AmazonServiceException
Deletes key material that you previously imported and makes the specified customer master key (CMK) unusable. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.
When the specified CMK is in the PendingDeletion
state, this
operation does not change the CMK's state. Otherwise, it changes the
CMK's state to PendingImport
.
After you delete key material, you can use ImportKeyMaterial to reimport the same key material into the CMK.
deleteImportedKeyMaterialRequest
- InvalidArnException
UnsupportedOperationException
DependencyTimeoutException
NotFoundException
KMSInternalException
KMSInvalidStateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.DescribeKeyResult describeKey(DescribeKeyRequest describeKeyRequest) throws AmazonClientException, AmazonServiceException
Provides detailed information about the specified customer master key.
describeKeyRequest
- NotFoundException
InvalidArnException
DependencyTimeoutException
KMSInternalException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.void disableKey(DisableKeyRequest disableKeyRequest) throws AmazonClientException, AmazonServiceException
Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
disableKeyRequest
- NotFoundException
InvalidArnException
DependencyTimeoutException
KMSInternalException
KMSInvalidStateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.void disableKeyRotation(DisableKeyRotationRequest disableKeyRotationRequest) throws AmazonClientException, AmazonServiceException
Disables rotation of the specified key.
disableKeyRotationRequest
- NotFoundException
DisabledException
InvalidArnException
DependencyTimeoutException
KMSInternalException
KMSInvalidStateException
UnsupportedOperationException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.void enableKey(EnableKeyRequest enableKeyRequest) throws AmazonClientException, AmazonServiceException
Marks a key as enabled, thereby permitting its use.
enableKeyRequest
- NotFoundException
InvalidArnException
DependencyTimeoutException
KMSInternalException
LimitExceededException
KMSInvalidStateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.void enableKeyRotation(EnableKeyRotationRequest enableKeyRotationRequest) throws AmazonClientException, AmazonServiceException
Enables rotation of the specified customer master key.
enableKeyRotationRequest
- NotFoundException
DisabledException
InvalidArnException
DependencyTimeoutException
KMSInternalException
KMSInvalidStateException
UnsupportedOperationException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.EncryptResult encrypt(EncryptRequest encryptRequest) throws AmazonClientException, AmazonServiceException
Encrypts plaintext into ciphertext by using a customer master key. The
Encrypt
function has two primary use cases:
You can encrypt up to 4 KB of arbitrary data such as an RSA key, a database password, or other sensitive customer information.
If you are moving encrypted data from one region to another, you can use this API to encrypt in the new region the plaintext data key that was used to encrypt the data in the original region. This provides you with an encrypted copy of the data key that can be decrypted in the new region and used there to decrypt the encrypted data.
Unless you are moving encrypted data from one region to another, you
don't use this function to encrypt a generated data key within a region.
You retrieve data keys already encrypted by calling the
GenerateDataKey or GenerateDataKeyWithoutPlaintext
function. Data keys don't need to be encrypted again by calling
Encrypt
.
If you want to encrypt data locally in your application, you can use the
GenerateDataKey
function to return a plaintext data
encryption key and a copy of the key encrypted under the customer master
key (CMK) of your choosing.
encryptRequest
- NotFoundException
DisabledException
KeyUnavailableException
DependencyTimeoutException
InvalidKeyUsageException
InvalidGrantTokenException
KMSInternalException
KMSInvalidStateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.GenerateDataKeyResult generateDataKey(GenerateDataKeyRequest generateDataKeyRequest) throws AmazonClientException, AmazonServiceException
Returns a data encryption key that you can use in your application to encrypt data locally.
You must specify the customer master key (CMK) under which to generate
the data key. You must also specify the length of the data key using
either the KeySpec
or NumberOfBytes
field. You
must specify one field or the other, but not both. For common key lengths
(128-bit and 256-bit symmetric keys), we recommend that you use
KeySpec
.
This operation returns a plaintext copy of the data key in the
Plaintext
field of the response, and an encrypted copy of
the data key in the CiphertextBlob
field. The data key is
encrypted under the CMK specified in the KeyId
field of the
request.
We recommend that you use the following pattern to encrypt data locally in your application:
Use this operation (GenerateDataKey
) to retrieve a data
encryption key.
Use the plaintext data encryption key (returned in the
Plaintext
field of the response) to encrypt data locally,
then erase the plaintext data key from memory.
Store the encrypted data key (returned in the CiphertextBlob
field of the response) alongside the locally encrypted data.
To decrypt data locally:
Use the Decrypt operation to decrypt the encrypted data key into a plaintext copy of the data key.
Use the plaintext data key to decrypt data locally, then erase the plaintext data key from memory.
To return only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To return an arbitrary unpredictable byte string, use GenerateRandom.
If you use the optional EncryptionContext
field, you must
store at least enough information to be able to reconstruct the full
encryption context when you later send the ciphertext to the
Decrypt operation. It is a good practice to choose an encryption
context that you can reconstruct on the fly to better secure the
ciphertext. For more information, see Encryption Context in the AWS Key Management Service Developer
Guide.
generateDataKeyRequest
- NotFoundException
DisabledException
KeyUnavailableException
DependencyTimeoutException
InvalidKeyUsageException
InvalidGrantTokenException
KMSInternalException
KMSInvalidStateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.GenerateDataKeyWithoutPlaintextResult generateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest generateDataKeyWithoutPlaintextRequest) throws AmazonClientException, AmazonServiceException
Returns a data encryption key encrypted under a customer master key (CMK). This operation is identical to GenerateDataKey but returns only the encrypted copy of the data key.
This operation is useful in a system that has multiple components with
different degrees of trust. For example, consider a system that stores
encrypted data in containers. Each container stores the encrypted data
and an encrypted copy of the data key. One component of the system,
called the control plane, creates new containers. When it creates
a new container, it uses this operation (
GenerateDataKeyWithoutPlaintext
) to get an encrypted data
key and then stores it in the container. Later, a different component of
the system, called the data plane, puts encrypted data into the
containers. To do this, it passes the encrypted data key to the
Decrypt operation, then uses the returned plaintext data key to
encrypt data, and finally stores the encrypted data in the container. In
this system, the control plane never sees the plaintext data key.
generateDataKeyWithoutPlaintextRequest
- NotFoundException
DisabledException
KeyUnavailableException
DependencyTimeoutException
InvalidKeyUsageException
InvalidGrantTokenException
KMSInternalException
KMSInvalidStateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.GenerateRandomResult generateRandom(GenerateRandomRequest generateRandomRequest) throws AmazonClientException, AmazonServiceException
Generates an unpredictable byte string.
generateRandomRequest
- DependencyTimeoutException
KMSInternalException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.GetKeyPolicyResult getKeyPolicy(GetKeyPolicyRequest getKeyPolicyRequest) throws AmazonClientException, AmazonServiceException
Retrieves a policy attached to the specified key.
getKeyPolicyRequest
- NotFoundException
InvalidArnException
DependencyTimeoutException
KMSInternalException
KMSInvalidStateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.GetKeyRotationStatusResult getKeyRotationStatus(GetKeyRotationStatusRequest getKeyRotationStatusRequest) throws AmazonClientException, AmazonServiceException
Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.
getKeyRotationStatusRequest
- NotFoundException
InvalidArnException
DependencyTimeoutException
KMSInternalException
KMSInvalidStateException
UnsupportedOperationException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.GetParametersForImportResult getParametersForImport(GetParametersForImportRequest getParametersForImportRequest) throws AmazonClientException, AmazonServiceException
Returns the items you need in order to import key material into AWS KMS from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.
You must specify the key ID of the customer master key (CMK) into which
you will import key material. This CMK's Origin
must be
EXTERNAL
. You must also specify the wrapping algorithm and
type of wrapping key (public key) that you will use to encrypt the key
material.
This operation returns a public key and an import token. Use the public
key to encrypt the key material. Store the import token to send with a
subsequent ImportKeyMaterial request. The public key and import
token from the same response must be used together. These items are valid
for 24 hours, after which they cannot be used for a subsequent
ImportKeyMaterial request. To retrieve new ones, send another
GetParametersForImport
request.
getParametersForImportRequest
- InvalidArnException
UnsupportedOperationException
DependencyTimeoutException
NotFoundException
KMSInternalException
KMSInvalidStateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.ImportKeyMaterialResult importKeyMaterial(ImportKeyMaterialRequest importKeyMaterialRequest) throws AmazonClientException, AmazonServiceException
Imports key material into an AWS KMS customer master key (CMK) from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.
You must specify the key ID of the CMK to import the key material into.
This CMK's Origin
must be EXTERNAL
. You must
also send an import token and the encrypted key material. Send the import
token that you received in the same GetParametersForImport
response that contained the public key that you used to encrypt the key
material. You must also specify whether the key material expires and if
so, when. When the key material expires, AWS KMS deletes the key material
and the CMK becomes unusable. To use the CMK again, you can reimport the
same key material. If you set an expiration date, you can change it only
by reimporting the same key material and specifying a new expiration
date.
When this operation is successful, the specified CMK's key state changes
to Enabled
, and you can use the CMK.
After you successfully import key material into a CMK, you can reimport the same key material into that CMK, but you cannot import different key material.
importKeyMaterialRequest
- InvalidArnException
UnsupportedOperationException
DependencyTimeoutException
NotFoundException
KMSInternalException
KMSInvalidStateException
InvalidCiphertextException
IncorrectKeyMaterialException
ExpiredImportTokenException
InvalidImportTokenException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.ListAliasesResult listAliases(ListAliasesRequest listAliasesRequest) throws AmazonClientException, AmazonServiceException
Lists all of the key aliases in the account.
listAliasesRequest
- DependencyTimeoutException
InvalidMarkerException
KMSInternalException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.ListGrantsResult listGrants(ListGrantsRequest listGrantsRequest) throws AmazonClientException, AmazonServiceException
List the grants for a specified key.
listGrantsRequest
- NotFoundException
DependencyTimeoutException
InvalidMarkerException
InvalidArnException
KMSInternalException
KMSInvalidStateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.ListKeyPoliciesResult listKeyPolicies(ListKeyPoliciesRequest listKeyPoliciesRequest) throws AmazonClientException, AmazonServiceException
Retrieves a list of policies attached to a key.
listKeyPoliciesRequest
- NotFoundException
InvalidArnException
DependencyTimeoutException
KMSInternalException
KMSInvalidStateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.ListKeysResult listKeys(ListKeysRequest listKeysRequest) throws AmazonClientException, AmazonServiceException
Lists the customer master keys.
listKeysRequest
- DependencyTimeoutException
KMSInternalException
InvalidMarkerException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.ListRetirableGrantsResult listRetirableGrants(ListRetirableGrantsRequest listRetirableGrantsRequest) throws AmazonClientException, AmazonServiceException
Returns a list of all grants for which the grant's
RetiringPrincipal
matches the one specified.
A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.
listRetirableGrantsRequest
- DependencyTimeoutException
InvalidMarkerException
InvalidArnException
NotFoundException
KMSInternalException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.void putKeyPolicy(PutKeyPolicyRequest putKeyPolicyRequest) throws AmazonClientException, AmazonServiceException
Attaches a key policy to the specified customer master key (CMK).
For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.
putKeyPolicyRequest
- NotFoundException
InvalidArnException
MalformedPolicyDocumentException
DependencyTimeoutException
UnsupportedOperationException
KMSInternalException
LimitExceededException
KMSInvalidStateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.ReEncryptResult reEncrypt(ReEncryptRequest reEncryptRequest) throws AmazonClientException, AmazonServiceException
Encrypts data on the server side with a new customer master key (CMK) without exposing the plaintext of the data on the client side. The data is first decrypted and then reencrypted. You can also use this operation to change the encryption context of a ciphertext.
Unlike other operations, ReEncrypt
is authorized twice, once
as ReEncryptFrom
on the source CMK and once as
ReEncryptTo
on the destination CMK. We recommend that you
include the "kms:ReEncrypt*"
permission in your key policies to permit reencryption from or to the CMK. This
permission is automatically included in the key policy when you create a
CMK through the console, but you must include it manually when you create
a CMK programmatically or when you set a key policy with the
PutKeyPolicy operation.
reEncryptRequest
- NotFoundException
DisabledException
InvalidCiphertextException
KeyUnavailableException
DependencyTimeoutException
InvalidKeyUsageException
InvalidGrantTokenException
KMSInternalException
KMSInvalidStateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.void retireGrant(RetireGrantRequest retireGrantRequest) throws AmazonClientException, AmazonServiceException
Retires a grant. To clean up, you can retire a grant when you're done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:
The AWS account (root user) under which the grant was created
The RetiringPrincipal
, if present in the grant
The GranteePrincipal
, if RetireGrant
is an
operation specified in the grant
You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The CreateGrant operation returns both.
retireGrantRequest
- InvalidGrantTokenException
InvalidGrantIdException
NotFoundException
DependencyTimeoutException
KMSInternalException
KMSInvalidStateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.void revokeGrant(RevokeGrantRequest revokeGrantRequest) throws AmazonClientException, AmazonServiceException
Revokes a grant. You can revoke a grant to actively deny operations that depend on it.
revokeGrantRequest
- NotFoundException
DependencyTimeoutException
InvalidArnException
InvalidGrantIdException
KMSInternalException
KMSInvalidStateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.ScheduleKeyDeletionResult scheduleKeyDeletion(ScheduleKeyDeletionRequest scheduleKeyDeletionRequest) throws AmazonClientException, AmazonServiceException
Schedules the deletion of a customer master key (CMK). You may provide a
waiting period, specified in days, before deletion occurs. If you do not
provide a waiting period, the default period of 30 days is used. When
this operation is successful, the state of the CMK changes to
PendingDeletion
. Before the waiting period ends, you can use
CancelKeyDeletion to cancel the deletion of the CMK. After the
waiting period ends, AWS KMS deletes the CMK and all AWS KMS data
associated with it, including all aliases that refer to it.
Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use DisableKey.
For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
scheduleKeyDeletionRequest
- NotFoundException
InvalidArnException
DependencyTimeoutException
KMSInternalException
KMSInvalidStateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.void updateAlias(UpdateAliasRequest updateAliasRequest) throws AmazonClientException, AmazonServiceException
Updates an alias to map it to a different key.
An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the key.
An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).
The alias and the key it is mapped to must be in the same AWS account and the same region.
updateAliasRequest
- DependencyTimeoutException
NotFoundException
KMSInternalException
KMSInvalidStateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.void updateKeyDescription(UpdateKeyDescriptionRequest updateKeyDescriptionRequest) throws AmazonClientException, AmazonServiceException
Updates the description of a customer master key (CMK).
updateKeyDescriptionRequest
- NotFoundException
InvalidArnException
DependencyTimeoutException
KMSInternalException
KMSInvalidStateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.CreateKeyResult createKey() throws AmazonClientException, AmazonServiceException
Creates a customer master key (CMK).
You can use a CMK to encrypt small amounts of data (4 KiB or less) directly, but CMKs are more commonly used to encrypt data encryption keys (DEKs), which are used to encrypt raw data. For more information about DEKs and the difference between CMKs and DEKs, see the following:
The GenerateDataKey operation
AWS Key Management Service Concepts in the AWS Key Management Service Developer Guide
MalformedPolicyDocumentException
DependencyTimeoutException
InvalidArnException
UnsupportedOperationException
KMSInternalException
LimitExceededException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.ListKeysResult listKeys() throws AmazonClientException, AmazonServiceException
Lists the customer master keys.
DependencyTimeoutException
KMSInternalException
InvalidMarkerException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.ListAliasesResult listAliases() throws AmazonClientException, AmazonServiceException
Lists all of the key aliases in the account.
DependencyTimeoutException
InvalidMarkerException
KMSInternalException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.void retireGrant() throws AmazonClientException, AmazonServiceException
Retires a grant. To clean up, you can retire a grant when you're done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:
The AWS account (root user) under which the grant was created
The RetiringPrincipal
, if present in the grant
The GranteePrincipal
, if RetireGrant
is an
operation specified in the grant
You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The CreateGrant operation returns both.
InvalidGrantTokenException
InvalidGrantIdException
NotFoundException
DependencyTimeoutException
KMSInternalException
KMSInvalidStateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.GenerateRandomResult generateRandom() throws AmazonClientException, AmazonServiceException
Generates an unpredictable byte string.
DependencyTimeoutException
KMSInternalException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.