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.| Modifier and Type | Method and Description |
|---|---|
Future<CancelKeyDeletionResult> |
cancelKeyDeletionAsync(CancelKeyDeletionRequest request)
Cancels the deletion of a customer master key (CMK).
|
Future<CancelKeyDeletionResult> |
cancelKeyDeletionAsync(CancelKeyDeletionRequest request,
AsyncHandler<CancelKeyDeletionRequest,CancelKeyDeletionResult> asyncHandler)
Cancels the deletion of a customer master key (CMK).
|
Future<Void> |
createAliasAsync(CreateAliasRequest request)
Creates a display name for a customer master key.
|
Future<Void> |
createAliasAsync(CreateAliasRequest request,
AsyncHandler<CreateAliasRequest,Void> asyncHandler)
Creates a display name for a customer master key.
|
Future<CreateGrantResult> |
createGrantAsync(CreateGrantRequest request)
Adds a grant to a key to specify who can use the key and under what
conditions.
|
Future<CreateGrantResult> |
createGrantAsync(CreateGrantRequest request,
AsyncHandler<CreateGrantRequest,CreateGrantResult> asyncHandler)
Adds a grant to a key to specify who can use the key and under what
conditions.
|
Future<CreateKeyResult> |
createKeyAsync()
Simplified method form for invoking the CreateKey operation.
|
Future<CreateKeyResult> |
createKeyAsync(AsyncHandler<CreateKeyRequest,CreateKeyResult> asyncHandler)
Simplified method form for invoking the CreateKey operation with an
AsyncHandler.
|
Future<CreateKeyResult> |
createKeyAsync(CreateKeyRequest request)
Creates a customer master key.
|
Future<CreateKeyResult> |
createKeyAsync(CreateKeyRequest request,
AsyncHandler<CreateKeyRequest,CreateKeyResult> asyncHandler)
Creates a customer master key.
|
Future<DecryptResult> |
decryptAsync(DecryptRequest request)
Decrypts ciphertext.
|
Future<DecryptResult> |
decryptAsync(DecryptRequest request,
AsyncHandler<DecryptRequest,DecryptResult> asyncHandler)
Decrypts ciphertext.
|
Future<Void> |
deleteAliasAsync(DeleteAliasRequest request)
Deletes the specified alias.
|
Future<Void> |
deleteAliasAsync(DeleteAliasRequest request,
AsyncHandler<DeleteAliasRequest,Void> asyncHandler)
Deletes the specified alias.
|
Future<DescribeKeyResult> |
describeKeyAsync(DescribeKeyRequest request)
Provides detailed information about the specified customer master key.
|
Future<DescribeKeyResult> |
describeKeyAsync(DescribeKeyRequest request,
AsyncHandler<DescribeKeyRequest,DescribeKeyResult> asyncHandler)
Provides detailed information about the specified customer master key.
|
Future<Void> |
disableKeyAsync(DisableKeyRequest request)
Sets the state of a master key to disabled, thereby preventing its use
for cryptographic operations.
|
Future<Void> |
disableKeyAsync(DisableKeyRequest request,
AsyncHandler<DisableKeyRequest,Void> asyncHandler)
Sets the state of a master key to disabled, thereby preventing its use
for cryptographic operations.
|
Future<Void> |
disableKeyRotationAsync(DisableKeyRotationRequest request)
Disables rotation of the specified key.
|
Future<Void> |
disableKeyRotationAsync(DisableKeyRotationRequest request,
AsyncHandler<DisableKeyRotationRequest,Void> asyncHandler)
Disables rotation of the specified key.
|
Future<Void> |
enableKeyAsync(EnableKeyRequest request)
Marks a key as enabled, thereby permitting its use.
|
Future<Void> |
enableKeyAsync(EnableKeyRequest request,
AsyncHandler<EnableKeyRequest,Void> asyncHandler)
Marks a key as enabled, thereby permitting its use.
|
Future<Void> |
enableKeyRotationAsync(EnableKeyRotationRequest request)
Enables rotation of the specified customer master key.
|
Future<Void> |
enableKeyRotationAsync(EnableKeyRotationRequest request,
AsyncHandler<EnableKeyRotationRequest,Void> asyncHandler)
Enables rotation of the specified customer master key.
|
Future<EncryptResult> |
encryptAsync(EncryptRequest request)
Encrypts plaintext into ciphertext by using a customer master key.
|
Future<EncryptResult> |
encryptAsync(EncryptRequest request,
AsyncHandler<EncryptRequest,EncryptResult> asyncHandler)
Encrypts plaintext into ciphertext by using a customer master key.
|
Future<GenerateDataKeyResult> |
generateDataKeyAsync(GenerateDataKeyRequest request)
Generates a data key that you can use in your application to locally
encrypt data.
|
Future<GenerateDataKeyResult> |
generateDataKeyAsync(GenerateDataKeyRequest request,
AsyncHandler<GenerateDataKeyRequest,GenerateDataKeyResult> asyncHandler)
Generates a data key that you can use in your application to locally
encrypt data.
|
Future<GenerateDataKeyWithoutPlaintextResult> |
generateDataKeyWithoutPlaintextAsync(GenerateDataKeyWithoutPlaintextRequest request)
Returns a data key encrypted by a customer master key without the
plaintext copy of that key.
|
Future<GenerateDataKeyWithoutPlaintextResult> |
generateDataKeyWithoutPlaintextAsync(GenerateDataKeyWithoutPlaintextRequest request,
AsyncHandler<GenerateDataKeyWithoutPlaintextRequest,GenerateDataKeyWithoutPlaintextResult> asyncHandler)
Returns a data key encrypted by a customer master key without the
plaintext copy of that key.
|
Future<GenerateRandomResult> |
generateRandomAsync()
Simplified method form for invoking the GenerateRandom operation.
|
Future<GenerateRandomResult> |
generateRandomAsync(AsyncHandler<GenerateRandomRequest,GenerateRandomResult> asyncHandler)
Simplified method form for invoking the GenerateRandom operation with an
AsyncHandler.
|
Future<GenerateRandomResult> |
generateRandomAsync(GenerateRandomRequest request)
Generates an unpredictable byte string.
|
Future<GenerateRandomResult> |
generateRandomAsync(GenerateRandomRequest request,
AsyncHandler<GenerateRandomRequest,GenerateRandomResult> asyncHandler)
Generates an unpredictable byte string.
|
Future<GetKeyPolicyResult> |
getKeyPolicyAsync(GetKeyPolicyRequest request)
Retrieves a policy attached to the specified key.
|
Future<GetKeyPolicyResult> |
getKeyPolicyAsync(GetKeyPolicyRequest request,
AsyncHandler<GetKeyPolicyRequest,GetKeyPolicyResult> asyncHandler)
Retrieves a policy attached to the specified key.
|
Future<GetKeyRotationStatusResult> |
getKeyRotationStatusAsync(GetKeyRotationStatusRequest request)
Retrieves a Boolean value that indicates whether key rotation is enabled
for the specified key.
|
Future<GetKeyRotationStatusResult> |
getKeyRotationStatusAsync(GetKeyRotationStatusRequest request,
AsyncHandler<GetKeyRotationStatusRequest,GetKeyRotationStatusResult> asyncHandler)
Retrieves a Boolean value that indicates whether key rotation is enabled
for the specified key.
|
Future<ListAliasesResult> |
listAliasesAsync()
Simplified method form for invoking the ListAliases operation.
|
Future<ListAliasesResult> |
listAliasesAsync(AsyncHandler<ListAliasesRequest,ListAliasesResult> asyncHandler)
Simplified method form for invoking the ListAliases operation with an
AsyncHandler.
|
Future<ListAliasesResult> |
listAliasesAsync(ListAliasesRequest request)
Lists all of the key aliases in the account.
|
Future<ListAliasesResult> |
listAliasesAsync(ListAliasesRequest request,
AsyncHandler<ListAliasesRequest,ListAliasesResult> asyncHandler)
Lists all of the key aliases in the account.
|
Future<ListGrantsResult> |
listGrantsAsync(ListGrantsRequest request)
List the grants for a specified key.
|
Future<ListGrantsResult> |
listGrantsAsync(ListGrantsRequest request,
AsyncHandler<ListGrantsRequest,ListGrantsResult> asyncHandler)
List the grants for a specified key.
|
Future<ListKeyPoliciesResult> |
listKeyPoliciesAsync(ListKeyPoliciesRequest request)
Retrieves a list of policies attached to a key.
|
Future<ListKeyPoliciesResult> |
listKeyPoliciesAsync(ListKeyPoliciesRequest request,
AsyncHandler<ListKeyPoliciesRequest,ListKeyPoliciesResult> asyncHandler)
Retrieves a list of policies attached to a key.
|
Future<ListKeysResult> |
listKeysAsync()
Simplified method form for invoking the ListKeys operation.
|
Future<ListKeysResult> |
listKeysAsync(AsyncHandler<ListKeysRequest,ListKeysResult> asyncHandler)
Simplified method form for invoking the ListKeys operation with an
AsyncHandler.
|
Future<ListKeysResult> |
listKeysAsync(ListKeysRequest request)
Lists the customer master keys.
|
Future<ListKeysResult> |
listKeysAsync(ListKeysRequest request,
AsyncHandler<ListKeysRequest,ListKeysResult> asyncHandler)
Lists the customer master keys.
|
Future<ListRetirableGrantsResult> |
listRetirableGrantsAsync(ListRetirableGrantsRequest request)
Returns a list of all grants for which the grant's
RetiringPrincipal matches the one specified. |
Future<ListRetirableGrantsResult> |
listRetirableGrantsAsync(ListRetirableGrantsRequest request,
AsyncHandler<ListRetirableGrantsRequest,ListRetirableGrantsResult> asyncHandler)
Returns a list of all grants for which the grant's
RetiringPrincipal matches the one specified. |
Future<Void> |
putKeyPolicyAsync(PutKeyPolicyRequest request)
Attaches a policy to the specified key.
|
Future<Void> |
putKeyPolicyAsync(PutKeyPolicyRequest request,
AsyncHandler<PutKeyPolicyRequest,Void> asyncHandler)
Attaches a policy to the specified key.
|
Future<ReEncryptResult> |
reEncryptAsync(ReEncryptRequest request)
Encrypts data on the server side with a new customer master key without
exposing the plaintext of the data on the client side.
|
Future<ReEncryptResult> |
reEncryptAsync(ReEncryptRequest request,
AsyncHandler<ReEncryptRequest,ReEncryptResult> asyncHandler)
Encrypts data on the server side with a new customer master key without
exposing the plaintext of the data on the client side.
|
Future<Void> |
retireGrantAsync()
Simplified method form for invoking the RetireGrant operation.
|
Future<Void> |
retireGrantAsync(AsyncHandler<RetireGrantRequest,Void> asyncHandler)
Simplified method form for invoking the RetireGrant operation with an
AsyncHandler.
|
Future<Void> |
retireGrantAsync(RetireGrantRequest request)
Retires a grant.
|
Future<Void> |
retireGrantAsync(RetireGrantRequest request,
AsyncHandler<RetireGrantRequest,Void> asyncHandler)
Retires a grant.
|
Future<Void> |
revokeGrantAsync(RevokeGrantRequest request)
Revokes a grant.
|
Future<Void> |
revokeGrantAsync(RevokeGrantRequest request,
AsyncHandler<RevokeGrantRequest,Void> asyncHandler)
Revokes a grant.
|
Future<ScheduleKeyDeletionResult> |
scheduleKeyDeletionAsync(ScheduleKeyDeletionRequest request)
Schedules the deletion of a customer master key (CMK).
|
Future<ScheduleKeyDeletionResult> |
scheduleKeyDeletionAsync(ScheduleKeyDeletionRequest request,
AsyncHandler<ScheduleKeyDeletionRequest,ScheduleKeyDeletionResult> asyncHandler)
Schedules the deletion of a customer master key (CMK).
|
Future<Void> |
updateAliasAsync(UpdateAliasRequest request)
Updates an alias to map it to a different key.
|
Future<Void> |
updateAliasAsync(UpdateAliasRequest request,
AsyncHandler<UpdateAliasRequest,Void> asyncHandler)
Updates an alias to map it to a different key.
|
Future<Void> |
updateKeyDescriptionAsync(UpdateKeyDescriptionRequest request)
Updates the description of a key.
|
Future<Void> |
updateKeyDescriptionAsync(UpdateKeyDescriptionRequest request,
AsyncHandler<UpdateKeyDescriptionRequest,Void> asyncHandler)
Updates the description of a key.
|
cancelKeyDeletion, createAlias, createGrant, createKey, createKey, decrypt, deleteAlias, describeKey, disableKey, disableKeyRotation, enableKey, enableKeyRotation, encrypt, generateDataKey, generateDataKeyWithoutPlaintext, generateRandom, generateRandom, getCachedResponseMetadata, getKeyPolicy, getKeyRotationStatus, listAliases, listAliases, listGrants, listKeyPolicies, listKeys, listKeys, listRetirableGrants, putKeyPolicy, reEncrypt, retireGrant, retireGrant, revokeGrant, scheduleKeyDeletion, setEndpoint, setRegion, shutdown, updateAlias, updateKeyDescriptionequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcancelKeyDeletion, createAlias, createGrant, createKey, createKey, decrypt, deleteAlias, describeKey, disableKey, disableKeyRotation, enableKey, enableKeyRotation, encrypt, generateDataKey, generateDataKeyWithoutPlaintext, generateRandom, generateRandom, getCachedResponseMetadata, getKeyPolicy, getKeyRotationStatus, listAliases, listAliases, listGrants, listKeyPolicies, listKeys, listKeys, listRetirableGrants, putKeyPolicy, reEncrypt, retireGrant, retireGrant, revokeGrant, scheduleKeyDeletion, setEndpoint, setRegion, shutdown, 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, go to 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, go to 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<Void> 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<Void> createAliasAsync(CreateAliasRequest request, AsyncHandler<CreateAliasRequest,Void> 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. Customer master keys can be used to encrypt small amounts of data (less than 4K) directly, but they are most commonly used to encrypt or envelope data keys that are then used to encrypt customer data. For more information about data keys, see GenerateDataKey and GenerateDataKeyWithoutPlaintext.
createKeyAsync in interface AWSKMSAsyncpublic Future<CreateKeyResult> createKeyAsync(CreateKeyRequest request, AsyncHandler<CreateKeyRequest,CreateKeyResult> asyncHandler)
AWSKMSAsyncCreates a customer master key. Customer master keys can be used to encrypt small amounts of data (less than 4K) directly, but they are most commonly used to encrypt or envelope data keys that are then used to encrypt customer data. For more information about data keys, see GenerateDataKey and GenerateDataKeyWithoutPlaintext.
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<Void> deleteAliasAsync(DeleteAliasRequest request)
AWSKMSAsyncDeletes the specified alias. To map an alias to a different key, call UpdateAlias.
deleteAliasAsync in interface AWSKMSAsyncpublic Future<Void> deleteAliasAsync(DeleteAliasRequest request, AsyncHandler<DeleteAliasRequest,Void> 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<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<Void> disableKeyAsync(DisableKeyRequest request)
AWSKMSAsyncSets the state of a master key to disabled, thereby preventing its use for cryptographic operations. For more information about how key state affects the use of a master key, go to How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
disableKeyAsync in interface AWSKMSAsyncpublic Future<Void> disableKeyAsync(DisableKeyRequest request, AsyncHandler<DisableKeyRequest,Void> asyncHandler)
AWSKMSAsyncSets the state of a master key to disabled, thereby preventing its use for cryptographic operations. For more information about how key state affects the use of a master key, go to 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<Void> disableKeyRotationAsync(DisableKeyRotationRequest request)
AWSKMSAsyncDisables rotation of the specified key.
disableKeyRotationAsync in interface AWSKMSAsyncpublic Future<Void> disableKeyRotationAsync(DisableKeyRotationRequest request, AsyncHandler<DisableKeyRotationRequest,Void> 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<Void> enableKeyAsync(EnableKeyRequest request)
AWSKMSAsyncMarks a key as enabled, thereby permitting its use.
enableKeyAsync in interface AWSKMSAsyncpublic Future<Void> enableKeyAsync(EnableKeyRequest request, AsyncHandler<EnableKeyRequest,Void> 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<Void> enableKeyRotationAsync(EnableKeyRotationRequest request)
AWSKMSAsyncEnables rotation of the specified customer master key.
enableKeyRotationAsync in interface AWSKMSAsyncpublic Future<Void> enableKeyRotationAsync(EnableKeyRotationRequest request, AsyncHandler<EnableKeyRotationRequest,Void> 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:
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:
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)
AWSKMSAsync
Generates a data key that you can use in your application to locally
encrypt data. This call returns a plaintext version of the key in the
Plaintext field of the response object and an encrypted copy
of the key in the CiphertextBlob field. The key is encrypted
by using the master key specified by the KeyId field. To
decrypt the encrypted key, pass it to the Decrypt API.
We recommend that you use the following pattern to locally encrypt data:
call the GenerateDataKey API, use the key returned in the
Plaintext response field to locally encrypt data, and then
erase the plaintext data key from memory. Store the encrypted data key
(contained in the CiphertextBlob field) alongside of the
locally encrypted data.
Encrypt function to re-encrypt
your data keys within a region. GenerateDataKey always
returns the data key encrypted and tied to the customer master key that
will be used to decrypt it. There is no need to decrypt it twice.
If you decide to use the optional EncryptionContext
parameter, you must also store the context in full or at least store
enough information along with the encrypted data to be able to
reconstruct the context when submitting the ciphertext to the
Decrypt API. It is a good practice to choose a context that
you can reconstruct on the fly to better secure the ciphertext. For more
information about how this parameter is used, see Encryption Context.
To decrypt data, pass the encrypted data key to the Decrypt
API. Decrypt uses the associated master key to decrypt the
encrypted data key and returns it as plaintext. Use the plaintext data
key to locally decrypt your data and then erase the key from memory. You
must specify the encryption context, if any, that you specified when you
generated the key. The encryption context is logged by CloudTrail, and
you can use this log to help track the use of particular data.
generateDataKeyAsync in interface AWSKMSAsyncpublic Future<GenerateDataKeyResult> generateDataKeyAsync(GenerateDataKeyRequest request, AsyncHandler<GenerateDataKeyRequest,GenerateDataKeyResult> asyncHandler)
AWSKMSAsync
Generates a data key that you can use in your application to locally
encrypt data. This call returns a plaintext version of the key in the
Plaintext field of the response object and an encrypted copy
of the key in the CiphertextBlob field. The key is encrypted
by using the master key specified by the KeyId field. To
decrypt the encrypted key, pass it to the Decrypt API.
We recommend that you use the following pattern to locally encrypt data:
call the GenerateDataKey API, use the key returned in the
Plaintext response field to locally encrypt data, and then
erase the plaintext data key from memory. Store the encrypted data key
(contained in the CiphertextBlob field) alongside of the
locally encrypted data.
Encrypt function to re-encrypt
your data keys within a region. GenerateDataKey always
returns the data key encrypted and tied to the customer master key that
will be used to decrypt it. There is no need to decrypt it twice.
If you decide to use the optional EncryptionContext
parameter, you must also store the context in full or at least store
enough information along with the encrypted data to be able to
reconstruct the context when submitting the ciphertext to the
Decrypt API. It is a good practice to choose a context that
you can reconstruct on the fly to better secure the ciphertext. For more
information about how this parameter is used, see Encryption Context.
To decrypt data, pass the encrypted data key to the Decrypt
API. Decrypt uses the associated master key to decrypt the
encrypted data key and returns it as plaintext. Use the plaintext data
key to locally decrypt your data and then erase the key from memory. You
must specify the encryption context, if any, that you specified when you
generated the key. The encryption context is logged by CloudTrail, and
you can use this log to help track the use of particular data.
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 key encrypted by a customer master key without the plaintext copy of that key. Otherwise, this API functions exactly like GenerateDataKey. You can use this API to, for example, satisfy an audit requirement that an encrypted key be made available without exposing the plaintext copy of that key.
generateDataKeyWithoutPlaintextAsync in interface AWSKMSAsyncpublic Future<GenerateDataKeyWithoutPlaintextResult> generateDataKeyWithoutPlaintextAsync(GenerateDataKeyWithoutPlaintextRequest request, AsyncHandler<GenerateDataKeyWithoutPlaintextRequest,GenerateDataKeyWithoutPlaintextResult> asyncHandler)
AWSKMSAsyncReturns a data key encrypted by a customer master key without the plaintext copy of that key. Otherwise, this API functions exactly like GenerateDataKey. You can use this API to, for example, satisfy an audit requirement that an encrypted key be made available without exposing the plaintext copy of that key.
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)
AWSKMSAsyncGenerates an unpredictable byte string.
generateRandomAsync in interface AWSKMSAsyncpublic Future<GenerateRandomResult> generateRandomAsync(GenerateRandomRequest request, AsyncHandler<GenerateRandomRequest,GenerateRandomResult> asyncHandler)
AWSKMSAsyncGenerates an unpredictable byte string.
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<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<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<Void> putKeyPolicyAsync(PutKeyPolicyRequest request)
AWSKMSAsyncAttaches a policy to the specified key.
putKeyPolicyAsync in interface AWSKMSAsyncpublic Future<Void> putKeyPolicyAsync(PutKeyPolicyRequest request, AsyncHandler<PutKeyPolicyRequest,Void> asyncHandler)
AWSKMSAsyncAttaches a policy to the specified key.
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 without exposing the plaintext of the data on the client side. The data is first decrypted and then encrypted. This operation can also be used to change the encryption context of a ciphertext.
Unlike other actions, ReEncrypt is authorized twice - once
as ReEncryptFrom on the source key and once as
ReEncryptTo on the destination key. We therefore recommend
that you include the "action":"kms:ReEncrypt*" statement in
your key policies to permit re-encryption from or to the key. The
statement is included automatically when you authorize use of the key
through the console but must be included manually when you set a policy
by using the PutKeyPolicy function.
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 without exposing the plaintext of the data on the client side. The data is first decrypted and then encrypted. This operation can also be used to change the encryption context of a ciphertext.
Unlike other actions, ReEncrypt is authorized twice - once
as ReEncryptFrom on the source key and once as
ReEncryptTo on the destination key. We therefore recommend
that you include the "action":"kms:ReEncrypt*" statement in
your key policies to permit re-encryption from or to the key. The
statement is included automatically when you authorize use of the key
through the console but must be included manually when you set a policy
by using the PutKeyPolicy function.
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<Void> retireGrantAsync(RetireGrantRequest request)
AWSKMSAsyncRetires a grant. You can retire a grant when you're done using it to clean up. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:
RetiringPrincipal, if presentGranteePrincipal, if RetireGrant is a
grantee operationCreateGrant function.
retireGrantAsync in interface AWSKMSAsyncpublic Future<Void> retireGrantAsync(RetireGrantRequest request, AsyncHandler<RetireGrantRequest,Void> asyncHandler)
AWSKMSAsyncRetires a grant. You can retire a grant when you're done using it to clean up. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:
RetiringPrincipal, if presentGranteePrincipal, if RetireGrant is a
grantee operationCreateGrant function.
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<Void> retireGrantAsync()
retireGrantAsync in interface AWSKMSAsyncretireGrantAsync(RetireGrantRequest)public Future<Void> retireGrantAsync(AsyncHandler<RetireGrantRequest,Void> asyncHandler)
retireGrantAsync in interface AWSKMSAsyncretireGrantAsync(RetireGrantRequest,
com.amazonaws.handlers.AsyncHandler)public Future<Void> revokeGrantAsync(RevokeGrantRequest request)
AWSKMSAsyncRevokes a grant. You can revoke a grant to actively deny operations that depend on it.
revokeGrantAsync in interface AWSKMSAsyncpublic Future<Void> revokeGrantAsync(RevokeGrantRequest request, AsyncHandler<RevokeGrantRequest,Void> 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 point to it.
Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use DisableKey.
For more information about scheduling a CMK for deletion, go to 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 point to it.
Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use DisableKey.
For more information about scheduling a CMK for deletion, go to 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<Void> 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<Void> updateAliasAsync(UpdateAliasRequest request, AsyncHandler<UpdateAliasRequest,Void> 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<Void> updateKeyDescriptionAsync(UpdateKeyDescriptionRequest request)
AWSKMSAsyncUpdates the description of a key.
updateKeyDescriptionAsync in interface AWSKMSAsyncpublic Future<Void> updateKeyDescriptionAsync(UpdateKeyDescriptionRequest request, AsyncHandler<UpdateKeyDescriptionRequest,Void> asyncHandler)
AWSKMSAsyncUpdates the description of a key.
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 © 2013 Amazon Web Services, Inc. All Rights Reserved.