@ThreadSafe public class AWSKMSClient extends AmazonWebServiceClient implements 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 | Field and Description |
|---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to
this client
|
protected List<com.amazonaws.transform.JsonErrorUnmarshallerV2> |
jsonErrorUnmarshallers
List of exception unmarshallers for all KMS exceptions.
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset| Constructor and Description |
|---|
AWSKMSClient()
Constructs a new client to invoke service methods on KMS.
|
AWSKMSClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on KMS using the
specified AWS account credentials.
|
AWSKMSClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on KMS using the
specified AWS account credentials and client configuration options.
|
AWSKMSClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on KMS using the
specified AWS account credentials provider.
|
AWSKMSClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on KMS using the
specified AWS account credentials provider and client configuration
options.
|
AWSKMSClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on KMS using the
specified AWS account credentials provider, client configuration options,
and request metric collector.
|
AWSKMSClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on KMS.
|
| 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()
Simplified method form for invoking the CreateKey operation.
|
CreateKeyResult |
createKey(CreateKeyRequest createKeyRequest)
Creates a customer master key (CMK).
|
DecryptResult |
decrypt(DecryptRequest decryptRequest)
Decrypts ciphertext.
|
void |
deleteAlias(DeleteAliasRequest deleteAliasRequest)
Deletes the specified alias.
|
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)
Generates a data key that you can use in your application to locally
encrypt data.
|
GenerateDataKeyWithoutPlaintextResult |
generateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest generateDataKeyWithoutPlaintextRequest)
Returns a data key encrypted by a customer master key without the
plaintext copy of that key.
|
GenerateRandomResult |
generateRandom()
Simplified method form for invoking the GenerateRandom operation.
|
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.
|
ListAliasesResult |
listAliases()
Simplified method form for invoking the ListAliases operation.
|
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()
Simplified method form for invoking the ListKeys operation.
|
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 without
exposing the plaintext of the data on the client side.
|
void |
retireGrant()
Simplified method form for invoking the RetireGrant operation.
|
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 |
updateAlias(UpdateAliasRequest updateAliasRequest)
Updates an alias to map it to a different key.
|
void |
updateKeyDescription(UpdateKeyDescriptionRequest updateKeyDescriptionRequest)
Updates the description of a key.
|
addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdownprotected static final ClientConfigurationFactory configFactory
protected List<com.amazonaws.transform.JsonErrorUnmarshallerV2> jsonErrorUnmarshallers
public AWSKMSClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChainpublic AWSKMSClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client
connects to KMS (ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChainpublic AWSKMSClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.public AWSKMSClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.clientConfiguration - The client configuration options controlling how this client
connects to KMS (ex: proxy settings, retry counts, etc.).public AWSKMSClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.public AWSKMSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client
connects to KMS (ex: proxy settings, retry counts, etc.).public AWSKMSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client
connects to KMS (ex: proxy settings, retry counts, etc.).requestMetricCollector - optional request metric collectorpublic CancelKeyDeletionResult cancelKeyDeletion(CancelKeyDeletionRequest cancelKeyDeletionRequest)
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.
cancelKeyDeletion in interface AWSKMScancelKeyDeletionRequest - NotFoundException - The request was rejected because the specified entity or resource
could not be found.InvalidArnException - The request was rejected because a specified ARN was not valid.DependencyTimeoutException - The system timed out while trying to fulfill the request. The
request can be retried.KMSInternalException - The request was rejected because an internal exception occurred.
The request can be retried.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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public void createAlias(CreateAliasRequest createAliasRequest)
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.
createAlias in interface AWSKMScreateAliasRequest - DependencyTimeoutException - The system timed out while trying to fulfill the request. The
request can be retried.AlreadyExistsException - The request was rejected because it attempted to create a
resource that already exists.NotFoundException - The request was rejected because the specified entity or resource
could not be found.InvalidAliasNameException - The request was rejected because the specified alias name is not
valid.KMSInternalException - The request was rejected because an internal exception occurred.
The request can be retried.LimitExceededException - The request was rejected because a limit was exceeded. For more
information, see Limits in the AWS Key Management Service Developer
Guide.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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public CreateGrantResult createGrant(CreateGrantRequest createGrantRequest)
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.
createGrant in interface AWSKMScreateGrantRequest - NotFoundException - The request was rejected because the specified entity or resource
could not be found.DisabledException - The request was rejected because the specified key was marked as
disabled.DependencyTimeoutException - The system timed out while trying to fulfill the request. The
request can be retried.InvalidArnException - The request was rejected because a specified ARN was not valid.KMSInternalException - The request was rejected because an internal exception occurred.
The request can be retried.InvalidGrantTokenException - The request was rejected because a grant token provided as part
of the request is invalid.LimitExceededException - The request was rejected because a limit was exceeded. For more
information, see Limits in the AWS Key Management Service Developer
Guide.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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public CreateKeyResult createKey(CreateKeyRequest createKeyRequest)
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
createKey in interface AWSKMScreateKeyRequest - MalformedPolicyDocumentException - The request was rejected because the specified policy is not
syntactically or semantically correct.DependencyTimeoutException - The system timed out while trying to fulfill the request. The
request can be retried.InvalidArnException - The request was rejected because a specified ARN was not valid.UnsupportedOperationException - The request was rejected because a specified parameter is not
supported.KMSInternalException - The request was rejected because an internal exception occurred.
The request can be retried.LimitExceededException - The request was rejected because a limit was exceeded. For more
information, see Limits in the AWS Key Management Service Developer
Guide.public CreateKeyResult createKey()
AWSKMScreateKey in interface AWSKMSAWSKMS.createKey(CreateKeyRequest)public DecryptResult decrypt(DecryptRequest decryptRequest)
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.
decrypt in interface AWSKMSdecryptRequest - NotFoundException - The request was rejected because the specified entity or resource
could not be found.DisabledException - The request was rejected because the specified key was marked as
disabled.InvalidCiphertextException - The request was rejected because the specified ciphertext has
been corrupted or is otherwise invalid.KeyUnavailableException - The request was rejected because the key was not available. The
request can be retried.DependencyTimeoutException - The system timed out while trying to fulfill the request. The
request can be retried.InvalidGrantTokenException - The request was rejected because a grant token provided as part
of the request is invalid.KMSInternalException - The request was rejected because an internal exception occurred.
The request can be retried.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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public void deleteAlias(DeleteAliasRequest deleteAliasRequest)
Deletes the specified alias. To map an alias to a different key, call UpdateAlias.
deleteAlias in interface AWSKMSdeleteAliasRequest - DependencyTimeoutException - The system timed out while trying to fulfill the request. The
request can be retried.NotFoundException - The request was rejected because the specified entity or resource
could not be found.KMSInternalException - The request was rejected because an internal exception occurred.
The request can be retried.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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public DescribeKeyResult describeKey(DescribeKeyRequest describeKeyRequest)
Provides detailed information about the specified customer master key.
describeKey in interface AWSKMSdescribeKeyRequest - NotFoundException - The request was rejected because the specified entity or resource
could not be found.InvalidArnException - The request was rejected because a specified ARN was not valid.DependencyTimeoutException - The system timed out while trying to fulfill the request. The
request can be retried.KMSInternalException - The request was rejected because an internal exception occurred.
The request can be retried.public void disableKey(DisableKeyRequest disableKeyRequest)
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.
disableKey in interface AWSKMSdisableKeyRequest - NotFoundException - The request was rejected because the specified entity or resource
could not be found.InvalidArnException - The request was rejected because a specified ARN was not valid.DependencyTimeoutException - The system timed out while trying to fulfill the request. The
request can be retried.KMSInternalException - The request was rejected because an internal exception occurred.
The request can be retried.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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public void disableKeyRotation(DisableKeyRotationRequest disableKeyRotationRequest)
Disables rotation of the specified key.
disableKeyRotation in interface AWSKMSdisableKeyRotationRequest - NotFoundException - The request was rejected because the specified entity or resource
could not be found.DisabledException - The request was rejected because the specified key was marked as
disabled.InvalidArnException - The request was rejected because a specified ARN was not valid.DependencyTimeoutException - The system timed out while trying to fulfill the request. The
request can be retried.KMSInternalException - The request was rejected because an internal exception occurred.
The request can be retried.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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public void enableKey(EnableKeyRequest enableKeyRequest)
Marks a key as enabled, thereby permitting its use.
enableKey in interface AWSKMSenableKeyRequest - NotFoundException - The request was rejected because the specified entity or resource
could not be found.InvalidArnException - The request was rejected because a specified ARN was not valid.DependencyTimeoutException - The system timed out while trying to fulfill the request. The
request can be retried.KMSInternalException - The request was rejected because an internal exception occurred.
The request can be retried.LimitExceededException - The request was rejected because a limit was exceeded. For more
information, see Limits in the AWS Key Management Service Developer
Guide.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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public void enableKeyRotation(EnableKeyRotationRequest enableKeyRotationRequest)
Enables rotation of the specified customer master key.
enableKeyRotation in interface AWSKMSenableKeyRotationRequest - NotFoundException - The request was rejected because the specified entity or resource
could not be found.DisabledException - The request was rejected because the specified key was marked as
disabled.InvalidArnException - The request was rejected because a specified ARN was not valid.DependencyTimeoutException - The system timed out while trying to fulfill the request. The
request can be retried.KMSInternalException - The request was rejected because an internal exception occurred.
The request can be retried.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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public EncryptResult encrypt(EncryptRequest encryptRequest)
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.
encrypt in interface AWSKMSencryptRequest - NotFoundException - The request was rejected because the specified entity or resource
could not be found.DisabledException - The request was rejected because the specified key was marked as
disabled.KeyUnavailableException - The request was rejected because the key was not available. The
request can be retried.DependencyTimeoutException - The system timed out while trying to fulfill the request. The
request can be retried.InvalidKeyUsageException - The request was rejected because the specified KeySpec parameter
is not valid. The currently supported value is ENCRYPT/DECRYPT.InvalidGrantTokenException - The request was rejected because a grant token provided as part
of the request is invalid.KMSInternalException - The request was rejected because an internal exception occurred.
The request can be retried.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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public GenerateDataKeyResult generateDataKey(GenerateDataKeyRequest generateDataKeyRequest)
Generates a data key that you can use in your application to locally
encrypt data. This call returns a plaintext version of the key in the
Plaintext field of the response object and an encrypted copy
of the key in the CiphertextBlob field. The key is encrypted
by using the master key specified by the KeyId field. To
decrypt the encrypted key, pass it to the Decrypt API.
We recommend that you use the following pattern to locally encrypt data:
call the GenerateDataKey API, use the key returned in the
Plaintext response field to locally encrypt data, and then
erase the plaintext data key from memory. Store the encrypted data key
(contained in the CiphertextBlob field) alongside of the
locally encrypted data.
You should not call the Encrypt function to re-encrypt your
data keys within a region. GenerateDataKey always returns
the data key encrypted and tied to the customer master key that will be
used to decrypt it. There is no need to decrypt it twice.
If you decide to use the optional EncryptionContext
parameter, you must also store the context in full or at least store
enough information along with the encrypted data to be able to
reconstruct the context when submitting the ciphertext to the
Decrypt API. It is a good practice to choose a context that
you can reconstruct on the fly to better secure the ciphertext. For more
information about how this parameter is used, see Encryption Context.
To decrypt data, pass the encrypted data key to the Decrypt
API. Decrypt uses the associated master key to decrypt the
encrypted data key and returns it as plaintext. Use the plaintext data
key to locally decrypt your data and then erase the key from memory. You
must specify the encryption context, if any, that you specified when you
generated the key. The encryption context is logged by CloudTrail, and
you can use this log to help track the use of particular data.
generateDataKey in interface AWSKMSgenerateDataKeyRequest - NotFoundException - The request was rejected because the specified entity or resource
could not be found.DisabledException - The request was rejected because the specified key was marked as
disabled.KeyUnavailableException - The request was rejected because the key was not available. The
request can be retried.DependencyTimeoutException - The system timed out while trying to fulfill the request. The
request can be retried.InvalidKeyUsageException - The request was rejected because the specified KeySpec parameter
is not valid. The currently supported value is ENCRYPT/DECRYPT.InvalidGrantTokenException - The request was rejected because a grant token provided as part
of the request is invalid.KMSInternalException - The request was rejected because an internal exception occurred.
The request can be retried.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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public GenerateDataKeyWithoutPlaintextResult generateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest generateDataKeyWithoutPlaintextRequest)
Returns a data key encrypted by a customer master key without the plaintext copy of that key. Otherwise, this API functions exactly like GenerateDataKey. You can use this API to, for example, satisfy an audit requirement that an encrypted key be made available without exposing the plaintext copy of that key.
generateDataKeyWithoutPlaintext in interface AWSKMSgenerateDataKeyWithoutPlaintextRequest - NotFoundException - The request was rejected because the specified entity or resource
could not be found.DisabledException - The request was rejected because the specified key was marked as
disabled.KeyUnavailableException - The request was rejected because the key was not available. The
request can be retried.DependencyTimeoutException - The system timed out while trying to fulfill the request. The
request can be retried.InvalidKeyUsageException - The request was rejected because the specified KeySpec parameter
is not valid. The currently supported value is ENCRYPT/DECRYPT.InvalidGrantTokenException - The request was rejected because a grant token provided as part
of the request is invalid.KMSInternalException - The request was rejected because an internal exception occurred.
The request can be retried.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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public GenerateRandomResult generateRandom(GenerateRandomRequest generateRandomRequest)
Generates an unpredictable byte string.
generateRandom in interface AWSKMSgenerateRandomRequest - DependencyTimeoutException - The system timed out while trying to fulfill the request. The
request can be retried.KMSInternalException - The request was rejected because an internal exception occurred.
The request can be retried.public GenerateRandomResult generateRandom()
AWSKMSgenerateRandom in interface AWSKMSAWSKMS.generateRandom(GenerateRandomRequest)public GetKeyPolicyResult getKeyPolicy(GetKeyPolicyRequest getKeyPolicyRequest)
Retrieves a policy attached to the specified key.
getKeyPolicy in interface AWSKMSgetKeyPolicyRequest - NotFoundException - The request was rejected because the specified entity or resource
could not be found.InvalidArnException - The request was rejected because a specified ARN was not valid.DependencyTimeoutException - The system timed out while trying to fulfill the request. The
request can be retried.KMSInternalException - The request was rejected because an internal exception occurred.
The request can be retried.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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public GetKeyRotationStatusResult getKeyRotationStatus(GetKeyRotationStatusRequest getKeyRotationStatusRequest)
Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.
getKeyRotationStatus in interface AWSKMSgetKeyRotationStatusRequest - NotFoundException - The request was rejected because the specified entity or resource
could not be found.InvalidArnException - The request was rejected because a specified ARN was not valid.DependencyTimeoutException - The system timed out while trying to fulfill the request. The
request can be retried.KMSInternalException - The request was rejected because an internal exception occurred.
The request can be retried.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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public ListAliasesResult listAliases(ListAliasesRequest listAliasesRequest)
Lists all of the key aliases in the account.
listAliases in interface AWSKMSlistAliasesRequest - DependencyTimeoutException - The system timed out while trying to fulfill the request. The
request can be retried.InvalidMarkerException - The request was rejected because the marker that specifies where
pagination should next begin is not valid.KMSInternalException - The request was rejected because an internal exception occurred.
The request can be retried.public ListAliasesResult listAliases()
AWSKMSlistAliases in interface AWSKMSAWSKMS.listAliases(ListAliasesRequest)public ListGrantsResult listGrants(ListGrantsRequest listGrantsRequest)
List the grants for a specified key.
listGrants in interface AWSKMSlistGrantsRequest - NotFoundException - The request was rejected because the specified entity or resource
could not be found.DependencyTimeoutException - The system timed out while trying to fulfill the request. The
request can be retried.InvalidMarkerException - The request was rejected because the marker that specifies where
pagination should next begin is not valid.InvalidArnException - The request was rejected because a specified ARN was not valid.KMSInternalException - The request was rejected because an internal exception occurred.
The request can be retried.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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public ListKeyPoliciesResult listKeyPolicies(ListKeyPoliciesRequest listKeyPoliciesRequest)
Retrieves a list of policies attached to a key.
listKeyPolicies in interface AWSKMSlistKeyPoliciesRequest - NotFoundException - The request was rejected because the specified entity or resource
could not be found.InvalidArnException - The request was rejected because a specified ARN was not valid.DependencyTimeoutException - The system timed out while trying to fulfill the request. The
request can be retried.KMSInternalException - The request was rejected because an internal exception occurred.
The request can be retried.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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public ListKeysResult listKeys(ListKeysRequest listKeysRequest)
Lists the customer master keys.
listKeys in interface AWSKMSlistKeysRequest - DependencyTimeoutException - The system timed out while trying to fulfill the request. The
request can be retried.KMSInternalException - The request was rejected because an internal exception occurred.
The request can be retried.public ListKeysResult listKeys()
AWSKMSlistKeys in interface AWSKMSAWSKMS.listKeys(ListKeysRequest)public ListRetirableGrantsResult listRetirableGrants(ListRetirableGrantsRequest listRetirableGrantsRequest)
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.
listRetirableGrants in interface AWSKMSlistRetirableGrantsRequest - DependencyTimeoutException - The system timed out while trying to fulfill the request. The
request can be retried.InvalidMarkerException - The request was rejected because the marker that specifies where
pagination should next begin is not valid.InvalidArnException - The request was rejected because a specified ARN was not valid.NotFoundException - The request was rejected because the specified entity or resource
could not be found.KMSInternalException - The request was rejected because an internal exception occurred.
The request can be retried.public void putKeyPolicy(PutKeyPolicyRequest putKeyPolicyRequest)
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.
putKeyPolicy in interface AWSKMSputKeyPolicyRequest - NotFoundException - The request was rejected because the specified entity or resource
could not be found.InvalidArnException - The request was rejected because a specified ARN was not valid.MalformedPolicyDocumentException - The request was rejected because the specified policy is not
syntactically or semantically correct.DependencyTimeoutException - The system timed out while trying to fulfill the request. The
request can be retried.UnsupportedOperationException - The request was rejected because a specified parameter is not
supported.KMSInternalException - The request was rejected because an internal exception occurred.
The request can be retried.LimitExceededException - The request was rejected because a limit was exceeded. For more
information, see Limits in the AWS Key Management Service Developer
Guide.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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public ReEncryptResult reEncrypt(ReEncryptRequest reEncryptRequest)
Encrypts data on the server side with a new customer master key without exposing the plaintext of the data on the client side. The data is first decrypted and then encrypted. This operation can also be used to change the encryption context of a ciphertext.
Unlike other actions, ReEncrypt is authorized twice - once
as ReEncryptFrom on the source key and once as
ReEncryptTo on the destination key. We therefore recommend
that you include the "action":"kms:ReEncrypt*" statement in
your key policies to permit re-encryption from or to the key. The
statement is included automatically when you authorize use of the key
through the console but must be included manually when you set a policy
by using the PutKeyPolicy function.
reEncrypt in interface AWSKMSreEncryptRequest - NotFoundException - The request was rejected because the specified entity or resource
could not be found.DisabledException - The request was rejected because the specified key was marked as
disabled.InvalidCiphertextException - The request was rejected because the specified ciphertext has
been corrupted or is otherwise invalid.KeyUnavailableException - The request was rejected because the key was not available. The
request can be retried.DependencyTimeoutException - The system timed out while trying to fulfill the request. The
request can be retried.InvalidKeyUsageException - The request was rejected because the specified KeySpec parameter
is not valid. The currently supported value is ENCRYPT/DECRYPT.InvalidGrantTokenException - The request was rejected because a grant token provided as part
of the request is invalid.KMSInternalException - The request was rejected because an internal exception occurred.
The request can be retried.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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public void retireGrant(RetireGrantRequest retireGrantRequest)
Retires a grant. You can retire a grant when you're done using it to clean up. 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 account that created the grant
The RetiringPrincipal, if present
The GranteePrincipal, if RetireGrant is a
grantee operation
The grant to retire must be identified by its grant token or by a
combination of the key ARN and the grant ID. A grant token is a unique
variable-length base64-encoded string. A grant ID is a 64 character
unique identifier of a grant. Both are returned by the
CreateGrant function.
retireGrant in interface AWSKMSretireGrantRequest - InvalidGrantTokenException - The request was rejected because a grant token provided as part
of the request is invalid.InvalidGrantIdException - The request was rejected because the specified
GrantId is not valid.NotFoundException - The request was rejected because the specified entity or resource
could not be found.DependencyTimeoutException - The system timed out while trying to fulfill the request. The
request can be retried.KMSInternalException - The request was rejected because an internal exception occurred.
The request can be retried.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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public void retireGrant()
AWSKMSretireGrant in interface AWSKMSAWSKMS.retireGrant(RetireGrantRequest)public void revokeGrant(RevokeGrantRequest revokeGrantRequest)
Revokes a grant. You can revoke a grant to actively deny operations that depend on it.
revokeGrant in interface AWSKMSrevokeGrantRequest - NotFoundException - The request was rejected because the specified entity or resource
could not be found.DependencyTimeoutException - The system timed out while trying to fulfill the request. The
request can be retried.InvalidArnException - The request was rejected because a specified ARN was not valid.InvalidGrantIdException - The request was rejected because the specified
GrantId is not valid.KMSInternalException - The request was rejected because an internal exception occurred.
The request can be retried.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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public ScheduleKeyDeletionResult scheduleKeyDeletion(ScheduleKeyDeletionRequest scheduleKeyDeletionRequest)
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 point 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.
scheduleKeyDeletion in interface AWSKMSscheduleKeyDeletionRequest - NotFoundException - The request was rejected because the specified entity or resource
could not be found.InvalidArnException - The request was rejected because a specified ARN was not valid.DependencyTimeoutException - The system timed out while trying to fulfill the request. The
request can be retried.KMSInternalException - The request was rejected because an internal exception occurred.
The request can be retried.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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public void updateAlias(UpdateAliasRequest updateAliasRequest)
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.
updateAlias in interface AWSKMSupdateAliasRequest - DependencyTimeoutException - The system timed out while trying to fulfill the request. The
request can be retried.NotFoundException - The request was rejected because the specified entity or resource
could not be found.KMSInternalException - The request was rejected because an internal exception occurred.
The request can be retried.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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public void updateKeyDescription(UpdateKeyDescriptionRequest updateKeyDescriptionRequest)
Updates the description of a key.
updateKeyDescription in interface AWSKMSupdateKeyDescriptionRequest - NotFoundException - The request was rejected because the specified entity or resource
could not be found.InvalidArnException - The request was rejected because a specified ARN was not valid.DependencyTimeoutException - The system timed out while trying to fulfill the request. The
request can be retried.KMSInternalException - The request was rejected because an internal exception occurred.
The request can be retried.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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public 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 the request.
getCachedResponseMetadata in interface AWSKMSrequest - The originally executed requestCopyright © 2016. All rights reserved.