public class AWSKMSAsyncClient extends AWSKMSClient implements AWSKMSAsync
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
AWS Key Management Service (AWS KMS) is an encryption and key management web service. This guide describes the AWS KMS operations that you can call programmatically. For general information about AWS KMS, see the AWS Key Management Service Developer Guide.
AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS KMS and other AWS services. For example, the SDKs take care of tasks such as signing requests (see below), managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.
We recommend that you use the AWS SDKs to make programmatic API calls to AWS KMS.
Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes.
Signing Requests
Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account access key ID and secret key for everyday work with AWS KMS. Instead, use the access key ID and secret access key for an IAM user, or you can use the AWS Security Token Service to generate temporary security credentials that you can use to sign requests.
All AWS KMS operations require Signature Version 4.
Logging API Requests
AWS KMS supports AWS CloudTrail, a service that logs AWS API calls and related events for your AWS account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to AWS KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.
Additional Resources
For more information about credentials and request signing, see the following:
Commonly Used APIs
Of the APIs discussed in this guide, the following will prove the most useful for most applications. You will likely perform actions other than these, such as creating keys and assigning policies, by using the console.
jsonErrorUnmarshallers
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
Constructor and Description |
---|
AWSKMSAsyncClient()
Constructs a new asynchronous client to invoke service methods on KMS.
|
AWSKMSAsyncClient(AWSCredentials awsCredentials)
Constructs a new asynchronous client to invoke service methods on KMS
using the specified AWS account credentials.
|
AWSKMSAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on KMS
using the specified AWS account credentials, executor service, and client
configuration options.
|
AWSKMSAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on KMS
using the specified AWS account credentials and executor service.
|
AWSKMSAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new asynchronous client to invoke service methods on KMS
using the specified AWS account credentials provider.
|
AWSKMSAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on KMS
using the provided AWS account credentials provider and client
configuration options.
|
AWSKMSAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on KMS
using the specified AWS account credentials provider, executor service,
and client configuration options.
|
AWSKMSAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on KMS
using the specified AWS account credentials provider and executor
service.
|
AWSKMSAsyncClient(ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on KMS.
|
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.
|
ExecutorService |
getExecutorService()
Returns the executor service used by this client to execute async
requests.
|
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).
|
void |
shutdown()
Shuts down the client, releasing all managed resources.
|
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, updateAlias, updateKeyDescription
addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
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, updateAlias, updateKeyDescription
public AWSKMSAsyncClient()
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
public AWSKMSAsyncClient(ClientConfiguration clientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing
a number of threads equal to the maximum number of concurrent connections
configured via ClientConfiguration.getMaxConnections()
.
clientConfiguration
- The client configuration options controlling how this client
connects to KMS (ex: proxy settings, retry counts, etc).DefaultAWSCredentialsProviderChain
,
Executors.newFixedThreadPool(int)
public AWSKMSAsyncClient(AWSCredentials awsCredentials)
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentials
- The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.Executors.newFixedThreadPool(int)
public AWSKMSAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
awsCredentials
- The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.executorService
- The executor service by which all asynchronous requests will be
executed.public AWSKMSAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
awsCredentials
- The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy settings,
etc).executorService
- The executor service by which all asynchronous requests will be
executed.public AWSKMSAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.Executors.newFixedThreadPool(int)
public AWSKMSAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing
a number of threads equal to the maximum number of concurrent connections
configured via ClientConfiguration.getMaxConnections()
.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy settings,
etc).DefaultAWSCredentialsProviderChain
,
Executors.newFixedThreadPool(int)
public AWSKMSAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.executorService
- The executor service by which all asynchronous requests will be
executed.public AWSKMSAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy settings,
etc).executorService
- The executor service by which all asynchronous requests will be
executed.public ExecutorService getExecutorService()
public 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 AWSKMSAsync
public 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 AWSKMSAsync
asyncHandler
- 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)
AWSKMSAsync
Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).
The alias and the key it is mapped to must be in the same AWS account and the same region.
To map an alias to a different key, call UpdateAlias.
createAliasAsync
in interface AWSKMSAsync
public Future<Void> createAliasAsync(CreateAliasRequest request, AsyncHandler<CreateAliasRequest,Void> asyncHandler)
AWSKMSAsync
Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).
The alias and the key it is mapped to must be in the same AWS account and the same region.
To map an alias to a different key, call UpdateAlias.
createAliasAsync
in interface AWSKMSAsync
asyncHandler
- 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)
AWSKMSAsync
Adds a grant to a key to specify who can use the key and under what conditions. Grants are alternate permission mechanisms to key policies.
For more information about grants, see Grants in the AWS Key Management Service Developer Guide.
createGrantAsync
in interface AWSKMSAsync
public Future<CreateGrantResult> createGrantAsync(CreateGrantRequest request, AsyncHandler<CreateGrantRequest,CreateGrantResult> asyncHandler)
AWSKMSAsync
Adds a grant to a key to specify who can use the key and under what conditions. Grants are alternate permission mechanisms to key policies.
For more information about grants, see Grants in the AWS Key Management Service Developer Guide.
createGrantAsync
in interface AWSKMSAsync
asyncHandler
- 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)
AWSKMSAsync
Creates 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 AWSKMSAsync
public Future<CreateKeyResult> createKeyAsync(CreateKeyRequest request, AsyncHandler<CreateKeyRequest,CreateKeyResult> asyncHandler)
AWSKMSAsync
Creates 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 AWSKMSAsync
asyncHandler
- 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 AWSKMSAsync
createKeyAsync(CreateKeyRequest)
public Future<CreateKeyResult> createKeyAsync(AsyncHandler<CreateKeyRequest,CreateKeyResult> asyncHandler)
createKeyAsync
in interface AWSKMSAsync
createKeyAsync(CreateKeyRequest,
com.amazonaws.handlers.AsyncHandler)
public Future<DecryptResult> decryptAsync(DecryptRequest request)
AWSKMSAsync
Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following functions:
Note that if a caller has been granted access permissions to all keys
(through, for example, IAM user policies that grant Decrypt
permission on all resources), then ciphertext encrypted by using keys in
other accounts where the key grants access to the caller can be
decrypted. To remedy this, we recommend that you do not grant
Decrypt
access in an IAM user policy. Instead grant
Decrypt
access only in key policies. If you must grant
Decrypt
access in an IAM user policy, you should scope the
resource to specific keys or to specific trusted accounts.
decryptAsync
in interface AWSKMSAsync
public Future<DecryptResult> decryptAsync(DecryptRequest request, AsyncHandler<DecryptRequest,DecryptResult> asyncHandler)
AWSKMSAsync
Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following functions:
Note that if a caller has been granted access permissions to all keys
(through, for example, IAM user policies that grant Decrypt
permission on all resources), then ciphertext encrypted by using keys in
other accounts where the key grants access to the caller can be
decrypted. To remedy this, we recommend that you do not grant
Decrypt
access in an IAM user policy. Instead grant
Decrypt
access only in key policies. If you must grant
Decrypt
access in an IAM user policy, you should scope the
resource to specific keys or to specific trusted accounts.
decryptAsync
in interface AWSKMSAsync
asyncHandler
- 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)
AWSKMSAsync
Deletes the specified alias. To map an alias to a different key, call UpdateAlias.
deleteAliasAsync
in interface AWSKMSAsync
public Future<Void> deleteAliasAsync(DeleteAliasRequest request, AsyncHandler<DeleteAliasRequest,Void> asyncHandler)
AWSKMSAsync
Deletes the specified alias. To map an alias to a different key, call UpdateAlias.
deleteAliasAsync
in interface AWSKMSAsync
asyncHandler
- 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)
AWSKMSAsync
Provides detailed information about the specified customer master key.
describeKeyAsync
in interface AWSKMSAsync
public Future<DescribeKeyResult> describeKeyAsync(DescribeKeyRequest request, AsyncHandler<DescribeKeyRequest,DescribeKeyResult> asyncHandler)
AWSKMSAsync
Provides detailed information about the specified customer master key.
describeKeyAsync
in interface AWSKMSAsync
asyncHandler
- 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)
AWSKMSAsync
Sets 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 AWSKMSAsync
public Future<Void> disableKeyAsync(DisableKeyRequest request, AsyncHandler<DisableKeyRequest,Void> asyncHandler)
AWSKMSAsync
Sets 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 AWSKMSAsync
asyncHandler
- 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)
AWSKMSAsync
Disables rotation of the specified key.
disableKeyRotationAsync
in interface AWSKMSAsync
public Future<Void> disableKeyRotationAsync(DisableKeyRotationRequest request, AsyncHandler<DisableKeyRotationRequest,Void> asyncHandler)
AWSKMSAsync
Disables rotation of the specified key.
disableKeyRotationAsync
in interface AWSKMSAsync
asyncHandler
- 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)
AWSKMSAsync
Marks a key as enabled, thereby permitting its use.
enableKeyAsync
in interface AWSKMSAsync
public Future<Void> enableKeyAsync(EnableKeyRequest request, AsyncHandler<EnableKeyRequest,Void> asyncHandler)
AWSKMSAsync
Marks a key as enabled, thereby permitting its use.
enableKeyAsync
in interface AWSKMSAsync
asyncHandler
- 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)
AWSKMSAsync
Enables rotation of the specified customer master key.
enableKeyRotationAsync
in interface AWSKMSAsync
public Future<Void> enableKeyRotationAsync(EnableKeyRotationRequest request, AsyncHandler<EnableKeyRotationRequest,Void> asyncHandler)
AWSKMSAsync
Enables rotation of the specified customer master key.
enableKeyRotationAsync
in interface AWSKMSAsync
asyncHandler
- 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 AWSKMSAsync
public 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 AWSKMSAsync
asyncHandler
- 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 AWSKMSAsync
public 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 AWSKMSAsync
asyncHandler
- 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)
AWSKMSAsync
Returns a data key encrypted by a customer master key without the plaintext copy of that key. Otherwise, this API functions exactly like GenerateDataKey. You can use this API to, for example, satisfy an audit requirement that an encrypted key be made available without exposing the plaintext copy of that key.
generateDataKeyWithoutPlaintextAsync
in interface AWSKMSAsync
public Future<GenerateDataKeyWithoutPlaintextResult> generateDataKeyWithoutPlaintextAsync(GenerateDataKeyWithoutPlaintextRequest request, AsyncHandler<GenerateDataKeyWithoutPlaintextRequest,GenerateDataKeyWithoutPlaintextResult> asyncHandler)
AWSKMSAsync
Returns a data key encrypted by a customer master key without the plaintext copy of that key. Otherwise, this API functions exactly like GenerateDataKey. You can use this API to, for example, satisfy an audit requirement that an encrypted key be made available without exposing the plaintext copy of that key.
generateDataKeyWithoutPlaintextAsync
in interface AWSKMSAsync
asyncHandler
- 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)
AWSKMSAsync
Generates an unpredictable byte string.
generateRandomAsync
in interface AWSKMSAsync
public Future<GenerateRandomResult> generateRandomAsync(GenerateRandomRequest request, AsyncHandler<GenerateRandomRequest,GenerateRandomResult> asyncHandler)
AWSKMSAsync
Generates an unpredictable byte string.
generateRandomAsync
in interface AWSKMSAsync
asyncHandler
- 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 AWSKMSAsync
generateRandomAsync(GenerateRandomRequest)
public Future<GenerateRandomResult> generateRandomAsync(AsyncHandler<GenerateRandomRequest,GenerateRandomResult> asyncHandler)
generateRandomAsync
in interface AWSKMSAsync
generateRandomAsync(GenerateRandomRequest,
com.amazonaws.handlers.AsyncHandler)
public Future<GetKeyPolicyResult> getKeyPolicyAsync(GetKeyPolicyRequest request)
AWSKMSAsync
Retrieves a policy attached to the specified key.
getKeyPolicyAsync
in interface AWSKMSAsync
public Future<GetKeyPolicyResult> getKeyPolicyAsync(GetKeyPolicyRequest request, AsyncHandler<GetKeyPolicyRequest,GetKeyPolicyResult> asyncHandler)
AWSKMSAsync
Retrieves a policy attached to the specified key.
getKeyPolicyAsync
in interface AWSKMSAsync
asyncHandler
- 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)
AWSKMSAsync
Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.
getKeyRotationStatusAsync
in interface AWSKMSAsync
public Future<GetKeyRotationStatusResult> getKeyRotationStatusAsync(GetKeyRotationStatusRequest request, AsyncHandler<GetKeyRotationStatusRequest,GetKeyRotationStatusResult> asyncHandler)
AWSKMSAsync
Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.
getKeyRotationStatusAsync
in interface AWSKMSAsync
asyncHandler
- 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)
AWSKMSAsync
Lists all of the key aliases in the account.
listAliasesAsync
in interface AWSKMSAsync
public Future<ListAliasesResult> listAliasesAsync(ListAliasesRequest request, AsyncHandler<ListAliasesRequest,ListAliasesResult> asyncHandler)
AWSKMSAsync
Lists all of the key aliases in the account.
listAliasesAsync
in interface AWSKMSAsync
asyncHandler
- 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 AWSKMSAsync
listAliasesAsync(ListAliasesRequest)
public Future<ListAliasesResult> listAliasesAsync(AsyncHandler<ListAliasesRequest,ListAliasesResult> asyncHandler)
listAliasesAsync
in interface AWSKMSAsync
listAliasesAsync(ListAliasesRequest,
com.amazonaws.handlers.AsyncHandler)
public Future<ListGrantsResult> listGrantsAsync(ListGrantsRequest request)
AWSKMSAsync
List the grants for a specified key.
listGrantsAsync
in interface AWSKMSAsync
public Future<ListGrantsResult> listGrantsAsync(ListGrantsRequest request, AsyncHandler<ListGrantsRequest,ListGrantsResult> asyncHandler)
AWSKMSAsync
List the grants for a specified key.
listGrantsAsync
in interface AWSKMSAsync
asyncHandler
- 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)
AWSKMSAsync
Retrieves a list of policies attached to a key.
listKeyPoliciesAsync
in interface AWSKMSAsync
public Future<ListKeyPoliciesResult> listKeyPoliciesAsync(ListKeyPoliciesRequest request, AsyncHandler<ListKeyPoliciesRequest,ListKeyPoliciesResult> asyncHandler)
AWSKMSAsync
Retrieves a list of policies attached to a key.
listKeyPoliciesAsync
in interface AWSKMSAsync
asyncHandler
- 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)
AWSKMSAsync
Lists the customer master keys.
listKeysAsync
in interface AWSKMSAsync
public Future<ListKeysResult> listKeysAsync(ListKeysRequest request, AsyncHandler<ListKeysRequest,ListKeysResult> asyncHandler)
AWSKMSAsync
Lists the customer master keys.
listKeysAsync
in interface AWSKMSAsync
asyncHandler
- 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 AWSKMSAsync
listKeysAsync(ListKeysRequest)
public Future<ListKeysResult> listKeysAsync(AsyncHandler<ListKeysRequest,ListKeysResult> asyncHandler)
listKeysAsync
in interface AWSKMSAsync
listKeysAsync(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 AWSKMSAsync
public 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 AWSKMSAsync
asyncHandler
- 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)
AWSKMSAsync
Attaches a policy to the specified key.
putKeyPolicyAsync
in interface AWSKMSAsync
public Future<Void> putKeyPolicyAsync(PutKeyPolicyRequest request, AsyncHandler<PutKeyPolicyRequest,Void> asyncHandler)
AWSKMSAsync
Attaches a policy to the specified key.
putKeyPolicyAsync
in interface AWSKMSAsync
asyncHandler
- 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)
AWSKMSAsync
Encrypts data on the server side with a new customer master key without exposing the plaintext of the data on the client side. The data is first decrypted and then encrypted. This operation can also be used to change the encryption context of a ciphertext.
Unlike other actions, ReEncrypt
is authorized twice - once
as ReEncryptFrom
on the source key and once as
ReEncryptTo
on the destination key. We therefore recommend
that you include the "action":"kms:ReEncrypt*"
statement in
your key policies to permit re-encryption from or to the key. The
statement is included automatically when you authorize use of the key
through the console but must be included manually when you set a policy
by using the PutKeyPolicy function.
reEncryptAsync
in interface AWSKMSAsync
public Future<ReEncryptResult> reEncryptAsync(ReEncryptRequest request, AsyncHandler<ReEncryptRequest,ReEncryptResult> asyncHandler)
AWSKMSAsync
Encrypts data on the server side with a new customer master key without exposing the plaintext of the data on the client side. The data is first decrypted and then encrypted. This operation can also be used to change the encryption context of a ciphertext.
Unlike other actions, ReEncrypt
is authorized twice - once
as ReEncryptFrom
on the source key and once as
ReEncryptTo
on the destination key. We therefore recommend
that you include the "action":"kms:ReEncrypt*"
statement in
your key policies to permit re-encryption from or to the key. The
statement is included automatically when you authorize use of the key
through the console but must be included manually when you set a policy
by using the PutKeyPolicy function.
reEncryptAsync
in interface AWSKMSAsync
asyncHandler
- 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)
AWSKMSAsync
Retires a grant. You can retire a grant when you're done using it to clean up. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:
RetiringPrincipal
, if presentGranteePrincipal
, if RetireGrant
is a
grantee operationCreateGrant
function.
retireGrantAsync
in interface AWSKMSAsync
public Future<Void> retireGrantAsync(RetireGrantRequest request, AsyncHandler<RetireGrantRequest,Void> asyncHandler)
AWSKMSAsync
Retires a grant. You can retire a grant when you're done using it to clean up. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:
RetiringPrincipal
, if presentGranteePrincipal
, if RetireGrant
is a
grantee operationCreateGrant
function.
retireGrantAsync
in interface AWSKMSAsync
asyncHandler
- 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 AWSKMSAsync
retireGrantAsync(RetireGrantRequest)
public Future<Void> retireGrantAsync(AsyncHandler<RetireGrantRequest,Void> asyncHandler)
retireGrantAsync
in interface AWSKMSAsync
retireGrantAsync(RetireGrantRequest,
com.amazonaws.handlers.AsyncHandler)
public Future<Void> revokeGrantAsync(RevokeGrantRequest request)
AWSKMSAsync
Revokes a grant. You can revoke a grant to actively deny operations that depend on it.
revokeGrantAsync
in interface AWSKMSAsync
public Future<Void> revokeGrantAsync(RevokeGrantRequest request, AsyncHandler<RevokeGrantRequest,Void> asyncHandler)
AWSKMSAsync
Revokes a grant. You can revoke a grant to actively deny operations that depend on it.
revokeGrantAsync
in interface AWSKMSAsync
asyncHandler
- 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 AWSKMSAsync
public 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 AWSKMSAsync
asyncHandler
- 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)
AWSKMSAsync
Updates an alias to map it to a different key.
An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the key.
An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).
The alias and the key it is mapped to must be in the same AWS account and the same region.
updateAliasAsync
in interface AWSKMSAsync
public Future<Void> updateAliasAsync(UpdateAliasRequest request, AsyncHandler<UpdateAliasRequest,Void> asyncHandler)
AWSKMSAsync
Updates an alias to map it to a different key.
An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the key.
An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).
The alias and the key it is mapped to must be in the same AWS account and the same region.
updateAliasAsync
in interface AWSKMSAsync
asyncHandler
- 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)
AWSKMSAsync
Updates the description of a key.
updateKeyDescriptionAsync
in interface AWSKMSAsync
public Future<Void> updateKeyDescriptionAsync(UpdateKeyDescriptionRequest request, AsyncHandler<UpdateKeyDescriptionRequest,Void> asyncHandler)
AWSKMSAsync
Updates the description of a key.
updateKeyDescriptionAsync
in interface AWSKMSAsync
asyncHandler
- 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 void shutdown()
getExecutorService().shutdown()
followed by
getExecutorService().awaitTermination()
prior to calling this
method.shutdown
in interface AWSKMS
shutdown
in class AmazonWebServiceClient
Copyright © 2015. All rights reserved.