@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSKMSAsync extends AbstractAWSKMS implements AWSKMSAsync
AWSKMSAsync. Convenient method forms pass through to the corresponding overload
that takes a request object and an AsyncHandler, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier | Constructor and Description |
|---|---|
protected |
AbstractAWSKMSAsync() |
cancelKeyDeletion, createAlias, createGrant, createKey, createKey, decrypt, deleteAlias, deleteImportedKeyMaterial, describeKey, disableKey, disableKeyRotation, enableKey, enableKeyRotation, encrypt, generateDataKey, generateDataKeyWithoutPlaintext, generateRandom, generateRandom, getCachedResponseMetadata, getKeyPolicy, getKeyRotationStatus, getParametersForImport, importKeyMaterial, listAliases, listAliases, listGrants, listKeyPolicies, listKeys, listKeys, listResourceTags, listRetirableGrants, putKeyPolicy, reEncrypt, retireGrant, retireGrant, revokeGrant, scheduleKeyDeletion, setEndpoint, setRegion, shutdown, tagResource, untagResource, updateAlias, updateKeyDescriptionclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcancelKeyDeletion, createAlias, createGrant, createKey, createKey, decrypt, deleteAlias, deleteImportedKeyMaterial, describeKey, disableKey, disableKeyRotation, enableKey, enableKeyRotation, encrypt, generateDataKey, generateDataKeyWithoutPlaintext, generateRandom, generateRandom, getCachedResponseMetadata, getKeyPolicy, getKeyRotationStatus, getParametersForImport, importKeyMaterial, listAliases, listAliases, listGrants, listKeyPolicies, listKeys, listKeys, listResourceTags, listRetirableGrants, putKeyPolicy, reEncrypt, retireGrant, retireGrant, revokeGrant, scheduleKeyDeletion, setEndpoint, setRegion, shutdown, tagResource, untagResource, updateAlias, updateKeyDescriptionpublic Future<CancelKeyDeletionResult> cancelKeyDeletionAsync(CancelKeyDeletionRequest request)
AWSKMSAsync
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.
cancelKeyDeletionAsync in interface AWSKMSAsyncpublic Future<CancelKeyDeletionResult> cancelKeyDeletionAsync(CancelKeyDeletionRequest request, AsyncHandler<CancelKeyDeletionRequest,CancelKeyDeletionResult> asyncHandler)
AWSKMSAsync
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.
cancelKeyDeletionAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateAliasResult> createAliasAsync(CreateAliasRequest request)
AWSKMSAsyncCreates 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.
createAliasAsync in interface AWSKMSAsyncpublic Future<CreateAliasResult> createAliasAsync(CreateAliasRequest request, AsyncHandler<CreateAliasRequest,CreateAliasResult> asyncHandler)
AWSKMSAsyncCreates 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.
createAliasAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateGrantResult> createGrantAsync(CreateGrantRequest request)
AWSKMSAsyncAdds 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.
createGrantAsync in interface AWSKMSAsyncpublic Future<CreateGrantResult> createGrantAsync(CreateGrantRequest request, AsyncHandler<CreateGrantRequest,CreateGrantResult> asyncHandler)
AWSKMSAsyncAdds 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.
createGrantAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateKeyResult> createKeyAsync(CreateKeyRequest request)
AWSKMSAsyncCreates 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
createKeyAsync in interface AWSKMSAsyncpublic Future<CreateKeyResult> createKeyAsync(CreateKeyRequest request, AsyncHandler<CreateKeyRequest,CreateKeyResult> asyncHandler)
AWSKMSAsyncCreates 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
createKeyAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateKeyResult> createKeyAsync()
createKeyAsync in interface AWSKMSAsynccreateKeyAsync(CreateKeyRequest)public Future<CreateKeyResult> createKeyAsync(AsyncHandler<CreateKeyRequest,CreateKeyResult> asyncHandler)
createKeyAsync in interface AWSKMSAsynccreateKeyAsync(CreateKeyRequest, com.amazonaws.handlers.AsyncHandler)public Future<DecryptResult> decryptAsync(DecryptRequest request)
AWSKMSAsyncDecrypts 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.
decryptAsync in interface AWSKMSAsyncpublic Future<DecryptResult> decryptAsync(DecryptRequest request, AsyncHandler<DecryptRequest,DecryptResult> asyncHandler)
AWSKMSAsyncDecrypts 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.
decryptAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteAliasResult> deleteAliasAsync(DeleteAliasRequest request)
AWSKMSAsyncDeletes the specified alias. To map an alias to a different key, call UpdateAlias.
deleteAliasAsync in interface AWSKMSAsyncpublic Future<DeleteAliasResult> deleteAliasAsync(DeleteAliasRequest request, AsyncHandler<DeleteAliasRequest,DeleteAliasResult> asyncHandler)
AWSKMSAsyncDeletes the specified alias. To map an alias to a different key, call UpdateAlias.
deleteAliasAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteImportedKeyMaterialResult> deleteImportedKeyMaterialAsync(DeleteImportedKeyMaterialRequest request)
AWSKMSAsyncDeletes 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.
deleteImportedKeyMaterialAsync in interface AWSKMSAsyncpublic Future<DeleteImportedKeyMaterialResult> deleteImportedKeyMaterialAsync(DeleteImportedKeyMaterialRequest request, AsyncHandler<DeleteImportedKeyMaterialRequest,DeleteImportedKeyMaterialResult> asyncHandler)
AWSKMSAsyncDeletes 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.
deleteImportedKeyMaterialAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeKeyResult> describeKeyAsync(DescribeKeyRequest request)
AWSKMSAsyncProvides detailed information about the specified customer master key.
describeKeyAsync in interface AWSKMSAsyncpublic Future<DescribeKeyResult> describeKeyAsync(DescribeKeyRequest request, AsyncHandler<DescribeKeyRequest,DescribeKeyResult> asyncHandler)
AWSKMSAsyncProvides detailed information about the specified customer master key.
describeKeyAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DisableKeyResult> disableKeyAsync(DisableKeyRequest request)
AWSKMSAsyncSets 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.
disableKeyAsync in interface AWSKMSAsyncpublic Future<DisableKeyResult> disableKeyAsync(DisableKeyRequest request, AsyncHandler<DisableKeyRequest,DisableKeyResult> asyncHandler)
AWSKMSAsyncSets 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.
disableKeyAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DisableKeyRotationResult> disableKeyRotationAsync(DisableKeyRotationRequest request)
AWSKMSAsyncDisables rotation of the specified key.
disableKeyRotationAsync in interface AWSKMSAsyncpublic Future<DisableKeyRotationResult> disableKeyRotationAsync(DisableKeyRotationRequest request, AsyncHandler<DisableKeyRotationRequest,DisableKeyRotationResult> asyncHandler)
AWSKMSAsyncDisables rotation of the specified key.
disableKeyRotationAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<EnableKeyResult> enableKeyAsync(EnableKeyRequest request)
AWSKMSAsyncMarks a key as enabled, thereby permitting its use.
enableKeyAsync in interface AWSKMSAsyncpublic Future<EnableKeyResult> enableKeyAsync(EnableKeyRequest request, AsyncHandler<EnableKeyRequest,EnableKeyResult> asyncHandler)
AWSKMSAsyncMarks a key as enabled, thereby permitting its use.
enableKeyAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<EnableKeyRotationResult> enableKeyRotationAsync(EnableKeyRotationRequest request)
AWSKMSAsyncEnables rotation of the specified customer master key.
enableKeyRotationAsync in interface AWSKMSAsyncpublic Future<EnableKeyRotationResult> enableKeyRotationAsync(EnableKeyRotationRequest request, AsyncHandler<EnableKeyRotationRequest,EnableKeyRotationResult> asyncHandler)
AWSKMSAsyncEnables rotation of the specified customer master key.
enableKeyRotationAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<EncryptResult> encryptAsync(EncryptRequest request)
AWSKMSAsync
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.
encryptAsync in interface AWSKMSAsyncpublic Future<EncryptResult> encryptAsync(EncryptRequest request, AsyncHandler<EncryptRequest,EncryptResult> asyncHandler)
AWSKMSAsync
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.
encryptAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GenerateDataKeyResult> generateDataKeyAsync(GenerateDataKeyRequest request)
AWSKMSAsyncReturns 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.
generateDataKeyAsync in interface AWSKMSAsyncpublic Future<GenerateDataKeyResult> generateDataKeyAsync(GenerateDataKeyRequest request, AsyncHandler<GenerateDataKeyRequest,GenerateDataKeyResult> asyncHandler)
AWSKMSAsyncReturns 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.
generateDataKeyAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GenerateDataKeyWithoutPlaintextResult> generateDataKeyWithoutPlaintextAsync(GenerateDataKeyWithoutPlaintextRequest request)
AWSKMSAsyncReturns 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.
generateDataKeyWithoutPlaintextAsync in interface AWSKMSAsyncpublic Future<GenerateDataKeyWithoutPlaintextResult> generateDataKeyWithoutPlaintextAsync(GenerateDataKeyWithoutPlaintextRequest request, AsyncHandler<GenerateDataKeyWithoutPlaintextRequest,GenerateDataKeyWithoutPlaintextResult> asyncHandler)
AWSKMSAsyncReturns 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.
generateDataKeyWithoutPlaintextAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GenerateRandomResult> generateRandomAsync(GenerateRandomRequest request)
AWSKMSAsyncReturns 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.
generateRandomAsync in interface AWSKMSAsyncpublic Future<GenerateRandomResult> generateRandomAsync(GenerateRandomRequest request, AsyncHandler<GenerateRandomRequest,GenerateRandomResult> asyncHandler)
AWSKMSAsyncReturns 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.
generateRandomAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GenerateRandomResult> generateRandomAsync()
generateRandomAsync in interface AWSKMSAsyncgenerateRandomAsync(GenerateRandomRequest)public Future<GenerateRandomResult> generateRandomAsync(AsyncHandler<GenerateRandomRequest,GenerateRandomResult> asyncHandler)
generateRandomAsync in interface AWSKMSAsyncgenerateRandomAsync(GenerateRandomRequest, com.amazonaws.handlers.AsyncHandler)public Future<GetKeyPolicyResult> getKeyPolicyAsync(GetKeyPolicyRequest request)
AWSKMSAsyncRetrieves a policy attached to the specified key.
getKeyPolicyAsync in interface AWSKMSAsyncpublic Future<GetKeyPolicyResult> getKeyPolicyAsync(GetKeyPolicyRequest request, AsyncHandler<GetKeyPolicyRequest,GetKeyPolicyResult> asyncHandler)
AWSKMSAsyncRetrieves a policy attached to the specified key.
getKeyPolicyAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetKeyRotationStatusResult> getKeyRotationStatusAsync(GetKeyRotationStatusRequest request)
AWSKMSAsyncRetrieves a Boolean value that indicates whether key rotation is enabled for the specified key.
getKeyRotationStatusAsync in interface AWSKMSAsyncpublic Future<GetKeyRotationStatusResult> getKeyRotationStatusAsync(GetKeyRotationStatusRequest request, AsyncHandler<GetKeyRotationStatusRequest,GetKeyRotationStatusResult> asyncHandler)
AWSKMSAsyncRetrieves a Boolean value that indicates whether key rotation is enabled for the specified key.
getKeyRotationStatusAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetParametersForImportResult> getParametersForImportAsync(GetParametersForImportRequest request)
AWSKMSAsyncReturns 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.
getParametersForImportAsync in interface AWSKMSAsyncpublic Future<GetParametersForImportResult> getParametersForImportAsync(GetParametersForImportRequest request, AsyncHandler<GetParametersForImportRequest,GetParametersForImportResult> asyncHandler)
AWSKMSAsyncReturns 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.
getParametersForImportAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ImportKeyMaterialResult> importKeyMaterialAsync(ImportKeyMaterialRequest request)
AWSKMSAsyncImports 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.
importKeyMaterialAsync in interface AWSKMSAsyncpublic Future<ImportKeyMaterialResult> importKeyMaterialAsync(ImportKeyMaterialRequest request, AsyncHandler<ImportKeyMaterialRequest,ImportKeyMaterialResult> asyncHandler)
AWSKMSAsyncImports 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.
importKeyMaterialAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListAliasesResult> listAliasesAsync(ListAliasesRequest request)
AWSKMSAsyncLists all of the key aliases in the account.
listAliasesAsync in interface AWSKMSAsyncpublic Future<ListAliasesResult> listAliasesAsync(ListAliasesRequest request, AsyncHandler<ListAliasesRequest,ListAliasesResult> asyncHandler)
AWSKMSAsyncLists all of the key aliases in the account.
listAliasesAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListAliasesResult> listAliasesAsync()
listAliasesAsync in interface AWSKMSAsynclistAliasesAsync(ListAliasesRequest)public Future<ListAliasesResult> listAliasesAsync(AsyncHandler<ListAliasesRequest,ListAliasesResult> asyncHandler)
listAliasesAsync in interface AWSKMSAsynclistAliasesAsync(ListAliasesRequest, com.amazonaws.handlers.AsyncHandler)public Future<ListGrantsResult> listGrantsAsync(ListGrantsRequest request)
AWSKMSAsyncList the grants for a specified key.
listGrantsAsync in interface AWSKMSAsyncpublic Future<ListGrantsResult> listGrantsAsync(ListGrantsRequest request, AsyncHandler<ListGrantsRequest,ListGrantsResult> asyncHandler)
AWSKMSAsyncList the grants for a specified key.
listGrantsAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListKeyPoliciesResult> listKeyPoliciesAsync(ListKeyPoliciesRequest request)
AWSKMSAsyncRetrieves a list of policies attached to a key.
listKeyPoliciesAsync in interface AWSKMSAsyncpublic Future<ListKeyPoliciesResult> listKeyPoliciesAsync(ListKeyPoliciesRequest request, AsyncHandler<ListKeyPoliciesRequest,ListKeyPoliciesResult> asyncHandler)
AWSKMSAsyncRetrieves a list of policies attached to a key.
listKeyPoliciesAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListKeysResult> listKeysAsync(ListKeysRequest request)
AWSKMSAsyncLists the customer master keys.
listKeysAsync in interface AWSKMSAsyncpublic Future<ListKeysResult> listKeysAsync(ListKeysRequest request, AsyncHandler<ListKeysRequest,ListKeysResult> asyncHandler)
AWSKMSAsyncLists the customer master keys.
listKeysAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListKeysResult> listKeysAsync()
listKeysAsync in interface AWSKMSAsynclistKeysAsync(ListKeysRequest)public Future<ListKeysResult> listKeysAsync(AsyncHandler<ListKeysRequest,ListKeysResult> asyncHandler)
listKeysAsync in interface AWSKMSAsynclistKeysAsync(ListKeysRequest, com.amazonaws.handlers.AsyncHandler)public Future<ListResourceTagsResult> listResourceTagsAsync(ListResourceTagsRequest request)
AWSKMSAsyncReturns a list of all tags for the specified customer master key (CMK).
listResourceTagsAsync in interface AWSKMSAsyncpublic Future<ListResourceTagsResult> listResourceTagsAsync(ListResourceTagsRequest request, AsyncHandler<ListResourceTagsRequest,ListResourceTagsResult> asyncHandler)
AWSKMSAsyncReturns a list of all tags for the specified customer master key (CMK).
listResourceTagsAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListRetirableGrantsResult> listRetirableGrantsAsync(ListRetirableGrantsRequest request)
AWSKMSAsync
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.
listRetirableGrantsAsync in interface AWSKMSAsyncpublic Future<ListRetirableGrantsResult> listRetirableGrantsAsync(ListRetirableGrantsRequest request, AsyncHandler<ListRetirableGrantsRequest,ListRetirableGrantsResult> asyncHandler)
AWSKMSAsync
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.
listRetirableGrantsAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutKeyPolicyResult> putKeyPolicyAsync(PutKeyPolicyRequest request)
AWSKMSAsyncAttaches 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.
putKeyPolicyAsync in interface AWSKMSAsyncpublic Future<PutKeyPolicyResult> putKeyPolicyAsync(PutKeyPolicyRequest request, AsyncHandler<PutKeyPolicyRequest,PutKeyPolicyResult> asyncHandler)
AWSKMSAsyncAttaches 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.
putKeyPolicyAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ReEncryptResult> reEncryptAsync(ReEncryptRequest request)
AWSKMSAsyncEncrypts 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.
reEncryptAsync in interface AWSKMSAsyncpublic Future<ReEncryptResult> reEncryptAsync(ReEncryptRequest request, AsyncHandler<ReEncryptRequest,ReEncryptResult> asyncHandler)
AWSKMSAsyncEncrypts 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.
reEncryptAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RetireGrantResult> retireGrantAsync(RetireGrantRequest request)
AWSKMSAsyncRetires 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.
retireGrantAsync in interface AWSKMSAsyncpublic Future<RetireGrantResult> retireGrantAsync(RetireGrantRequest request, AsyncHandler<RetireGrantRequest,RetireGrantResult> asyncHandler)
AWSKMSAsyncRetires 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.
retireGrantAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RetireGrantResult> retireGrantAsync()
retireGrantAsync in interface AWSKMSAsyncretireGrantAsync(RetireGrantRequest)public Future<RetireGrantResult> retireGrantAsync(AsyncHandler<RetireGrantRequest,RetireGrantResult> asyncHandler)
retireGrantAsync in interface AWSKMSAsyncretireGrantAsync(RetireGrantRequest, com.amazonaws.handlers.AsyncHandler)public Future<RevokeGrantResult> revokeGrantAsync(RevokeGrantRequest request)
AWSKMSAsyncRevokes a grant. You can revoke a grant to actively deny operations that depend on it.
revokeGrantAsync in interface AWSKMSAsyncpublic Future<RevokeGrantResult> revokeGrantAsync(RevokeGrantRequest request, AsyncHandler<RevokeGrantRequest,RevokeGrantResult> asyncHandler)
AWSKMSAsyncRevokes a grant. You can revoke a grant to actively deny operations that depend on it.
revokeGrantAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ScheduleKeyDeletionResult> scheduleKeyDeletionAsync(ScheduleKeyDeletionRequest request)
AWSKMSAsync
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.
scheduleKeyDeletionAsync in interface AWSKMSAsyncpublic Future<ScheduleKeyDeletionResult> scheduleKeyDeletionAsync(ScheduleKeyDeletionRequest request, AsyncHandler<ScheduleKeyDeletionRequest,ScheduleKeyDeletionResult> asyncHandler)
AWSKMSAsync
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.
scheduleKeyDeletionAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AWSKMSAsyncAdds 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.
tagResourceAsync in interface AWSKMSAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AWSKMSAsyncAdds 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.
tagResourceAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AWSKMSAsyncRemoves 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.
untagResourceAsync in interface AWSKMSAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AWSKMSAsyncRemoves 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.
untagResourceAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateAliasResult> updateAliasAsync(UpdateAliasRequest request)
AWSKMSAsyncUpdates 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.
updateAliasAsync in interface AWSKMSAsyncpublic Future<UpdateAliasResult> updateAliasAsync(UpdateAliasRequest request, AsyncHandler<UpdateAliasRequest,UpdateAliasResult> asyncHandler)
AWSKMSAsyncUpdates 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.
updateAliasAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateKeyDescriptionResult> updateKeyDescriptionAsync(UpdateKeyDescriptionRequest request)
AWSKMSAsyncUpdates the description of a customer master key (CMK).
updateKeyDescriptionAsync in interface AWSKMSAsyncpublic Future<UpdateKeyDescriptionResult> updateKeyDescriptionAsync(UpdateKeyDescriptionRequest request, AsyncHandler<UpdateKeyDescriptionRequest,UpdateKeyDescriptionResult> asyncHandler)
AWSKMSAsyncUpdates the description of a customer master key (CMK).
updateKeyDescriptionAsync in interface AWSKMSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Copyright © 2017. All rights reserved.