AutoCloseable@Generated("software.amazon.awssdk:codegen") public interface KMSClient extends AutoCloseable
builder() method.
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 | Description |
|---|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method | Description |
|---|---|---|
static KMSClientBuilder |
builder() |
Create a builder that can be used to configure and create a
KMSClient. |
default CancelKeyDeletionResponse |
cancelKeyDeletion(CancelKeyDeletionRequest cancelKeyDeletionRequest) |
Cancels the deletion of a customer master key (CMK).
|
static KMSClient |
create() |
Create a
KMSClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateAliasResponse |
createAlias(CreateAliasRequest createAliasRequest) |
Creates a display name for a customer master key.
|
default CreateGrantResponse |
createGrant(CreateGrantRequest createGrantRequest) |
Adds a grant to a key to specify who can use the key and under what conditions.
|
default CreateKeyResponse |
createKey(CreateKeyRequest createKeyRequest) |
Creates a customer master key (CMK).
|
default DecryptResponse |
decrypt(DecryptRequest decryptRequest) |
Decrypts ciphertext.
|
default DeleteAliasResponse |
deleteAlias(DeleteAliasRequest deleteAliasRequest) |
Deletes the specified alias.
|
default DeleteImportedKeyMaterialResponse |
deleteImportedKeyMaterial(DeleteImportedKeyMaterialRequest deleteImportedKeyMaterialRequest) |
Deletes key material that you previously imported and makes the specified customer master key (CMK) unusable.
|
default DescribeKeyResponse |
describeKey(DescribeKeyRequest describeKeyRequest) |
Provides detailed information about the specified customer master key.
|
default DisableKeyResponse |
disableKey(DisableKeyRequest disableKeyRequest) |
Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic
operations.
|
default DisableKeyRotationResponse |
disableKeyRotation(DisableKeyRotationRequest disableKeyRotationRequest) |
Disables rotation of the specified key.
|
default EnableKeyResponse |
enableKey(EnableKeyRequest enableKeyRequest) |
Marks a key as enabled, thereby permitting its use.
|
default EnableKeyRotationResponse |
enableKeyRotation(EnableKeyRotationRequest enableKeyRotationRequest) |
Enables rotation of the specified customer master key.
|
default EncryptResponse |
encrypt(EncryptRequest encryptRequest) |
Encrypts plaintext into ciphertext by using a customer master key.
|
default GenerateDataKeyResponse |
generateDataKey(GenerateDataKeyRequest generateDataKeyRequest) |
Returns a data encryption key that you can use in your application to encrypt data locally.
|
default GenerateDataKeyWithoutPlaintextResponse |
generateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest generateDataKeyWithoutPlaintextRequest) |
Returns a data encryption key encrypted under a customer master key (CMK).
|
default GenerateRandomResponse |
generateRandom(GenerateRandomRequest generateRandomRequest) |
Returns a random byte string that is cryptographically secure.
|
default GetKeyPolicyResponse |
getKeyPolicy(GetKeyPolicyRequest getKeyPolicyRequest) |
Retrieves a policy attached to the specified key.
|
default GetKeyRotationStatusResponse |
getKeyRotationStatus(GetKeyRotationStatusRequest getKeyRotationStatusRequest) |
Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.
|
default GetParametersForImportResponse |
getParametersForImport(GetParametersForImportRequest getParametersForImportRequest) |
Returns the items you need in order to import key material into AWS KMS from your existing key management
infrastructure.
|
default ImportKeyMaterialResponse |
importKeyMaterial(ImportKeyMaterialRequest importKeyMaterialRequest) |
Imports key material into an AWS KMS customer master key (CMK) from your existing key management infrastructure.
|
default ListAliasesResponse |
listAliases(ListAliasesRequest listAliasesRequest) |
Lists all of the key aliases in the account.
|
default ListGrantsResponse |
listGrants(ListGrantsRequest listGrantsRequest) |
List the grants for a specified key.
|
default ListKeyPoliciesResponse |
listKeyPolicies(ListKeyPoliciesRequest listKeyPoliciesRequest) |
Retrieves a list of policies attached to a key.
|
default ListKeysResponse |
listKeys(ListKeysRequest listKeysRequest) |
Lists the customer master keys.
|
default ListResourceTagsResponse |
listResourceTags(ListResourceTagsRequest listResourceTagsRequest) |
Returns a list of all tags for the specified customer master key (CMK).
|
default ListRetirableGrantsResponse |
listRetirableGrants(ListRetirableGrantsRequest listRetirableGrantsRequest) |
Returns a list of all grants for which the grant's
RetiringPrincipal matches the one specified. |
default PutKeyPolicyResponse |
putKeyPolicy(PutKeyPolicyRequest putKeyPolicyRequest) |
Attaches a key policy to the specified customer master key (CMK).
|
default ReEncryptResponse |
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.
|
default RetireGrantResponse |
retireGrant(RetireGrantRequest retireGrantRequest) |
Retires a grant.
|
default RevokeGrantResponse |
revokeGrant(RevokeGrantRequest revokeGrantRequest) |
Revokes a grant.
|
default ScheduleKeyDeletionResponse |
scheduleKeyDeletion(ScheduleKeyDeletionRequest scheduleKeyDeletionRequest) |
Schedules the deletion of a customer master key (CMK).
|
static ServiceMetadata |
serviceMetadata() |
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest) |
Adds or overwrites one or more tags for the specified customer master key (CMK).
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest) |
Removes the specified tag or tags from the specified customer master key (CMK).
|
default UpdateAliasResponse |
updateAlias(UpdateAliasRequest updateAliasRequest) |
Updates an alias to map it to a different key.
|
default UpdateKeyDescriptionResponse |
updateKeyDescription(UpdateKeyDescriptionRequest updateKeyDescriptionRequest) |
Updates the description of a customer master key (CMK).
|
closestatic final String SERVICE_NAME
static KMSClient create()
KMSClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static KMSClientBuilder builder()
KMSClient.default CancelKeyDeletionResponse cancelKeyDeletion(CancelKeyDeletionRequest cancelKeyDeletionRequest) throws NotFoundException, InvalidArnException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, SdkBaseException, SdkClientException, KMSException
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 - 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 CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateAliasResponse createAlias(CreateAliasRequest createAliasRequest) throws DependencyTimeoutException, AlreadyExistsException, NotFoundException, InvalidAliasNameException, KMSInternalException, LimitExceededException, KMSInvalidStateException, SdkBaseException, SdkClientException, KMSException
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 - 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 CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateGrantResponse createGrant(CreateGrantRequest createGrantRequest) throws NotFoundException, DisabledException, DependencyTimeoutException, InvalidArnException, KMSInternalException, InvalidGrantTokenException, LimitExceededException, KMSInvalidStateException, SdkBaseException, SdkClientException, KMSException
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 - The request was rejected because the specified entity or resource could not be found.DisabledException - The request was rejected because the specified CMK is not enabled.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 the specified grant token is not valid.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 CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateKeyResponse createKey(CreateKeyRequest createKeyRequest) throws MalformedPolicyDocumentException, DependencyTimeoutException, InvalidArnException, UnsupportedOperationException, KMSInternalException, LimitExceededException, TagException, SdkBaseException, SdkClientException, KMSException
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 - 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 or a specified resource is not
valid for this operation.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.TagException - The request was rejected because one or more tags are not valid.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typeUnsupportedOperationExceptiondefault DecryptResponse decrypt(DecryptRequest decryptRequest) throws NotFoundException, DisabledException, InvalidCiphertextException, KeyUnavailableException, DependencyTimeoutException, InvalidGrantTokenException, KMSInternalException, KMSInvalidStateException, SdkBaseException, SdkClientException, KMSException
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 - The request was rejected because the specified entity or resource could not be found.DisabledException - The request was rejected because the specified CMK is not enabled.InvalidCiphertextException - The request was rejected because the specified ciphertext has been corrupted or is otherwise invalid.KeyUnavailableException - The request was rejected because the specified CMK 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 the specified grant token 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 CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteAliasResponse deleteAlias(DeleteAliasRequest deleteAliasRequest) throws DependencyTimeoutException, NotFoundException, KMSInternalException, KMSInvalidStateException, SdkBaseException, SdkClientException, KMSException
Deletes the specified alias. To map an alias to a different key, call UpdateAlias.
deleteAliasRequest - 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 CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteImportedKeyMaterialResponse deleteImportedKeyMaterial(DeleteImportedKeyMaterialRequest deleteImportedKeyMaterialRequest) throws InvalidArnException, UnsupportedOperationException, DependencyTimeoutException, NotFoundException, KMSInternalException, KMSInvalidStateException, SdkBaseException, SdkClientException, KMSException
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 - The request was rejected because a specified ARN was not valid.UnsupportedOperationException - The request was rejected because a specified parameter is not supported or a specified resource is not
valid for this operation.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 CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typeUnsupportedOperationExceptiondefault DescribeKeyResponse describeKey(DescribeKeyRequest describeKeyRequest) throws NotFoundException, InvalidArnException, DependencyTimeoutException, KMSInternalException, SdkBaseException, SdkClientException, KMSException
Provides detailed information about the specified customer master key.
describeKeyRequest - 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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DisableKeyResponse disableKey(DisableKeyRequest disableKeyRequest) throws NotFoundException, InvalidArnException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, SdkBaseException, SdkClientException, KMSException
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 - 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 CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DisableKeyRotationResponse disableKeyRotation(DisableKeyRotationRequest disableKeyRotationRequest) throws NotFoundException, DisabledException, InvalidArnException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, UnsupportedOperationException, SdkBaseException, SdkClientException, KMSException
Disables rotation of the specified key.
disableKeyRotationRequest - NotFoundException - The request was rejected because the specified entity or resource could not be found.DisabledException - The request was rejected because the specified CMK is not enabled.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 CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
UnsupportedOperationException - The request was rejected because a specified parameter is not supported or a specified resource is not
valid for this operation.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typeUnsupportedOperationExceptiondefault EnableKeyResponse enableKey(EnableKeyRequest enableKeyRequest) throws NotFoundException, InvalidArnException, DependencyTimeoutException, KMSInternalException, LimitExceededException, KMSInvalidStateException, SdkBaseException, SdkClientException, KMSException
Marks a key as enabled, thereby permitting its use.
enableKeyRequest - 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 CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault EnableKeyRotationResponse enableKeyRotation(EnableKeyRotationRequest enableKeyRotationRequest) throws NotFoundException, DisabledException, InvalidArnException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, UnsupportedOperationException, SdkBaseException, SdkClientException, KMSException
Enables rotation of the specified customer master key.
enableKeyRotationRequest - NotFoundException - The request was rejected because the specified entity or resource could not be found.DisabledException - The request was rejected because the specified CMK is not enabled.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 CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
UnsupportedOperationException - The request was rejected because a specified parameter is not supported or a specified resource is not
valid for this operation.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typeUnsupportedOperationExceptiondefault EncryptResponse encrypt(EncryptRequest encryptRequest) throws NotFoundException, DisabledException, KeyUnavailableException, DependencyTimeoutException, InvalidKeyUsageException, InvalidGrantTokenException, KMSInternalException, KMSInvalidStateException, SdkBaseException, SdkClientException, KMSException
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 - The request was rejected because the specified entity or resource could not be found.DisabledException - The request was rejected because the specified CMK is not enabled.KeyUnavailableException - The request was rejected because the specified CMK 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 value is not valid.InvalidGrantTokenException - The request was rejected because the specified grant token 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 CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GenerateDataKeyResponse generateDataKey(GenerateDataKeyRequest generateDataKeyRequest) throws NotFoundException, DisabledException, KeyUnavailableException, DependencyTimeoutException, InvalidKeyUsageException, InvalidGrantTokenException, KMSInternalException, KMSInvalidStateException, SdkBaseException, SdkClientException, KMSException
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 a random byte string that is cryptographically secure, 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 - The request was rejected because the specified entity or resource could not be found.DisabledException - The request was rejected because the specified CMK is not enabled.KeyUnavailableException - The request was rejected because the specified CMK 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 value is not valid.InvalidGrantTokenException - The request was rejected because the specified grant token 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 CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GenerateDataKeyWithoutPlaintextResponse generateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest generateDataKeyWithoutPlaintextRequest) throws NotFoundException, DisabledException, KeyUnavailableException, DependencyTimeoutException, InvalidKeyUsageException, InvalidGrantTokenException, KMSInternalException, KMSInvalidStateException, SdkBaseException, SdkClientException, KMSException
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 - The request was rejected because the specified entity or resource could not be found.DisabledException - The request was rejected because the specified CMK is not enabled.KeyUnavailableException - The request was rejected because the specified CMK 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 value is not valid.InvalidGrantTokenException - The request was rejected because the specified grant token 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 CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GenerateRandomResponse generateRandom(GenerateRandomRequest generateRandomRequest) throws DependencyTimeoutException, KMSInternalException, SdkBaseException, SdkClientException, KMSException
Returns a random byte string that is cryptographically secure.
For more information about entropy and random number generation, see the AWS Key Management Service Cryptographic Details whitepaper.
generateRandomRequest - 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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetKeyPolicyResponse getKeyPolicy(GetKeyPolicyRequest getKeyPolicyRequest) throws NotFoundException, InvalidArnException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, SdkBaseException, SdkClientException, KMSException
Retrieves a policy attached to the specified key.
getKeyPolicyRequest - 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 CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetKeyRotationStatusResponse getKeyRotationStatus(GetKeyRotationStatusRequest getKeyRotationStatusRequest) throws NotFoundException, InvalidArnException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, UnsupportedOperationException, SdkBaseException, SdkClientException, KMSException
Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.
getKeyRotationStatusRequest - 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 CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
UnsupportedOperationException - The request was rejected because a specified parameter is not supported or a specified resource is not
valid for this operation.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typeUnsupportedOperationExceptiondefault GetParametersForImportResponse getParametersForImport(GetParametersForImportRequest getParametersForImportRequest) throws InvalidArnException, UnsupportedOperationException, DependencyTimeoutException, NotFoundException, KMSInternalException, KMSInvalidStateException, SdkBaseException, SdkClientException, KMSException
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 - The request was rejected because a specified ARN was not valid.UnsupportedOperationException - The request was rejected because a specified parameter is not supported or a specified resource is not
valid for this operation.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 CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typeUnsupportedOperationExceptiondefault ImportKeyMaterialResponse importKeyMaterial(ImportKeyMaterialRequest importKeyMaterialRequest) throws InvalidArnException, UnsupportedOperationException, DependencyTimeoutException, NotFoundException, KMSInternalException, KMSInvalidStateException, InvalidCiphertextException, IncorrectKeyMaterialException, ExpiredImportTokenException, InvalidImportTokenException, SdkBaseException, SdkClientException, KMSException
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 - The request was rejected because a specified ARN was not valid.UnsupportedOperationException - The request was rejected because a specified parameter is not supported or a specified resource is not
valid for this operation.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 CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
InvalidCiphertextException - The request was rejected because the specified ciphertext has been corrupted or is otherwise invalid.IncorrectKeyMaterialException - The request was rejected because the provided key material is invalid or is not the same key material
that was previously imported into this customer master key (CMK).ExpiredImportTokenException - The request was rejected because the provided import token is expired. Use GetParametersForImport
to retrieve a new import token and public key, use the new public key to encrypt the key material, and
then try the request again.InvalidImportTokenException - The request was rejected because the provided import token is invalid or is associated with a different
customer master key (CMK).SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typeUnsupportedOperationExceptiondefault ListAliasesResponse listAliases(ListAliasesRequest listAliasesRequest) throws DependencyTimeoutException, InvalidMarkerException, KMSInternalException, SdkBaseException, SdkClientException, KMSException
Lists all of the key aliases in the account.
listAliasesRequest - 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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListGrantsResponse listGrants(ListGrantsRequest listGrantsRequest) throws NotFoundException, DependencyTimeoutException, InvalidMarkerException, InvalidArnException, KMSInternalException, KMSInvalidStateException, SdkBaseException, SdkClientException, KMSException
List the grants for a specified key.
listGrantsRequest - 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 CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListKeyPoliciesResponse listKeyPolicies(ListKeyPoliciesRequest listKeyPoliciesRequest) throws NotFoundException, InvalidArnException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, SdkBaseException, SdkClientException, KMSException
Retrieves a list of policies attached to a key.
listKeyPoliciesRequest - 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 CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListKeysResponse listKeys(ListKeysRequest listKeysRequest) throws DependencyTimeoutException, KMSInternalException, InvalidMarkerException, SdkBaseException, SdkClientException, KMSException
Lists the customer master keys.
listKeysRequest - 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.InvalidMarkerException - The request was rejected because the marker that specifies where pagination should next begin is not
valid.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListResourceTagsResponse listResourceTags(ListResourceTagsRequest listResourceTagsRequest) throws KMSInternalException, NotFoundException, InvalidArnException, InvalidMarkerException, SdkBaseException, SdkClientException, KMSException
Returns a list of all tags for the specified customer master key (CMK).
listResourceTagsRequest - KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.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.InvalidMarkerException - The request was rejected because the marker that specifies where pagination should next begin is not
valid.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListRetirableGrantsResponse listRetirableGrants(ListRetirableGrantsRequest listRetirableGrantsRequest) throws DependencyTimeoutException, InvalidMarkerException, InvalidArnException, NotFoundException, KMSInternalException, SdkBaseException, SdkClientException, KMSException
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 - 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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault PutKeyPolicyResponse putKeyPolicy(PutKeyPolicyRequest putKeyPolicyRequest) throws NotFoundException, InvalidArnException, MalformedPolicyDocumentException, DependencyTimeoutException, UnsupportedOperationException, KMSInternalException, LimitExceededException, KMSInvalidStateException, SdkBaseException, SdkClientException, KMSException
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 - 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 or a specified resource is not
valid for this operation.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 CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typeUnsupportedOperationExceptiondefault ReEncryptResponse reEncrypt(ReEncryptRequest reEncryptRequest) throws NotFoundException, DisabledException, InvalidCiphertextException, KeyUnavailableException, DependencyTimeoutException, InvalidKeyUsageException, InvalidGrantTokenException, KMSInternalException, KMSInvalidStateException, SdkBaseException, SdkClientException, KMSException
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 - The request was rejected because the specified entity or resource could not be found.DisabledException - The request was rejected because the specified CMK is not enabled.InvalidCiphertextException - The request was rejected because the specified ciphertext has been corrupted or is otherwise invalid.KeyUnavailableException - The request was rejected because the specified CMK 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 value is not valid.InvalidGrantTokenException - The request was rejected because the specified grant token 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 CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RetireGrantResponse retireGrant(RetireGrantRequest retireGrantRequest) throws InvalidGrantTokenException, InvalidGrantIdException, NotFoundException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, SdkBaseException, SdkClientException, KMSException
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 - The request was rejected because the specified grant token is not valid.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 CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RevokeGrantResponse revokeGrant(RevokeGrantRequest revokeGrantRequest) throws NotFoundException, DependencyTimeoutException, InvalidArnException, InvalidGrantIdException, KMSInternalException, KMSInvalidStateException, SdkBaseException, SdkClientException, KMSException
Revokes a grant. You can revoke a grant to actively deny operations that depend on it.
revokeGrantRequest - 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 CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ScheduleKeyDeletionResponse scheduleKeyDeletion(ScheduleKeyDeletionRequest scheduleKeyDeletionRequest) throws NotFoundException, InvalidArnException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, SdkBaseException, SdkClientException, KMSException
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 - 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 CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws KMSInternalException, NotFoundException, InvalidArnException, KMSInvalidStateException, LimitExceededException, TagException, SdkBaseException, SdkClientException, KMSException
Adds or overwrites one or more tags for the specified customer master key (CMK).
Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
You cannot use the same tag key more than once per CMK. For example, consider a CMK with one tag whose tag key is
Purpose and tag value is Test. If you send a TagResource request for this
CMK with a tag key of Purpose and a tag value of Prod, it does not create a second tag.
Instead, the original tag is overwritten with the new tag value.
tagResourceRequest - KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.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.KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
LimitExceededException - The request was rejected because a limit was exceeded. For more information, see Limits in the AWS Key
Management Service Developer Guide.TagException - The request was rejected because one or more tags are not valid.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws KMSInternalException, NotFoundException, InvalidArnException, KMSInvalidStateException, TagException, SdkBaseException, SdkClientException, KMSException
Removes the specified tag or tags from the specified customer master key (CMK).
To remove a tag, you specify the tag key for each tag to remove. You do not specify the tag value. To overwrite the tag value for an existing tag, use TagResource.
untagResourceRequest - KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.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.KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
TagException - The request was rejected because one or more tags are not valid.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateAliasResponse updateAlias(UpdateAliasRequest updateAliasRequest) throws DependencyTimeoutException, NotFoundException, KMSInternalException, KMSInvalidStateException, SdkBaseException, SdkClientException, KMSException
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 - 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 CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateKeyDescriptionResponse updateKeyDescription(UpdateKeyDescriptionRequest updateKeyDescriptionRequest) throws NotFoundException, InvalidArnException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, SdkBaseException, SdkClientException, KMSException
Updates the description of a customer master key (CMK).
updateKeyDescriptionRequest - 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 CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)KMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typestatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.