Class AWSKMSAsyncClient
- All Implemented Interfaces:
AWSKMS
,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 (root) access key ID and secret key for everyday work with AWS KMS. Instead, use the access key ID and secret access key for an IAM user, or you can use the AWS Security Token Service to generate temporary security credentials that you can use to sign requests.
All AWS KMS operations require Signature Version 4.
Logging API Requests
AWS KMS supports AWS CloudTrail, a service that logs AWS API calls and related events for your AWS account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to AWS KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.
Additional Resources
For more information about credentials and request signing, see the following:
-
AWS Security Credentials - This topic provides general information about the types of credentials used for accessing AWS.
-
Temporary Security Credentials - This section of the IAM User Guide describes how to create and use temporary security credentials.
-
Signature Version 4 Signing Process - This set of topics walks you through the process of signing a request using an access key ID and a secret access key.
Commonly Used APIs
Of the APIs discussed in this guide, the following will prove the most useful for most applications. You will likely perform actions other than these, such as creating keys and assigning policies, by using the console.
-
Field Summary
Fields inherited from class com.amazonaws.services.kms.AWSKMSClient
configFactory
Fields inherited from class com.amazonaws.AmazonWebServiceClient
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs 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
(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
(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
(ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on KMS. -
Method Summary
Modifier and TypeMethodDescriptionCancels the deletion of a customer master key (CMK).cancelKeyDeletionAsync
(CancelKeyDeletionRequest request, AsyncHandler<CancelKeyDeletionRequest, CancelKeyDeletionResult> asyncHandler) Cancels the deletion of a customer master key (CMK).createAliasAsync
(CreateAliasRequest request) Creates a display name for a customer master key.createAliasAsync
(CreateAliasRequest request, AsyncHandler<CreateAliasRequest, CreateAliasResult> asyncHandler) Creates a display name for a customer master key.createGrantAsync
(CreateGrantRequest request) Adds a grant to a key to specify who can use the key and under what conditions.createGrantAsync
(CreateGrantRequest request, AsyncHandler<CreateGrantRequest, CreateGrantResult> asyncHandler) Adds a grant to a key to specify who can use the key and under what conditions.Simplified method form for invoking the CreateKey operation.createKeyAsync
(AsyncHandler<CreateKeyRequest, CreateKeyResult> asyncHandler) Simplified method form for invoking the CreateKey operation with an AsyncHandler.createKeyAsync
(CreateKeyRequest request) Creates a customer master key (CMK).createKeyAsync
(CreateKeyRequest request, AsyncHandler<CreateKeyRequest, CreateKeyResult> asyncHandler) Creates a customer master key (CMK).decryptAsync
(DecryptRequest request) Decrypts ciphertext.decryptAsync
(DecryptRequest request, AsyncHandler<DecryptRequest, DecryptResult> asyncHandler) Decrypts ciphertext.deleteAliasAsync
(DeleteAliasRequest request) Deletes the specified alias.deleteAliasAsync
(DeleteAliasRequest request, AsyncHandler<DeleteAliasRequest, DeleteAliasResult> asyncHandler) Deletes the specified alias.describeKeyAsync
(DescribeKeyRequest request) Provides detailed information about the specified customer master key.describeKeyAsync
(DescribeKeyRequest request, AsyncHandler<DescribeKeyRequest, DescribeKeyResult> asyncHandler) Provides detailed information about the specified customer master key.disableKeyAsync
(DisableKeyRequest request) Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations.disableKeyAsync
(DisableKeyRequest request, AsyncHandler<DisableKeyRequest, DisableKeyResult> asyncHandler) Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations.Disables rotation of the specified key.disableKeyRotationAsync
(DisableKeyRotationRequest request, AsyncHandler<DisableKeyRotationRequest, DisableKeyRotationResult> asyncHandler) Disables rotation of the specified key.enableKeyAsync
(EnableKeyRequest request) Marks a key as enabled, thereby permitting its use.enableKeyAsync
(EnableKeyRequest request, AsyncHandler<EnableKeyRequest, EnableKeyResult> asyncHandler) Marks a key as enabled, thereby permitting its use.Enables rotation of the specified customer master key.enableKeyRotationAsync
(EnableKeyRotationRequest request, AsyncHandler<EnableKeyRotationRequest, EnableKeyRotationResult> asyncHandler) Enables rotation of the specified customer master key.encryptAsync
(EncryptRequest request) Encrypts plaintext into ciphertext by using a customer master key.encryptAsync
(EncryptRequest request, AsyncHandler<EncryptRequest, EncryptResult> asyncHandler) Encrypts plaintext into ciphertext by using a customer master key.Generates a data key that you can use in your application to locally encrypt data.generateDataKeyAsync
(GenerateDataKeyRequest request, AsyncHandler<GenerateDataKeyRequest, GenerateDataKeyResult> asyncHandler) Generates a data key that you can use in your application to locally encrypt data.Returns a data key encrypted by a customer master key without the plaintext copy of that key.generateDataKeyWithoutPlaintextAsync
(GenerateDataKeyWithoutPlaintextRequest request, AsyncHandler<GenerateDataKeyWithoutPlaintextRequest, GenerateDataKeyWithoutPlaintextResult> asyncHandler) Returns a data key encrypted by a customer master key without the plaintext copy of that key.Simplified method form for invoking the GenerateRandom operation.generateRandomAsync
(AsyncHandler<GenerateRandomRequest, GenerateRandomResult> asyncHandler) Simplified method form for invoking the GenerateRandom operation with an AsyncHandler.generateRandomAsync
(GenerateRandomRequest request) Generates an unpredictable byte string.generateRandomAsync
(GenerateRandomRequest request, AsyncHandler<GenerateRandomRequest, GenerateRandomResult> asyncHandler) Generates an unpredictable byte string.Returns the executor service used by this client to execute async requests.getKeyPolicyAsync
(GetKeyPolicyRequest request) Retrieves a policy attached to the specified key.getKeyPolicyAsync
(GetKeyPolicyRequest request, AsyncHandler<GetKeyPolicyRequest, GetKeyPolicyResult> asyncHandler) Retrieves a policy attached to the specified key.Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.getKeyRotationStatusAsync
(GetKeyRotationStatusRequest request, AsyncHandler<GetKeyRotationStatusRequest, GetKeyRotationStatusResult> asyncHandler) Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.Simplified method form for invoking the ListAliases operation.listAliasesAsync
(AsyncHandler<ListAliasesRequest, ListAliasesResult> asyncHandler) Simplified method form for invoking the ListAliases operation with an AsyncHandler.listAliasesAsync
(ListAliasesRequest request) Lists all of the key aliases in the account.listAliasesAsync
(ListAliasesRequest request, AsyncHandler<ListAliasesRequest, ListAliasesResult> asyncHandler) Lists all of the key aliases in the account.listGrantsAsync
(ListGrantsRequest request) List the grants for a specified key.listGrantsAsync
(ListGrantsRequest request, AsyncHandler<ListGrantsRequest, ListGrantsResult> asyncHandler) List the grants for a specified key.Retrieves a list of policies attached to a key.listKeyPoliciesAsync
(ListKeyPoliciesRequest request, AsyncHandler<ListKeyPoliciesRequest, ListKeyPoliciesResult> asyncHandler) Retrieves a list of policies attached to a key.Simplified method form for invoking the ListKeys operation.listKeysAsync
(AsyncHandler<ListKeysRequest, ListKeysResult> asyncHandler) Simplified method form for invoking the ListKeys operation with an AsyncHandler.listKeysAsync
(ListKeysRequest request) Lists the customer master keys.listKeysAsync
(ListKeysRequest request, AsyncHandler<ListKeysRequest, ListKeysResult> asyncHandler) Lists the customer master keys.Returns a list of all grants for which the grant'sRetiringPrincipal
matches the one specified.listRetirableGrantsAsync
(ListRetirableGrantsRequest request, AsyncHandler<ListRetirableGrantsRequest, ListRetirableGrantsResult> asyncHandler) Returns a list of all grants for which the grant'sRetiringPrincipal
matches the one specified.putKeyPolicyAsync
(PutKeyPolicyRequest request) Attaches a key policy to the specified customer master key (CMK).putKeyPolicyAsync
(PutKeyPolicyRequest request, AsyncHandler<PutKeyPolicyRequest, PutKeyPolicyResult> asyncHandler) Attaches a key policy to the specified customer master key (CMK).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.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.Simplified method form for invoking the RetireGrant operation.retireGrantAsync
(AsyncHandler<RetireGrantRequest, RetireGrantResult> asyncHandler) Simplified method form for invoking the RetireGrant operation with an AsyncHandler.retireGrantAsync
(RetireGrantRequest request) Retires a grant.retireGrantAsync
(RetireGrantRequest request, AsyncHandler<RetireGrantRequest, RetireGrantResult> asyncHandler) Retires a grant.revokeGrantAsync
(RevokeGrantRequest request) Revokes a grant.revokeGrantAsync
(RevokeGrantRequest request, AsyncHandler<RevokeGrantRequest, RevokeGrantResult> asyncHandler) Revokes a grant.Schedules the deletion of a customer master key (CMK).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.updateAliasAsync
(UpdateAliasRequest request) Updates an alias to map it to a different key.updateAliasAsync
(UpdateAliasRequest request, AsyncHandler<UpdateAliasRequest, UpdateAliasResult> asyncHandler) Updates an alias to map it to a different key.Updates the description of a key.updateKeyDescriptionAsync
(UpdateKeyDescriptionRequest request, AsyncHandler<UpdateKeyDescriptionRequest, UpdateKeyDescriptionResult> asyncHandler) Updates the description of a key.Methods inherited from class com.amazonaws.services.kms.AWSKMSClient
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
Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeMarshalling, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.amazonaws.services.kms.AWSKMS
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
-
Constructor Details
-
AWSKMSAsyncClient
public AWSKMSAsyncClient()Constructs a new asynchronous client to invoke service methods on KMS. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
- Instance profile credentials delivered through the Amazon EC2 metadata service
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).
- See Also:
-
AWSKMSAsyncClient
Constructs a new asynchronous client to invoke service methods on KMS. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
- Instance profile credentials delivered through the Amazon EC2 metadata service
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()
.- Parameters:
clientConfiguration
- The client configuration options controlling how this client connects to KMS (ex: proxy settings, retry counts, etc).- See Also:
-
AWSKMSAsyncClient
Constructs a new asynchronous client to invoke service methods on KMS using the specified AWS account credentials.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).
- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.- See Also:
-
AWSKMSAsyncClient
Constructs a new asynchronous client to invoke service methods on KMS using the specified AWS account credentials and executor service. Default client settings will be used.- Parameters:
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.
-
AWSKMSAsyncClient
public 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.- Parameters:
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.
-
AWSKMSAsyncClient
Constructs a new asynchronous client to invoke service methods on KMS using the specified AWS account credentials provider. Default client settings will be used.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).
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.- See Also:
-
AWSKMSAsyncClient
public 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.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()
.- Parameters:
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).- See Also:
-
AWSKMSAsyncClient
public 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. Default client settings will be used.- Parameters:
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.
-
AWSKMSAsyncClient
public 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.- Parameters:
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.
-
-
Method Details
-
getExecutorService
Returns the executor service used by this client to execute async requests.- Returns:
- The executor service used by this client to execute async requests.
-
cancelKeyDeletionAsync
Description copied from interface:AWSKMSAsync
Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the
Disabled
state. To enable a CMK, use EnableKey.For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
- Specified by:
cancelKeyDeletionAsync
in interfaceAWSKMSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the CancelKeyDeletion operation returned by the service.
-
cancelKeyDeletionAsync
public Future<CancelKeyDeletionResult> cancelKeyDeletionAsync(CancelKeyDeletionRequest request, AsyncHandler<CancelKeyDeletionRequest, CancelKeyDeletionResult> asyncHandler) Description copied from interface:AWSKMSAsync
Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the
Disabled
state. To enable a CMK, use EnableKey.For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
- Specified by:
cancelKeyDeletionAsync
in interfaceAWSKMSAsync
- Parameters:
request
-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.- Returns:
- A Java Future containing the result of the CancelKeyDeletion operation returned by the service.
-
createAliasAsync
Description copied from interface: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.
- Specified by:
createAliasAsync
in interfaceAWSKMSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the CreateAlias operation returned by the service.
-
createAliasAsync
public Future<CreateAliasResult> createAliasAsync(CreateAliasRequest request, AsyncHandler<CreateAliasRequest, CreateAliasResult> asyncHandler) Description copied from interface: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.
- Specified by:
createAliasAsync
in interfaceAWSKMSAsync
- Parameters:
request
-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.- Returns:
- A Java Future containing the result of the CreateAlias operation returned by the service.
-
createGrantAsync
Description copied from interface: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.
- Specified by:
createGrantAsync
in interfaceAWSKMSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the CreateGrant operation returned by the service.
-
createGrantAsync
public Future<CreateGrantResult> createGrantAsync(CreateGrantRequest request, AsyncHandler<CreateGrantRequest, CreateGrantResult> asyncHandler) Description copied from interface: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.
- Specified by:
createGrantAsync
in interfaceAWSKMSAsync
- Parameters:
request
-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.- Returns:
- A Java Future containing the result of the CreateGrant operation returned by the service.
-
createKeyAsync
Description copied from interface:AWSKMSAsync
Creates a customer master key (CMK).
You can use a CMK to encrypt small amounts of data (4 KiB or less) directly, but CMKs are more commonly used to encrypt data encryption keys (DEKs), which are used to encrypt raw data. For more information about DEKs and the difference between CMKs and DEKs, see the following:
-
The GenerateDataKey operation
-
AWS Key Management Service Concepts in the AWS Key Management Service Developer Guide
- Specified by:
createKeyAsync
in interfaceAWSKMSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the CreateKey operation returned by the service.
-
-
createKeyAsync
public Future<CreateKeyResult> createKeyAsync(CreateKeyRequest request, AsyncHandler<CreateKeyRequest, CreateKeyResult> asyncHandler) Description copied from interface:AWSKMSAsync
Creates a customer master key (CMK).
You can use a CMK to encrypt small amounts of data (4 KiB or less) directly, but CMKs are more commonly used to encrypt data encryption keys (DEKs), which are used to encrypt raw data. For more information about DEKs and the difference between CMKs and DEKs, see the following:
-
The GenerateDataKey operation
-
AWS Key Management Service Concepts in the AWS Key Management Service Developer Guide
- Specified by:
createKeyAsync
in interfaceAWSKMSAsync
- Parameters:
request
-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.- Returns:
- A Java Future containing the result of the CreateKey operation returned by the service.
-
-
createKeyAsync
Simplified method form for invoking the CreateKey operation.- Specified by:
createKeyAsync
in interfaceAWSKMSAsync
- See Also:
-
createKeyAsync
public Future<CreateKeyResult> createKeyAsync(AsyncHandler<CreateKeyRequest, CreateKeyResult> asyncHandler) Simplified method form for invoking the CreateKey operation with an AsyncHandler.- Specified by:
createKeyAsync
in interfaceAWSKMSAsync
- See Also:
-
decryptAsync
Description copied from interface: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 grantDecrypt
access in an IAM user policy. Instead grantDecrypt
access only in key policies. If you must grantDecrypt
access in an IAM user policy, you should scope the resource to specific keys or to specific trusted accounts.- Specified by:
decryptAsync
in interfaceAWSKMSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the Decrypt operation returned by the service.
-
decryptAsync
public Future<DecryptResult> decryptAsync(DecryptRequest request, AsyncHandler<DecryptRequest, DecryptResult> asyncHandler) Description copied from interface: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 grantDecrypt
access in an IAM user policy. Instead grantDecrypt
access only in key policies. If you must grantDecrypt
access in an IAM user policy, you should scope the resource to specific keys or to specific trusted accounts.- Specified by:
decryptAsync
in interfaceAWSKMSAsync
- Parameters:
request
-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.- Returns:
- A Java Future containing the result of the Decrypt operation returned by the service.
-
deleteAliasAsync
Description copied from interface:AWSKMSAsync
Deletes the specified alias. To map an alias to a different key, call UpdateAlias.
- Specified by:
deleteAliasAsync
in interfaceAWSKMSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the DeleteAlias operation returned by the service.
-
deleteAliasAsync
public Future<DeleteAliasResult> deleteAliasAsync(DeleteAliasRequest request, AsyncHandler<DeleteAliasRequest, DeleteAliasResult> asyncHandler) Description copied from interface:AWSKMSAsync
Deletes the specified alias. To map an alias to a different key, call UpdateAlias.
- Specified by:
deleteAliasAsync
in interfaceAWSKMSAsync
- Parameters:
request
-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.- Returns:
- A Java Future containing the result of the DeleteAlias operation returned by the service.
-
describeKeyAsync
Description copied from interface:AWSKMSAsync
Provides detailed information about the specified customer master key.
- Specified by:
describeKeyAsync
in interfaceAWSKMSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the DescribeKey operation returned by the service.
-
describeKeyAsync
public Future<DescribeKeyResult> describeKeyAsync(DescribeKeyRequest request, AsyncHandler<DescribeKeyRequest, DescribeKeyResult> asyncHandler) Description copied from interface:AWSKMSAsync
Provides detailed information about the specified customer master key.
- Specified by:
describeKeyAsync
in interfaceAWSKMSAsync
- Parameters:
request
-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.- Returns:
- A Java Future containing the result of the DescribeKey operation returned by the service.
-
disableKeyAsync
Description copied from interface:AWSKMSAsync
Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
- Specified by:
disableKeyAsync
in interfaceAWSKMSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the DisableKey operation returned by the service.
-
disableKeyAsync
public Future<DisableKeyResult> disableKeyAsync(DisableKeyRequest request, AsyncHandler<DisableKeyRequest, DisableKeyResult> asyncHandler) Description copied from interface:AWSKMSAsync
Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
- Specified by:
disableKeyAsync
in interfaceAWSKMSAsync
- Parameters:
request
-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.- Returns:
- A Java Future containing the result of the DisableKey operation returned by the service.
-
disableKeyRotationAsync
Description copied from interface:AWSKMSAsync
Disables rotation of the specified key.
- Specified by:
disableKeyRotationAsync
in interfaceAWSKMSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the DisableKeyRotation operation returned by the service.
-
disableKeyRotationAsync
public Future<DisableKeyRotationResult> disableKeyRotationAsync(DisableKeyRotationRequest request, AsyncHandler<DisableKeyRotationRequest, DisableKeyRotationResult> asyncHandler) Description copied from interface:AWSKMSAsync
Disables rotation of the specified key.
- Specified by:
disableKeyRotationAsync
in interfaceAWSKMSAsync
- Parameters:
request
-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.- Returns:
- A Java Future containing the result of the DisableKeyRotation operation returned by the service.
-
enableKeyAsync
Description copied from interface:AWSKMSAsync
Marks a key as enabled, thereby permitting its use.
- Specified by:
enableKeyAsync
in interfaceAWSKMSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the EnableKey operation returned by the service.
-
enableKeyAsync
public Future<EnableKeyResult> enableKeyAsync(EnableKeyRequest request, AsyncHandler<EnableKeyRequest, EnableKeyResult> asyncHandler) Description copied from interface:AWSKMSAsync
Marks a key as enabled, thereby permitting its use.
- Specified by:
enableKeyAsync
in interfaceAWSKMSAsync
- Parameters:
request
-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.- Returns:
- A Java Future containing the result of the EnableKey operation returned by the service.
-
enableKeyRotationAsync
Description copied from interface:AWSKMSAsync
Enables rotation of the specified customer master key.
- Specified by:
enableKeyRotationAsync
in interfaceAWSKMSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the EnableKeyRotation operation returned by the service.
-
enableKeyRotationAsync
public Future<EnableKeyRotationResult> enableKeyRotationAsync(EnableKeyRotationRequest request, AsyncHandler<EnableKeyRotationRequest, EnableKeyRotationResult> asyncHandler) Description copied from interface:AWSKMSAsync
Enables rotation of the specified customer master key.
- Specified by:
enableKeyRotationAsync
in interfaceAWSKMSAsync
- Parameters:
request
-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.- Returns:
- A Java Future containing the result of the EnableKeyRotation operation returned by the service.
-
encryptAsync
Description copied from interface:AWSKMSAsync
Encrypts plaintext into ciphertext by using a customer master key. The
Encrypt
function has two primary use cases:-
You can encrypt up to 4 KB of arbitrary data such as an RSA key, a database password, or other sensitive customer information.
-
If you are moving encrypted data from one region to another, you can use this API to encrypt in the new region the plaintext data key that was used to encrypt the data in the original region. This provides you with an encrypted copy of the data key that can be decrypted in the new region and used there to decrypt the encrypted data.
Unless you are moving encrypted data from one region to another, you don't use this function to encrypt a generated data key within a region. You retrieve data keys already encrypted by calling the GenerateDataKey or GenerateDataKeyWithoutPlaintext function. Data keys don't need to be encrypted again by calling
Encrypt
.If you want to encrypt data locally in your application, you can use the
GenerateDataKey
function to return a plaintext data encryption key and a copy of the key encrypted under the customer master key (CMK) of your choosing.- Specified by:
encryptAsync
in interfaceAWSKMSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the Encrypt operation returned by the service.
-
-
encryptAsync
public Future<EncryptResult> encryptAsync(EncryptRequest request, AsyncHandler<EncryptRequest, EncryptResult> asyncHandler) Description copied from interface:AWSKMSAsync
Encrypts plaintext into ciphertext by using a customer master key. The
Encrypt
function has two primary use cases:-
You can encrypt up to 4 KB of arbitrary data such as an RSA key, a database password, or other sensitive customer information.
-
If you are moving encrypted data from one region to another, you can use this API to encrypt in the new region the plaintext data key that was used to encrypt the data in the original region. This provides you with an encrypted copy of the data key that can be decrypted in the new region and used there to decrypt the encrypted data.
Unless you are moving encrypted data from one region to another, you don't use this function to encrypt a generated data key within a region. You retrieve data keys already encrypted by calling the GenerateDataKey or GenerateDataKeyWithoutPlaintext function. Data keys don't need to be encrypted again by calling
Encrypt
.If you want to encrypt data locally in your application, you can use the
GenerateDataKey
function to return a plaintext data encryption key and a copy of the key encrypted under the customer master key (CMK) of your choosing.- Specified by:
encryptAsync
in interfaceAWSKMSAsync
- Parameters:
request
-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.- Returns:
- A Java Future containing the result of the Encrypt operation returned by the service.
-
-
generateDataKeyAsync
Description copied from interface: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 theCiphertextBlob
field. The key is encrypted by using the master key specified by theKeyId
field. To decrypt the encrypted key, pass it to theDecrypt
API.We recommend that you use the following pattern to locally encrypt data: call the
GenerateDataKey
API, use the key returned in thePlaintext
response field to locally encrypt data, and then erase the plaintext data key from memory. Store the encrypted data key (contained in theCiphertextBlob
field) alongside of the locally encrypted data.You should not call the
Encrypt
function to re-encrypt your data keys within a region.GenerateDataKey
always returns the data key encrypted and tied to the customer master key that will be used to decrypt it. There is no need to decrypt it twice.If you decide to use the optional
EncryptionContext
parameter, you must also store the context in full or at least store enough information along with the encrypted data to be able to reconstruct the context when submitting the ciphertext to theDecrypt
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.- Specified by:
generateDataKeyAsync
in interfaceAWSKMSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the GenerateDataKey operation returned by the service.
-
generateDataKeyAsync
public Future<GenerateDataKeyResult> generateDataKeyAsync(GenerateDataKeyRequest request, AsyncHandler<GenerateDataKeyRequest, GenerateDataKeyResult> asyncHandler) Description copied from interface: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 theCiphertextBlob
field. The key is encrypted by using the master key specified by theKeyId
field. To decrypt the encrypted key, pass it to theDecrypt
API.We recommend that you use the following pattern to locally encrypt data: call the
GenerateDataKey
API, use the key returned in thePlaintext
response field to locally encrypt data, and then erase the plaintext data key from memory. Store the encrypted data key (contained in theCiphertextBlob
field) alongside of the locally encrypted data.You should not call the
Encrypt
function to re-encrypt your data keys within a region.GenerateDataKey
always returns the data key encrypted and tied to the customer master key that will be used to decrypt it. There is no need to decrypt it twice.If you decide to use the optional
EncryptionContext
parameter, you must also store the context in full or at least store enough information along with the encrypted data to be able to reconstruct the context when submitting the ciphertext to theDecrypt
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.- Specified by:
generateDataKeyAsync
in interfaceAWSKMSAsync
- Parameters:
request
-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.- Returns:
- A Java Future containing the result of the GenerateDataKey operation returned by the service.
-
generateDataKeyWithoutPlaintextAsync
public Future<GenerateDataKeyWithoutPlaintextResult> generateDataKeyWithoutPlaintextAsync(GenerateDataKeyWithoutPlaintextRequest request) Description copied from interface: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.
- Specified by:
generateDataKeyWithoutPlaintextAsync
in interfaceAWSKMSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the GenerateDataKeyWithoutPlaintext operation returned by the service.
-
generateDataKeyWithoutPlaintextAsync
public Future<GenerateDataKeyWithoutPlaintextResult> generateDataKeyWithoutPlaintextAsync(GenerateDataKeyWithoutPlaintextRequest request, AsyncHandler<GenerateDataKeyWithoutPlaintextRequest, GenerateDataKeyWithoutPlaintextResult> asyncHandler) Description copied from interface: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.
- Specified by:
generateDataKeyWithoutPlaintextAsync
in interfaceAWSKMSAsync
- Parameters:
request
-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.- Returns:
- A Java Future containing the result of the GenerateDataKeyWithoutPlaintext operation returned by the service.
-
generateRandomAsync
Description copied from interface:AWSKMSAsync
Generates an unpredictable byte string.
- Specified by:
generateRandomAsync
in interfaceAWSKMSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the GenerateRandom operation returned by the service.
-
generateRandomAsync
public Future<GenerateRandomResult> generateRandomAsync(GenerateRandomRequest request, AsyncHandler<GenerateRandomRequest, GenerateRandomResult> asyncHandler) Description copied from interface:AWSKMSAsync
Generates an unpredictable byte string.
- Specified by:
generateRandomAsync
in interfaceAWSKMSAsync
- Parameters:
request
-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.- Returns:
- A Java Future containing the result of the GenerateRandom operation returned by the service.
-
generateRandomAsync
Simplified method form for invoking the GenerateRandom operation.- Specified by:
generateRandomAsync
in interfaceAWSKMSAsync
- See Also:
-
generateRandomAsync
public Future<GenerateRandomResult> generateRandomAsync(AsyncHandler<GenerateRandomRequest, GenerateRandomResult> asyncHandler) Simplified method form for invoking the GenerateRandom operation with an AsyncHandler.- Specified by:
generateRandomAsync
in interfaceAWSKMSAsync
- See Also:
-
getKeyPolicyAsync
Description copied from interface:AWSKMSAsync
Retrieves a policy attached to the specified key.
- Specified by:
getKeyPolicyAsync
in interfaceAWSKMSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the GetKeyPolicy operation returned by the service.
-
getKeyPolicyAsync
public Future<GetKeyPolicyResult> getKeyPolicyAsync(GetKeyPolicyRequest request, AsyncHandler<GetKeyPolicyRequest, GetKeyPolicyResult> asyncHandler) Description copied from interface:AWSKMSAsync
Retrieves a policy attached to the specified key.
- Specified by:
getKeyPolicyAsync
in interfaceAWSKMSAsync
- Parameters:
request
-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.- Returns:
- A Java Future containing the result of the GetKeyPolicy operation returned by the service.
-
getKeyRotationStatusAsync
public Future<GetKeyRotationStatusResult> getKeyRotationStatusAsync(GetKeyRotationStatusRequest request) Description copied from interface:AWSKMSAsync
Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.
- Specified by:
getKeyRotationStatusAsync
in interfaceAWSKMSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the GetKeyRotationStatus operation returned by the service.
-
getKeyRotationStatusAsync
public Future<GetKeyRotationStatusResult> getKeyRotationStatusAsync(GetKeyRotationStatusRequest request, AsyncHandler<GetKeyRotationStatusRequest, GetKeyRotationStatusResult> asyncHandler) Description copied from interface:AWSKMSAsync
Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.
- Specified by:
getKeyRotationStatusAsync
in interfaceAWSKMSAsync
- Parameters:
request
-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.- Returns:
- A Java Future containing the result of the GetKeyRotationStatus operation returned by the service.
-
listAliasesAsync
Description copied from interface:AWSKMSAsync
Lists all of the key aliases in the account.
- Specified by:
listAliasesAsync
in interfaceAWSKMSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the ListAliases operation returned by the service.
-
listAliasesAsync
public Future<ListAliasesResult> listAliasesAsync(ListAliasesRequest request, AsyncHandler<ListAliasesRequest, ListAliasesResult> asyncHandler) Description copied from interface:AWSKMSAsync
Lists all of the key aliases in the account.
- Specified by:
listAliasesAsync
in interfaceAWSKMSAsync
- Parameters:
request
-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.- Returns:
- A Java Future containing the result of the ListAliases operation returned by the service.
-
listAliasesAsync
Simplified method form for invoking the ListAliases operation.- Specified by:
listAliasesAsync
in interfaceAWSKMSAsync
- See Also:
-
listAliasesAsync
public Future<ListAliasesResult> listAliasesAsync(AsyncHandler<ListAliasesRequest, ListAliasesResult> asyncHandler) Simplified method form for invoking the ListAliases operation with an AsyncHandler.- Specified by:
listAliasesAsync
in interfaceAWSKMSAsync
- See Also:
-
listGrantsAsync
Description copied from interface:AWSKMSAsync
List the grants for a specified key.
- Specified by:
listGrantsAsync
in interfaceAWSKMSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the ListGrants operation returned by the service.
-
listGrantsAsync
public Future<ListGrantsResult> listGrantsAsync(ListGrantsRequest request, AsyncHandler<ListGrantsRequest, ListGrantsResult> asyncHandler) Description copied from interface:AWSKMSAsync
List the grants for a specified key.
- Specified by:
listGrantsAsync
in interfaceAWSKMSAsync
- Parameters:
request
-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.- Returns:
- A Java Future containing the result of the ListGrants operation returned by the service.
-
listKeyPoliciesAsync
Description copied from interface:AWSKMSAsync
Retrieves a list of policies attached to a key.
- Specified by:
listKeyPoliciesAsync
in interfaceAWSKMSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the ListKeyPolicies operation returned by the service.
-
listKeyPoliciesAsync
public Future<ListKeyPoliciesResult> listKeyPoliciesAsync(ListKeyPoliciesRequest request, AsyncHandler<ListKeyPoliciesRequest, ListKeyPoliciesResult> asyncHandler) Description copied from interface:AWSKMSAsync
Retrieves a list of policies attached to a key.
- Specified by:
listKeyPoliciesAsync
in interfaceAWSKMSAsync
- Parameters:
request
-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.- Returns:
- A Java Future containing the result of the ListKeyPolicies operation returned by the service.
-
listKeysAsync
Description copied from interface:AWSKMSAsync
Lists the customer master keys.
- Specified by:
listKeysAsync
in interfaceAWSKMSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the ListKeys operation returned by the service.
-
listKeysAsync
public Future<ListKeysResult> listKeysAsync(ListKeysRequest request, AsyncHandler<ListKeysRequest, ListKeysResult> asyncHandler) Description copied from interface:AWSKMSAsync
Lists the customer master keys.
- Specified by:
listKeysAsync
in interfaceAWSKMSAsync
- Parameters:
request
-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.- Returns:
- A Java Future containing the result of the ListKeys operation returned by the service.
-
listKeysAsync
Simplified method form for invoking the ListKeys operation.- Specified by:
listKeysAsync
in interfaceAWSKMSAsync
- See Also:
-
listKeysAsync
public Future<ListKeysResult> listKeysAsync(AsyncHandler<ListKeysRequest, ListKeysResult> asyncHandler) Simplified method form for invoking the ListKeys operation with an AsyncHandler.- Specified by:
listKeysAsync
in interfaceAWSKMSAsync
- See Also:
-
listRetirableGrantsAsync
public Future<ListRetirableGrantsResult> listRetirableGrantsAsync(ListRetirableGrantsRequest request) Description copied from interface: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.
- Specified by:
listRetirableGrantsAsync
in interfaceAWSKMSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the ListRetirableGrants operation returned by the service.
-
listRetirableGrantsAsync
public Future<ListRetirableGrantsResult> listRetirableGrantsAsync(ListRetirableGrantsRequest request, AsyncHandler<ListRetirableGrantsRequest, ListRetirableGrantsResult> asyncHandler) Description copied from interface: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.
- Specified by:
listRetirableGrantsAsync
in interfaceAWSKMSAsync
- Parameters:
request
-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.- Returns:
- A Java Future containing the result of the ListRetirableGrants operation returned by the service.
-
putKeyPolicyAsync
Description copied from interface:AWSKMSAsync
Attaches a key policy to the specified customer master key (CMK).
For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.
- Specified by:
putKeyPolicyAsync
in interfaceAWSKMSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the PutKeyPolicy operation returned by the service.
-
putKeyPolicyAsync
public Future<PutKeyPolicyResult> putKeyPolicyAsync(PutKeyPolicyRequest request, AsyncHandler<PutKeyPolicyRequest, PutKeyPolicyResult> asyncHandler) Description copied from interface:AWSKMSAsync
Attaches a key policy to the specified customer master key (CMK).
For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.
- Specified by:
putKeyPolicyAsync
in interfaceAWSKMSAsync
- Parameters:
request
-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.- Returns:
- A Java Future containing the result of the PutKeyPolicy operation returned by the service.
-
reEncryptAsync
Description copied from interface: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 asReEncryptFrom
on the source key and once asReEncryptTo
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.- Specified by:
reEncryptAsync
in interfaceAWSKMSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the ReEncrypt operation returned by the service.
-
reEncryptAsync
public Future<ReEncryptResult> reEncryptAsync(ReEncryptRequest request, AsyncHandler<ReEncryptRequest, ReEncryptResult> asyncHandler) Description copied from interface: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 asReEncryptFrom
on the source key and once asReEncryptTo
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.- Specified by:
reEncryptAsync
in interfaceAWSKMSAsync
- Parameters:
request
-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.- Returns:
- A Java Future containing the result of the ReEncrypt operation returned by the service.
-
retireGrantAsync
Description copied from interface: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:
-
The account that created the grant
-
The
RetiringPrincipal
, if present -
The
GranteePrincipal
, ifRetireGrant
is a grantee operation
The grant to retire must be identified by its grant token or by a combination of the key ARN and the grant ID. A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. Both are returned by the
CreateGrant
function.- Specified by:
retireGrantAsync
in interfaceAWSKMSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the RetireGrant operation returned by the service.
-
-
retireGrantAsync
public Future<RetireGrantResult> retireGrantAsync(RetireGrantRequest request, AsyncHandler<RetireGrantRequest, RetireGrantResult> asyncHandler) Description copied from interface: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:
-
The account that created the grant
-
The
RetiringPrincipal
, if present -
The
GranteePrincipal
, ifRetireGrant
is a grantee operation
The grant to retire must be identified by its grant token or by a combination of the key ARN and the grant ID. A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. Both are returned by the
CreateGrant
function.- Specified by:
retireGrantAsync
in interfaceAWSKMSAsync
- Parameters:
request
-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.- Returns:
- A Java Future containing the result of the RetireGrant operation returned by the service.
-
-
retireGrantAsync
Simplified method form for invoking the RetireGrant operation.- Specified by:
retireGrantAsync
in interfaceAWSKMSAsync
- See Also:
-
retireGrantAsync
public Future<RetireGrantResult> retireGrantAsync(AsyncHandler<RetireGrantRequest, RetireGrantResult> asyncHandler) Simplified method form for invoking the RetireGrant operation with an AsyncHandler.- Specified by:
retireGrantAsync
in interfaceAWSKMSAsync
- See Also:
-
revokeGrantAsync
Description copied from interface:AWSKMSAsync
Revokes a grant. You can revoke a grant to actively deny operations that depend on it.
- Specified by:
revokeGrantAsync
in interfaceAWSKMSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the RevokeGrant operation returned by the service.
-
revokeGrantAsync
public Future<RevokeGrantResult> revokeGrantAsync(RevokeGrantRequest request, AsyncHandler<RevokeGrantRequest, RevokeGrantResult> asyncHandler) Description copied from interface:AWSKMSAsync
Revokes a grant. You can revoke a grant to actively deny operations that depend on it.
- Specified by:
revokeGrantAsync
in interfaceAWSKMSAsync
- Parameters:
request
-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.- Returns:
- A Java Future containing the result of the RevokeGrant operation returned by the service.
-
scheduleKeyDeletionAsync
public Future<ScheduleKeyDeletionResult> scheduleKeyDeletionAsync(ScheduleKeyDeletionRequest request) Description copied from interface: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, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
- Specified by:
scheduleKeyDeletionAsync
in interfaceAWSKMSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the ScheduleKeyDeletion operation returned by the service.
-
scheduleKeyDeletionAsync
public Future<ScheduleKeyDeletionResult> scheduleKeyDeletionAsync(ScheduleKeyDeletionRequest request, AsyncHandler<ScheduleKeyDeletionRequest, ScheduleKeyDeletionResult> asyncHandler) Description copied from interface: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, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
- Specified by:
scheduleKeyDeletionAsync
in interfaceAWSKMSAsync
- Parameters:
request
-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.- Returns:
- A Java Future containing the result of the ScheduleKeyDeletion operation returned by the service.
-
updateAliasAsync
Description copied from interface: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.
- Specified by:
updateAliasAsync
in interfaceAWSKMSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the UpdateAlias operation returned by the service.
-
updateAliasAsync
public Future<UpdateAliasResult> updateAliasAsync(UpdateAliasRequest request, AsyncHandler<UpdateAliasRequest, UpdateAliasResult> asyncHandler) Description copied from interface: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.
- Specified by:
updateAliasAsync
in interfaceAWSKMSAsync
- Parameters:
request
-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.- Returns:
- A Java Future containing the result of the UpdateAlias operation returned by the service.
-
updateKeyDescriptionAsync
public Future<UpdateKeyDescriptionResult> updateKeyDescriptionAsync(UpdateKeyDescriptionRequest request) Description copied from interface:AWSKMSAsync
Updates the description of a key.
- Specified by:
updateKeyDescriptionAsync
in interfaceAWSKMSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the UpdateKeyDescription operation returned by the service.
-
updateKeyDescriptionAsync
public Future<UpdateKeyDescriptionResult> updateKeyDescriptionAsync(UpdateKeyDescriptionRequest request, AsyncHandler<UpdateKeyDescriptionRequest, UpdateKeyDescriptionResult> asyncHandler) Description copied from interface:AWSKMSAsync
Updates the description of a key.
- Specified by:
updateKeyDescriptionAsync
in interfaceAWSKMSAsync
- Parameters:
request
-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.- Returns:
- A Java Future containing the result of the UpdateKeyDescription operation returned by the service.
-
shutdown
public void shutdown()Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should callgetExecutorService().shutdown()
followed bygetExecutorService().awaitTermination()
prior to calling this method.- Specified by:
shutdown
in interfaceAWSKMS
- Overrides:
shutdown
in classAmazonWebServiceClient
-