@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") 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 (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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Constructor and Description |
---|
AWSKMSAsyncClient()
Deprecated.
|
AWSKMSAsyncClient(AWSCredentials awsCredentials)
Deprecated.
|
AWSKMSAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AWSKMSAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
|
AWSKMSAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSKMSAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSKMSAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AWSKMSAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
|
AWSKMSAsyncClient(ClientConfiguration clientConfiguration)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static AWSKMSAsyncClientBuilder |
asyncBuilder() |
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<CreateAliasResult> |
createAliasAsync(CreateAliasRequest request)
Creates a display name for a customer master key.
|
Future<CreateAliasResult> |
createAliasAsync(CreateAliasRequest request,
AsyncHandler<CreateAliasRequest,CreateAliasResult> 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 (CMK).
|
Future<CreateKeyResult> |
createKeyAsync(CreateKeyRequest request,
AsyncHandler<CreateKeyRequest,CreateKeyResult> asyncHandler)
Creates a customer master key (CMK).
|
Future<DecryptResult> |
decryptAsync(DecryptRequest request)
Decrypts ciphertext.
|
Future<DecryptResult> |
decryptAsync(DecryptRequest request,
AsyncHandler<DecryptRequest,DecryptResult> asyncHandler)
Decrypts ciphertext.
|
Future<DeleteAliasResult> |
deleteAliasAsync(DeleteAliasRequest request)
Deletes the specified alias.
|
Future<DeleteAliasResult> |
deleteAliasAsync(DeleteAliasRequest request,
AsyncHandler<DeleteAliasRequest,DeleteAliasResult> asyncHandler)
Deletes the specified alias.
|
Future<DeleteImportedKeyMaterialResult> |
deleteImportedKeyMaterialAsync(DeleteImportedKeyMaterialRequest request)
Deletes key material that you previously imported and makes the specified customer master key (CMK) unusable.
|
Future<DeleteImportedKeyMaterialResult> |
deleteImportedKeyMaterialAsync(DeleteImportedKeyMaterialRequest request,
AsyncHandler<DeleteImportedKeyMaterialRequest,DeleteImportedKeyMaterialResult> asyncHandler)
Deletes key material that you previously imported and makes the specified customer master key (CMK) unusable.
|
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<DisableKeyResult> |
disableKeyAsync(DisableKeyRequest request)
Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic
operations.
|
Future<DisableKeyResult> |
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.
|
Future<DisableKeyRotationResult> |
disableKeyRotationAsync(DisableKeyRotationRequest request)
Disables rotation of the specified key.
|
Future<DisableKeyRotationResult> |
disableKeyRotationAsync(DisableKeyRotationRequest request,
AsyncHandler<DisableKeyRotationRequest,DisableKeyRotationResult> asyncHandler)
Disables rotation of the specified key.
|
Future<EnableKeyResult> |
enableKeyAsync(EnableKeyRequest request)
Marks a key as enabled, thereby permitting its use.
|
Future<EnableKeyResult> |
enableKeyAsync(EnableKeyRequest request,
AsyncHandler<EnableKeyRequest,EnableKeyResult> asyncHandler)
Marks a key as enabled, thereby permitting its use.
|
Future<EnableKeyRotationResult> |
enableKeyRotationAsync(EnableKeyRotationRequest request)
Enables rotation of the specified customer master key.
|
Future<EnableKeyRotationResult> |
enableKeyRotationAsync(EnableKeyRotationRequest request,
AsyncHandler<EnableKeyRotationRequest,EnableKeyRotationResult> 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)
Returns a data encryption key that you can use in your application to encrypt data locally.
|
Future<GenerateDataKeyResult> |
generateDataKeyAsync(GenerateDataKeyRequest request,
AsyncHandler<GenerateDataKeyRequest,GenerateDataKeyResult> asyncHandler)
Returns a data encryption key that you can use in your application to encrypt data locally.
|
Future<GenerateDataKeyWithoutPlaintextResult> |
generateDataKeyWithoutPlaintextAsync(GenerateDataKeyWithoutPlaintextRequest request)
Returns a data encryption key encrypted under a customer master key (CMK).
|
Future<GenerateDataKeyWithoutPlaintextResult> |
generateDataKeyWithoutPlaintextAsync(GenerateDataKeyWithoutPlaintextRequest request,
AsyncHandler<GenerateDataKeyWithoutPlaintextRequest,GenerateDataKeyWithoutPlaintextResult> asyncHandler)
Returns a data encryption key encrypted under a customer master key (CMK).
|
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)
Returns a random byte string that is cryptographically secure.
|
Future<GenerateRandomResult> |
generateRandomAsync(GenerateRandomRequest request,
AsyncHandler<GenerateRandomRequest,GenerateRandomResult> asyncHandler)
Returns a random byte string that is cryptographically secure.
|
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<GetParametersForImportResult> |
getParametersForImportAsync(GetParametersForImportRequest request)
Returns the items you need in order to import key material into AWS KMS from your existing key management
infrastructure.
|
Future<GetParametersForImportResult> |
getParametersForImportAsync(GetParametersForImportRequest request,
AsyncHandler<GetParametersForImportRequest,GetParametersForImportResult> asyncHandler)
Returns the items you need in order to import key material into AWS KMS from your existing key management
infrastructure.
|
Future<ImportKeyMaterialResult> |
importKeyMaterialAsync(ImportKeyMaterialRequest request)
Imports key material into an AWS KMS customer master key (CMK) from your existing key management infrastructure.
|
Future<ImportKeyMaterialResult> |
importKeyMaterialAsync(ImportKeyMaterialRequest request,
AsyncHandler<ImportKeyMaterialRequest,ImportKeyMaterialResult> asyncHandler)
Imports key material into an AWS KMS customer master key (CMK) from your existing key management infrastructure.
|
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<ListResourceTagsResult> |
listResourceTagsAsync(ListResourceTagsRequest request)
Returns a list of all tags for the specified customer master key (CMK).
|
Future<ListResourceTagsResult> |
listResourceTagsAsync(ListResourceTagsRequest request,
AsyncHandler<ListResourceTagsRequest,ListResourceTagsResult> asyncHandler)
Returns a list of all tags for the specified customer master key (CMK).
|
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<PutKeyPolicyResult> |
putKeyPolicyAsync(PutKeyPolicyRequest request)
Attaches a key policy to the specified customer master key (CMK).
|
Future<PutKeyPolicyResult> |
putKeyPolicyAsync(PutKeyPolicyRequest request,
AsyncHandler<PutKeyPolicyRequest,PutKeyPolicyResult> asyncHandler)
Attaches a key policy to the specified customer master key (CMK).
|
Future<ReEncryptResult> |
reEncryptAsync(ReEncryptRequest request)
Encrypts data on the server side with a new customer master key (CMK) 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 (CMK) without exposing the plaintext of the data
on the client side.
|
Future<RetireGrantResult> |
retireGrantAsync()
Simplified method form for invoking the RetireGrant operation.
|
Future<RetireGrantResult> |
retireGrantAsync(AsyncHandler<RetireGrantRequest,RetireGrantResult> asyncHandler)
Simplified method form for invoking the RetireGrant operation with an AsyncHandler.
|
Future<RetireGrantResult> |
retireGrantAsync(RetireGrantRequest request)
Retires a grant.
|
Future<RetireGrantResult> |
retireGrantAsync(RetireGrantRequest request,
AsyncHandler<RetireGrantRequest,RetireGrantResult> asyncHandler)
Retires a grant.
|
Future<RevokeGrantResult> |
revokeGrantAsync(RevokeGrantRequest request)
Revokes a grant.
|
Future<RevokeGrantResult> |
revokeGrantAsync(RevokeGrantRequest request,
AsyncHandler<RevokeGrantRequest,RevokeGrantResult> 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<TagResourceResult> |
tagResourceAsync(TagResourceRequest request)
Adds or overwrites one or more tags for the specified customer master key (CMK).
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest request,
AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Adds or overwrites one or more tags for the specified customer master key (CMK).
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest request)
Removes the specified tag or tags from the specified customer master key (CMK).
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest request,
AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes the specified tag or tags from the specified customer master key (CMK).
|
Future<UpdateAliasResult> |
updateAliasAsync(UpdateAliasRequest request)
Updates an alias to map it to a different key.
|
Future<UpdateAliasResult> |
updateAliasAsync(UpdateAliasRequest request,
AsyncHandler<UpdateAliasRequest,UpdateAliasResult> asyncHandler)
Updates an alias to map it to a different key.
|
Future<UpdateKeyDescriptionResult> |
updateKeyDescriptionAsync(UpdateKeyDescriptionRequest request)
Updates the description of a customer master key (CMK).
|
Future<UpdateKeyDescriptionResult> |
updateKeyDescriptionAsync(UpdateKeyDescriptionRequest request,
AsyncHandler<UpdateKeyDescriptionRequest,UpdateKeyDescriptionResult> asyncHandler)
Updates the description of a customer master key (CMK).
|
builder, cancelKeyDeletion, createAlias, createGrant, createKey, createKey, decrypt, deleteAlias, deleteImportedKeyMaterial, describeKey, disableKey, disableKeyRotation, enableKey, enableKeyRotation, encrypt, generateDataKey, generateDataKeyWithoutPlaintext, generateRandom, generateRandom, getCachedResponseMetadata, getKeyPolicy, getKeyRotationStatus, getParametersForImport, importKeyMaterial, listAliases, listAliases, listGrants, listKeyPolicies, listKeys, listKeys, listResourceTags, listRetirableGrants, putKeyPolicy, reEncrypt, retireGrant, retireGrant, revokeGrant, scheduleKeyDeletion, tagResource, untagResource, updateAlias, updateKeyDescription
addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
cancelKeyDeletion, createAlias, createGrant, createKey, createKey, decrypt, deleteAlias, deleteImportedKeyMaterial, describeKey, disableKey, disableKeyRotation, enableKey, enableKeyRotation, encrypt, generateDataKey, generateDataKeyWithoutPlaintext, generateRandom, generateRandom, getCachedResponseMetadata, getKeyPolicy, getKeyRotationStatus, getParametersForImport, importKeyMaterial, listAliases, listAliases, listGrants, listKeyPolicies, listKeys, listKeys, listResourceTags, listRetirableGrants, putKeyPolicy, reEncrypt, retireGrant, retireGrant, revokeGrant, scheduleKeyDeletion, setEndpoint, setRegion, tagResource, untagResource, updateAlias, updateKeyDescription
@Deprecated public AWSKMSAsyncClient()
AWSKMSAsyncClientBuilder.defaultClient()
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).
@Deprecated public AWSKMSAsyncClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(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)
@Deprecated public AWSKMSAsyncClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(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).
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.Executors.newFixedThreadPool(int)
@Deprecated public AWSKMSAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
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.@Deprecated public AWSKMSAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
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.@Deprecated public AWSKMSAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(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)
@Deprecated public AWSKMSAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(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)
@Deprecated public AWSKMSAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
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.@Deprecated public AWSKMSAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
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 static AWSKMSAsyncClientBuilder asyncBuilder()
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, see 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, see 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<CreateAliasResult> 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<CreateAliasResult> createAliasAsync(CreateAliasRequest request, AsyncHandler<CreateAliasRequest,CreateAliasResult> 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 (CMK).
You can use a CMK to encrypt small amounts of data (4 KiB or less) directly, but CMKs are more commonly used to encrypt data encryption keys (DEKs), which are used to encrypt raw data. For more information about DEKs and the difference between CMKs and DEKs, see the following:
The GenerateDataKey operation
AWS Key Management Service Concepts in the AWS Key Management Service Developer Guide
createKeyAsync
in interface AWSKMSAsync
public Future<CreateKeyResult> createKeyAsync(CreateKeyRequest request, AsyncHandler<CreateKeyRequest,CreateKeyResult> asyncHandler)
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
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<DeleteAliasResult> deleteAliasAsync(DeleteAliasRequest request)
AWSKMSAsync
Deletes the specified alias. To map an alias to a different key, call UpdateAlias.
deleteAliasAsync
in interface AWSKMSAsync
public Future<DeleteAliasResult> deleteAliasAsync(DeleteAliasRequest request, AsyncHandler<DeleteAliasRequest,DeleteAliasResult> 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<DeleteImportedKeyMaterialResult> deleteImportedKeyMaterialAsync(DeleteImportedKeyMaterialRequest request)
AWSKMSAsync
Deletes key material that you previously imported and makes the specified customer master key (CMK) unusable. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.
When the specified CMK is in the PendingDeletion
state, this operation does not change the CMK's
state. Otherwise, it changes the CMK's state to PendingImport
.
After you delete key material, you can use ImportKeyMaterial to reimport the same key material into the CMK.
deleteImportedKeyMaterialAsync
in interface AWSKMSAsync
public Future<DeleteImportedKeyMaterialResult> deleteImportedKeyMaterialAsync(DeleteImportedKeyMaterialRequest request, AsyncHandler<DeleteImportedKeyMaterialRequest,DeleteImportedKeyMaterialResult> asyncHandler)
AWSKMSAsync
Deletes key material that you previously imported and makes the specified customer master key (CMK) unusable. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.
When the specified CMK is in the PendingDeletion
state, this operation does not change the CMK's
state. Otherwise, it changes the CMK's state to PendingImport
.
After you delete key material, you can use ImportKeyMaterial to reimport the same key material into the CMK.
deleteImportedKeyMaterialAsync
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<DisableKeyResult> disableKeyAsync(DisableKeyRequest request)
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.
disableKeyAsync
in interface AWSKMSAsync
public Future<DisableKeyResult> disableKeyAsync(DisableKeyRequest request, AsyncHandler<DisableKeyRequest,DisableKeyResult> asyncHandler)
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.
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<DisableKeyRotationResult> disableKeyRotationAsync(DisableKeyRotationRequest request)
AWSKMSAsync
Disables rotation of the specified key.
disableKeyRotationAsync
in interface AWSKMSAsync
public Future<DisableKeyRotationResult> disableKeyRotationAsync(DisableKeyRotationRequest request, AsyncHandler<DisableKeyRotationRequest,DisableKeyRotationResult> 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<EnableKeyResult> enableKeyAsync(EnableKeyRequest request)
AWSKMSAsync
Marks a key as enabled, thereby permitting its use.
enableKeyAsync
in interface AWSKMSAsync
public Future<EnableKeyResult> enableKeyAsync(EnableKeyRequest request, AsyncHandler<EnableKeyRequest,EnableKeyResult> 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<EnableKeyRotationResult> enableKeyRotationAsync(EnableKeyRotationRequest request)
AWSKMSAsync
Enables rotation of the specified customer master key.
enableKeyRotationAsync
in interface AWSKMSAsync
public Future<EnableKeyRotationResult> enableKeyRotationAsync(EnableKeyRotationRequest request, AsyncHandler<EnableKeyRotationRequest,EnableKeyRotationResult> 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:
You can encrypt up to 4 KB of arbitrary data such as an RSA key, a database password, or other sensitive customer information.
If you are moving encrypted data from one region to another, you can use this API to encrypt in the new region the plaintext data key that was used to encrypt the data in the original region. This provides you with an encrypted copy of the data key that can be decrypted in the new region and used there to decrypt the encrypted data.
Unless you are moving encrypted data from one region to another, you don't use this function to encrypt a
generated data key within a region. You retrieve data keys already encrypted by calling the
GenerateDataKey or GenerateDataKeyWithoutPlaintext function. Data keys don't need to be encrypted
again by calling Encrypt
.
If you want to encrypt data locally in your application, you can use the GenerateDataKey
function to
return a plaintext data encryption key and a copy of the key encrypted under the customer master key (CMK) of
your choosing.
encryptAsync
in interface 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:
You can encrypt up to 4 KB of arbitrary data such as an RSA key, a database password, or other sensitive customer information.
If you are moving encrypted data from one region to another, you can use this API to encrypt in the new region the plaintext data key that was used to encrypt the data in the original region. This provides you with an encrypted copy of the data key that can be decrypted in the new region and used there to decrypt the encrypted data.
Unless you are moving encrypted data from one region to another, you don't use this function to encrypt a
generated data key within a region. You retrieve data keys already encrypted by calling the
GenerateDataKey or GenerateDataKeyWithoutPlaintext function. Data keys don't need to be encrypted
again by calling Encrypt
.
If you want to encrypt data locally in your application, you can use the GenerateDataKey
function to
return a plaintext data encryption key and a copy of the key encrypted under the customer master key (CMK) of
your choosing.
encryptAsync
in interface 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
Returns a data encryption key that you can use in your application to encrypt data locally.
You must specify the customer master key (CMK) under which to generate the data key. You must also specify the
length of the data key using either the KeySpec
or NumberOfBytes
field. You must
specify one field or the other, but not both. For common key lengths (128-bit and 256-bit symmetric keys), we
recommend that you use KeySpec
.
This operation returns a plaintext copy of the data key in the Plaintext
field of the response, and
an encrypted copy of the data key in the CiphertextBlob
field. The data key is encrypted under the
CMK specified in the KeyId
field of the request.
We recommend that you use the following pattern to encrypt data locally in your application:
Use this operation (GenerateDataKey
) to retrieve a data encryption key.
Use the plaintext data encryption key (returned in the Plaintext
field of the response) to encrypt
data locally, then erase the plaintext data key from memory.
Store the encrypted data key (returned in the CiphertextBlob
field of the response) alongside the
locally encrypted data.
To decrypt data locally:
Use the Decrypt operation to decrypt the encrypted data key into a plaintext copy of the data key.
Use the plaintext data key to decrypt data locally, then erase the plaintext data key from memory.
To return only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To return a random byte string that is cryptographically secure, use GenerateRandom.
If you use the optional EncryptionContext
field, you must store at least enough information to be
able to reconstruct the full encryption context when you later send the ciphertext to the Decrypt
operation. It is a good practice to choose an encryption context that you can reconstruct on the fly to better
secure the ciphertext. For more information, see Encryption Context in the
AWS Key Management Service Developer Guide.
generateDataKeyAsync
in interface AWSKMSAsync
public Future<GenerateDataKeyResult> generateDataKeyAsync(GenerateDataKeyRequest request, AsyncHandler<GenerateDataKeyRequest,GenerateDataKeyResult> asyncHandler)
AWSKMSAsync
Returns a data encryption key that you can use in your application to encrypt data locally.
You must specify the customer master key (CMK) under which to generate the data key. You must also specify the
length of the data key using either the KeySpec
or NumberOfBytes
field. You must
specify one field or the other, but not both. For common key lengths (128-bit and 256-bit symmetric keys), we
recommend that you use KeySpec
.
This operation returns a plaintext copy of the data key in the Plaintext
field of the response, and
an encrypted copy of the data key in the CiphertextBlob
field. The data key is encrypted under the
CMK specified in the KeyId
field of the request.
We recommend that you use the following pattern to encrypt data locally in your application:
Use this operation (GenerateDataKey
) to retrieve a data encryption key.
Use the plaintext data encryption key (returned in the Plaintext
field of the response) to encrypt
data locally, then erase the plaintext data key from memory.
Store the encrypted data key (returned in the CiphertextBlob
field of the response) alongside the
locally encrypted data.
To decrypt data locally:
Use the Decrypt operation to decrypt the encrypted data key into a plaintext copy of the data key.
Use the plaintext data key to decrypt data locally, then erase the plaintext data key from memory.
To return only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To return a random byte string that is cryptographically secure, use GenerateRandom.
If you use the optional EncryptionContext
field, you must store at least enough information to be
able to reconstruct the full encryption context when you later send the ciphertext to the Decrypt
operation. It is a good practice to choose an encryption context that you can reconstruct on the fly to better
secure the ciphertext. For more information, see Encryption Context in the
AWS Key Management Service Developer Guide.
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 encryption key encrypted under a customer master key (CMK). This operation is identical to GenerateDataKey but returns only the encrypted copy of the data key.
This operation is useful in a system that has multiple components with different degrees of trust. For example,
consider a system that stores encrypted data in containers. Each container stores the encrypted data and an
encrypted copy of the data key. One component of the system, called the control plane, creates new
containers. When it creates a new container, it uses this operation (GenerateDataKeyWithoutPlaintext
) to get an encrypted data key and then stores it in the container. Later, a different component of the system,
called the data plane, puts encrypted data into the containers. To do this, it passes the encrypted data
key to the Decrypt operation, then uses the returned plaintext data key to encrypt data, and finally
stores the encrypted data in the container. In this system, the control plane never sees the plaintext data key.
generateDataKeyWithoutPlaintextAsync
in interface AWSKMSAsync
public Future<GenerateDataKeyWithoutPlaintextResult> generateDataKeyWithoutPlaintextAsync(GenerateDataKeyWithoutPlaintextRequest request, AsyncHandler<GenerateDataKeyWithoutPlaintextRequest,GenerateDataKeyWithoutPlaintextResult> asyncHandler)
AWSKMSAsync
Returns a data encryption key encrypted under a customer master key (CMK). This operation is identical to GenerateDataKey but returns only the encrypted copy of the data key.
This operation is useful in a system that has multiple components with different degrees of trust. For example,
consider a system that stores encrypted data in containers. Each container stores the encrypted data and an
encrypted copy of the data key. One component of the system, called the control plane, creates new
containers. When it creates a new container, it uses this operation (GenerateDataKeyWithoutPlaintext
) to get an encrypted data key and then stores it in the container. Later, a different component of the system,
called the data plane, puts encrypted data into the containers. To do this, it passes the encrypted data
key to the Decrypt operation, then uses the returned plaintext data key to encrypt data, and finally
stores the encrypted data in the container. In this system, the control plane never sees the plaintext data key.
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
Returns a random byte string that is cryptographically secure.
For more information about entropy and random number generation, see the AWS Key Management Service Cryptographic Details whitepaper.
generateRandomAsync
in interface AWSKMSAsync
public Future<GenerateRandomResult> generateRandomAsync(GenerateRandomRequest request, AsyncHandler<GenerateRandomRequest,GenerateRandomResult> asyncHandler)
AWSKMSAsync
Returns a random byte string that is cryptographically secure.
For more information about entropy and random number generation, see the AWS Key Management Service Cryptographic Details whitepaper.
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<GetParametersForImportResult> getParametersForImportAsync(GetParametersForImportRequest request)
AWSKMSAsync
Returns the items you need in order to import key material into AWS KMS from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.
You must specify the key ID of the customer master key (CMK) into which you will import key material. This CMK's
Origin
must be EXTERNAL
. You must also specify the wrapping algorithm and type of
wrapping key (public key) that you will use to encrypt the key material.
This operation returns a public key and an import token. Use the public key to encrypt the key material. Store
the import token to send with a subsequent ImportKeyMaterial request. The public key and import token from
the same response must be used together. These items are valid for 24 hours, after which they cannot be used for
a subsequent ImportKeyMaterial request. To retrieve new ones, send another
GetParametersForImport
request.
getParametersForImportAsync
in interface AWSKMSAsync
public Future<GetParametersForImportResult> getParametersForImportAsync(GetParametersForImportRequest request, AsyncHandler<GetParametersForImportRequest,GetParametersForImportResult> asyncHandler)
AWSKMSAsync
Returns the items you need in order to import key material into AWS KMS from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.
You must specify the key ID of the customer master key (CMK) into which you will import key material. This CMK's
Origin
must be EXTERNAL
. You must also specify the wrapping algorithm and type of
wrapping key (public key) that you will use to encrypt the key material.
This operation returns a public key and an import token. Use the public key to encrypt the key material. Store
the import token to send with a subsequent ImportKeyMaterial request. The public key and import token from
the same response must be used together. These items are valid for 24 hours, after which they cannot be used for
a subsequent ImportKeyMaterial request. To retrieve new ones, send another
GetParametersForImport
request.
getParametersForImportAsync
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<ImportKeyMaterialResult> importKeyMaterialAsync(ImportKeyMaterialRequest request)
AWSKMSAsync
Imports key material into an AWS KMS customer master key (CMK) from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.
You must specify the key ID of the CMK to import the key material into. This CMK's Origin
must be
EXTERNAL
. You must also send an import token and the encrypted key material. Send the import token
that you received in the same GetParametersForImport response that contained the public key that you used
to encrypt the key material. You must also specify whether the key material expires and if so, when. When the key
material expires, AWS KMS deletes the key material and the CMK becomes unusable. To use the CMK again, you can
reimport the same key material. If you set an expiration date, you can change it only by reimporting the same key
material and specifying a new expiration date.
When this operation is successful, the specified CMK's key state changes to Enabled
, and you can use
the CMK.
After you successfully import key material into a CMK, you can reimport the same key material into that CMK, but you cannot import different key material.
importKeyMaterialAsync
in interface AWSKMSAsync
public Future<ImportKeyMaterialResult> importKeyMaterialAsync(ImportKeyMaterialRequest request, AsyncHandler<ImportKeyMaterialRequest,ImportKeyMaterialResult> asyncHandler)
AWSKMSAsync
Imports key material into an AWS KMS customer master key (CMK) from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.
You must specify the key ID of the CMK to import the key material into. This CMK's Origin
must be
EXTERNAL
. You must also send an import token and the encrypted key material. Send the import token
that you received in the same GetParametersForImport response that contained the public key that you used
to encrypt the key material. You must also specify whether the key material expires and if so, when. When the key
material expires, AWS KMS deletes the key material and the CMK becomes unusable. To use the CMK again, you can
reimport the same key material. If you set an expiration date, you can change it only by reimporting the same key
material and specifying a new expiration date.
When this operation is successful, the specified CMK's key state changes to Enabled
, and you can use
the CMK.
After you successfully import key material into a CMK, you can reimport the same key material into that CMK, but you cannot import different key material.
importKeyMaterialAsync
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<ListResourceTagsResult> listResourceTagsAsync(ListResourceTagsRequest request)
AWSKMSAsync
Returns a list of all tags for the specified customer master key (CMK).
listResourceTagsAsync
in interface AWSKMSAsync
public Future<ListResourceTagsResult> listResourceTagsAsync(ListResourceTagsRequest request, AsyncHandler<ListResourceTagsRequest,ListResourceTagsResult> asyncHandler)
AWSKMSAsync
Returns a list of all tags for the specified customer master key (CMK).
listResourceTagsAsync
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<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<PutKeyPolicyResult> putKeyPolicyAsync(PutKeyPolicyRequest request)
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.
putKeyPolicyAsync
in interface AWSKMSAsync
public Future<PutKeyPolicyResult> putKeyPolicyAsync(PutKeyPolicyRequest request, AsyncHandler<PutKeyPolicyRequest,PutKeyPolicyResult> asyncHandler)
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.
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 (CMK) without exposing the plaintext of the data on the client side. The data is first decrypted and then reencrypted. You can also use this operation to change the encryption context of a ciphertext.
Unlike other operations, ReEncrypt
is authorized twice, once as ReEncryptFrom
on the
source CMK and once as ReEncryptTo
on the destination CMK. We recommend that you include the
"kms:ReEncrypt*"
permission in your key policies to permit
reencryption from or to the CMK. This permission is automatically included in the key policy when you create a
CMK through the console, but you must include it manually when you create a CMK programmatically or when you set
a key policy with the PutKeyPolicy operation.
reEncryptAsync
in interface AWSKMSAsync
public Future<ReEncryptResult> reEncryptAsync(ReEncryptRequest request, AsyncHandler<ReEncryptRequest,ReEncryptResult> asyncHandler)
AWSKMSAsync
Encrypts data on the server side with a new customer master key (CMK) without exposing the plaintext of the data on the client side. The data is first decrypted and then reencrypted. You can also use this operation to change the encryption context of a ciphertext.
Unlike other operations, ReEncrypt
is authorized twice, once as ReEncryptFrom
on the
source CMK and once as ReEncryptTo
on the destination CMK. We recommend that you include the
"kms:ReEncrypt*"
permission in your key policies to permit
reencryption from or to the CMK. This permission is automatically included in the key policy when you create a
CMK through the console, but you must include it manually when you create a CMK programmatically or when you set
a key policy with the PutKeyPolicy operation.
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<RetireGrantResult> retireGrantAsync(RetireGrantRequest request)
AWSKMSAsync
Retires a grant. To clean up, you can retire a grant when you're done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:
The AWS account (root user) under which the grant was created
The RetiringPrincipal
, if present in the grant
The GranteePrincipal
, if RetireGrant
is an operation specified in the grant
You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The CreateGrant operation returns both.
retireGrantAsync
in interface AWSKMSAsync
public Future<RetireGrantResult> retireGrantAsync(RetireGrantRequest request, AsyncHandler<RetireGrantRequest,RetireGrantResult> asyncHandler)
AWSKMSAsync
Retires a grant. To clean up, you can retire a grant when you're done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:
The AWS account (root user) under which the grant was created
The RetiringPrincipal
, if present in the grant
The GranteePrincipal
, if RetireGrant
is an operation specified in the grant
You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The CreateGrant operation returns both.
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<RetireGrantResult> retireGrantAsync()
retireGrantAsync
in interface AWSKMSAsync
retireGrantAsync(RetireGrantRequest)
public Future<RetireGrantResult> retireGrantAsync(AsyncHandler<RetireGrantRequest,RetireGrantResult> asyncHandler)
retireGrantAsync
in interface AWSKMSAsync
retireGrantAsync(RetireGrantRequest, com.amazonaws.handlers.AsyncHandler)
public Future<RevokeGrantResult> 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<RevokeGrantResult> revokeGrantAsync(RevokeGrantRequest request, AsyncHandler<RevokeGrantRequest,RevokeGrantResult> 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 refer to it.
Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use DisableKey.
For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
scheduleKeyDeletionAsync
in interface 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 refer to it.
Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use DisableKey.
For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
scheduleKeyDeletionAsync
in interface 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<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AWSKMSAsync
Adds or overwrites one or more tags for the specified customer master key (CMK).
Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
You cannot use the same tag key more than once per CMK. For example, consider a CMK with one tag whose tag key is
Purpose
and tag value is Test
. If you send a TagResource
request for this
CMK with a tag key of Purpose
and a tag value of Prod
, it does not create a second tag.
Instead, the original tag is overwritten with the new tag value.
tagResourceAsync
in interface AWSKMSAsync
public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AWSKMSAsync
Adds or overwrites one or more tags for the specified customer master key (CMK).
Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
You cannot use the same tag key more than once per CMK. For example, consider a CMK with one tag whose tag key is
Purpose
and tag value is Test
. If you send a TagResource
request for this
CMK with a tag key of Purpose
and a tag value of Prod
, it does not create a second tag.
Instead, the original tag is overwritten with the new tag value.
tagResourceAsync
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<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AWSKMSAsync
Removes the specified tag or tags from the specified customer master key (CMK).
To remove a tag, you specify the tag key for each tag to remove. You do not specify the tag value. To overwrite the tag value for an existing tag, use TagResource.
untagResourceAsync
in interface AWSKMSAsync
public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AWSKMSAsync
Removes the specified tag or tags from the specified customer master key (CMK).
To remove a tag, you specify the tag key for each tag to remove. You do not specify the tag value. To overwrite the tag value for an existing tag, use TagResource.
untagResourceAsync
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<UpdateAliasResult> 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<UpdateAliasResult> updateAliasAsync(UpdateAliasRequest request, AsyncHandler<UpdateAliasRequest,UpdateAliasResult> 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<UpdateKeyDescriptionResult> updateKeyDescriptionAsync(UpdateKeyDescriptionRequest request)
AWSKMSAsync
Updates the description of a customer master key (CMK).
updateKeyDescriptionAsync
in interface AWSKMSAsync
public Future<UpdateKeyDescriptionResult> updateKeyDescriptionAsync(UpdateKeyDescriptionRequest request, AsyncHandler<UpdateKeyDescriptionRequest,UpdateKeyDescriptionResult> asyncHandler)
AWSKMSAsync
Updates the description of a customer master key (CMK).
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 © 2013 Amazon Web Services, Inc. All Rights Reserved.