AWSKMSClient (AWS Java SDK for AWS KMS 1.11.183 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.kms.AWSKMSClient

All Implemented Interfaces:

AWSKMS

Direct Known Subclasses:

AWSKMSAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSKMSClient
extends AmazonWebServiceClient
implements AWSKMS
```
Client for accessing KMS. All service calls made using this client are blocking, and will not return until the service call completes.
AWS Key Management Service
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
Modifier and Type Field and Description

protected static ClientConfigurationFactory configFactory
Client configuration factory providing ClientConfigurations tailored to this client
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
- Fields inherited from interface com.amazonaws.services.kms.AWSKMS
  ENDPOINT_PREFIX

Fields
Modifier and Type	Field and Description
`protected static ClientConfigurationFactory`	`configFactory` Client configuration factory providing ClientConfigurations tailored to this client

Constructor Summary

Constructors
Constructor and Description
`AWSKMSClient()` Deprecated. use `AWSKMSClientBuilder.defaultClient()`
`AWSKMSClient(AWSCredentials awsCredentials)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` for example: `AWSKMSClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();`
`AWSKMSClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`
`AWSKMSClient(AWSCredentialsProvider awsCredentialsProvider)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)`
`AWSKMSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`
`AWSKMSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)` and `AwsClientBuilder.withMetricsCollector(RequestMetricCollector)`
`AWSKMSClient(ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AWSKMSClientBuilder`	`builder()`
`CancelKeyDeletionResult`	`cancelKeyDeletion(CancelKeyDeletionRequest request)` Cancels the deletion of a customer master key (CMK).
`CreateAliasResult`	`createAlias(CreateAliasRequest request)` Creates a display name for a customer master key.
`CreateGrantResult`	`createGrant(CreateGrantRequest request)` Adds a grant to a key to specify who can use the key and under what conditions.
`CreateKeyResult`	`createKey()` Simplified method form for invoking the CreateKey operation.
`CreateKeyResult`	`createKey(CreateKeyRequest request)` Creates a customer master key (CMK).
`DecryptResult`	`decrypt(DecryptRequest request)` Decrypts ciphertext.
`DeleteAliasResult`	`deleteAlias(DeleteAliasRequest request)` Deletes the specified alias.
`DeleteImportedKeyMaterialResult`	`deleteImportedKeyMaterial(DeleteImportedKeyMaterialRequest request)` Deletes key material that you previously imported and makes the specified customer master key (CMK) unusable.
`DescribeKeyResult`	`describeKey(DescribeKeyRequest request)` Provides detailed information about the specified customer master key.
`DisableKeyResult`	`disableKey(DisableKeyRequest request)` Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations.
`DisableKeyRotationResult`	`disableKeyRotation(DisableKeyRotationRequest request)` Disables rotation of the specified key.
`EnableKeyResult`	`enableKey(EnableKeyRequest request)` Marks a key as enabled, thereby permitting its use.
`EnableKeyRotationResult`	`enableKeyRotation(EnableKeyRotationRequest request)` Enables rotation of the specified customer master key.
`EncryptResult`	`encrypt(EncryptRequest request)` Encrypts plaintext into ciphertext by using a customer master key.
`GenerateDataKeyResult`	`generateDataKey(GenerateDataKeyRequest request)` Returns a data encryption key that you can use in your application to encrypt data locally.
`GenerateDataKeyWithoutPlaintextResult`	`generateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest request)` Returns a data encryption key encrypted under a customer master key (CMK).
`GenerateRandomResult`	`generateRandom()` Simplified method form for invoking the GenerateRandom operation.
`GenerateRandomResult`	`generateRandom(GenerateRandomRequest request)` Returns a random byte string that is cryptographically secure.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`GetKeyPolicyResult`	`getKeyPolicy(GetKeyPolicyRequest request)` Retrieves a policy attached to the specified key.
`GetKeyRotationStatusResult`	`getKeyRotationStatus(GetKeyRotationStatusRequest request)` Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.
`GetParametersForImportResult`	`getParametersForImport(GetParametersForImportRequest request)` Returns the items you need in order to import key material into AWS KMS from your existing key management infrastructure.
`ImportKeyMaterialResult`	`importKeyMaterial(ImportKeyMaterialRequest request)` Imports key material into an AWS KMS customer master key (CMK) from your existing key management infrastructure.
`ListAliasesResult`	`listAliases()` Simplified method form for invoking the ListAliases operation.
`ListAliasesResult`	`listAliases(ListAliasesRequest request)` Lists all of the key aliases in the account.
`ListGrantsResult`	`listGrants(ListGrantsRequest request)` List the grants for a specified key.
`ListKeyPoliciesResult`	`listKeyPolicies(ListKeyPoliciesRequest request)` Retrieves a list of policies attached to a key.
`ListKeysResult`	`listKeys()` Simplified method form for invoking the ListKeys operation.
`ListKeysResult`	`listKeys(ListKeysRequest request)` Lists the customer master keys.
`ListResourceTagsResult`	`listResourceTags(ListResourceTagsRequest request)` Returns a list of all tags for the specified customer master key (CMK).
`ListRetirableGrantsResult`	`listRetirableGrants(ListRetirableGrantsRequest request)` Returns a list of all grants for which the grant's `RetiringPrincipal` matches the one specified.
`PutKeyPolicyResult`	`putKeyPolicy(PutKeyPolicyRequest request)` Attaches a key policy to the specified customer master key (CMK).
`ReEncryptResult`	`reEncrypt(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.
`RetireGrantResult`	`retireGrant()` Simplified method form for invoking the RetireGrant operation.
`RetireGrantResult`	`retireGrant(RetireGrantRequest request)` Retires a grant.
`RevokeGrantResult`	`revokeGrant(RevokeGrantRequest request)` Revokes a grant.
`ScheduleKeyDeletionResult`	`scheduleKeyDeletion(ScheduleKeyDeletionRequest request)` Schedules the deletion of a customer master key (CMK).
`TagResourceResult`	`tagResource(TagResourceRequest request)` Adds or overwrites one or more tags for the specified customer master key (CMK).
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes the specified tag or tags from the specified customer master key (CMK).
`UpdateAliasResult`	`updateAlias(UpdateAliasRequest request)` Updates an alias to map it to a different key.
`UpdateKeyDescriptionResult`	`updateKeyDescription(UpdateKeyDescriptionRequest request)` Updates the description of a customer master key (CMK).

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, useStrictHostNameVerification, 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
setEndpoint, setRegion, shutdown

- Field Detail
  - configFactory
```
protected static final ClientConfigurationFactory configFactory
```
    Client configuration factory providing ClientConfigurations tailored to this client
- Constructor Detail
  - AWSKMSClient
```
@Deprecated
public AWSKMSClient()
```
    Deprecated. use AWSKMSClientBuilder.defaultClient()
    Constructs a new 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
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    See Also:
    
    DefaultAWSCredentialsProviderChain
  - AWSKMSClient
```
@Deprecated
public AWSKMSClient(ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    Constructs a new 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
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    Parameters:
    
    clientConfiguration - The client configuration options controlling how this client connects to KMS (ex: proxy settings, retry counts, etc.).
    
    See Also:
    
    DefaultAWSCredentialsProviderChain
  - AWSKMSClient
```
@Deprecated
public AWSKMSClient(AWSCredentials awsCredentials)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSKMSClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
    
    Constructs a new client to invoke service methods on KMS using the specified AWS account credentials.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
  - AWSKMSClient
```
@Deprecated
public AWSKMSClient(AWSCredentials awsCredentials,
                                ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    
    Constructs a new client to invoke service methods on KMS using the specified AWS account credentials and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to KMS (ex: proxy settings, retry counts, etc.).
  - AWSKMSClient
```
@Deprecated
public AWSKMSClient(AWSCredentialsProvider awsCredentialsProvider)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
    
    Constructs a new client to invoke service methods on KMS using the specified AWS account credentials provider.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
  - AWSKMSClient
```
@Deprecated
public AWSKMSClient(AWSCredentialsProvider awsCredentialsProvider,
                                ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    
    Constructs a new client to invoke service methods on KMS using the specified AWS account credentials provider and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to KMS (ex: proxy settings, retry counts, etc.).
  - AWSKMSClient
```
@Deprecated
public AWSKMSClient(AWSCredentialsProvider awsCredentialsProvider,
                                ClientConfiguration clientConfiguration,
                                RequestMetricCollector requestMetricCollector)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
    
    Constructs a new client to invoke service methods on KMS using the specified AWS account credentials provider, client configuration options, and request metric collector.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to KMS (ex: proxy settings, retry counts, etc.).
    
    requestMetricCollector - optional request metric collector
- Method Detail
  - builder
```
public static AWSKMSClientBuilder builder()
```
  - cancelKeyDeletion
```
public CancelKeyDeletionResult cancelKeyDeletion(CancelKeyDeletionRequest request)
```
    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:
    
    cancelKeyDeletion in interface AWSKMS
    
    Parameters:
    
    cancelKeyDeletionRequest -
    
    Returns:
    
    Result of the CancelKeyDeletion operation returned by the service.
    
    Throws:
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    InvalidArnException - The request was rejected because a specified ARN was not valid.
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    AWS API Documentation
  - createAlias
```
public CreateAliasResult createAlias(CreateAliasRequest request)
```
    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:
    
    createAlias in interface AWSKMS
    
    Parameters:
    
    createAliasRequest -
    
    Returns:
    
    Result of the CreateAlias operation returned by the service.
    
    Throws:
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    AlreadyExistsException - The request was rejected because it attempted to create a resource that already exists.
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    InvalidAliasNameException - The request was rejected because the specified alias name is not valid.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    LimitExceededException - The request was rejected because a limit was exceeded. For more information, see Limits in the AWS Key Management Service Developer Guide.
    
    KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    AWS API Documentation
  - createGrant
```
public CreateGrantResult createGrant(CreateGrantRequest request)
```
    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:
    
    createGrant in interface AWSKMS
    
    Parameters:
    
    createGrantRequest -
    
    Returns:
    
    Result of the CreateGrant operation returned by the service.
    
    Throws:
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    DisabledException - The request was rejected because the specified CMK is not enabled.
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    InvalidArnException - The request was rejected because a specified ARN was not valid.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    InvalidGrantTokenException - The request was rejected because the specified grant token is not valid.
    
    LimitExceededException - The request was rejected because a limit was exceeded. For more information, see Limits in the AWS Key Management Service Developer Guide.
    
    KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    AWS API Documentation
  - createKey
```
public CreateKeyResult createKey(CreateKeyRequest request)
```
    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:
    
    createKey in interface AWSKMS
    
    Parameters:
    
    createKeyRequest -
    
    Returns:
    
    Result of the CreateKey operation returned by the service.
    
    Throws:
    
    MalformedPolicyDocumentException - The request was rejected because the specified policy is not syntactically or semantically correct.
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    InvalidArnException - The request was rejected because a specified ARN was not valid.
    
    UnsupportedOperationException - The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    LimitExceededException - The request was rejected because a limit was exceeded. For more information, see Limits in the AWS Key Management Service Developer Guide.
    
    TagException - The request was rejected because one or more tags are not valid.
    
    See Also:
    
    AWS API Documentation
  - createKey
```
public CreateKeyResult createKey()
```
    Description copied from interface: AWSKMS
    
    Simplified method form for invoking the CreateKey operation.
    
    Specified by:
    
    createKey in interface AWSKMS
    
    See Also:
    
    AWSKMS.createKey(CreateKeyRequest)
  - decrypt
```
public DecryptResult decrypt(DecryptRequest request)
```
    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.
    Specified by:
    
    decrypt in interface AWSKMS
    
    Parameters:
    
    decryptRequest -
    
    Returns:
    
    Result of the Decrypt operation returned by the service.
    
    Throws:
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    DisabledException - The request was rejected because the specified CMK is not enabled.
    
    InvalidCiphertextException - The request was rejected because the specified ciphertext has been corrupted or is otherwise invalid.
    
    KeyUnavailableException - The request was rejected because the specified CMK was not available. The request can be retried.
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    InvalidGrantTokenException - The request was rejected because the specified grant token is not valid.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    AWS API Documentation
  - deleteAlias
```
public DeleteAliasResult deleteAlias(DeleteAliasRequest request)
```
    Deletes the specified alias. To map an alias to a different key, call UpdateAlias.
    
    Specified by:
    
    deleteAlias in interface AWSKMS
    
    Parameters:
    
    deleteAliasRequest -
    
    Returns:
    
    Result of the DeleteAlias operation returned by the service.
    
    Throws:
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    AWS API Documentation
  - deleteImportedKeyMaterial
```
public DeleteImportedKeyMaterialResult deleteImportedKeyMaterial(DeleteImportedKeyMaterialRequest request)
```
    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.
    
    Specified by:
    
    deleteImportedKeyMaterial in interface AWSKMS
    
    Parameters:
    
    deleteImportedKeyMaterialRequest -
    
    Returns:
    
    Result of the DeleteImportedKeyMaterial operation returned by the service.
    
    Throws:
    
    InvalidArnException - The request was rejected because a specified ARN was not valid.
    
    UnsupportedOperationException - The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    AWS API Documentation
  - describeKey
```
public DescribeKeyResult describeKey(DescribeKeyRequest request)
```
    Provides detailed information about the specified customer master key.
    
    Specified by:
    
    describeKey in interface AWSKMS
    
    Parameters:
    
    describeKeyRequest -
    
    Returns:
    
    Result of the DescribeKey operation returned by the service.
    
    Throws:
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    InvalidArnException - The request was rejected because a specified ARN was not valid.
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    See Also:
    
    AWS API Documentation
  - disableKey
```
public DisableKeyResult disableKey(DisableKeyRequest request)
```
    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:
    
    disableKey in interface AWSKMS
    
    Parameters:
    
    disableKeyRequest -
    
    Returns:
    
    Result of the DisableKey operation returned by the service.
    
    Throws:
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    InvalidArnException - The request was rejected because a specified ARN was not valid.
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    AWS API Documentation
  - disableKeyRotation
```
public DisableKeyRotationResult disableKeyRotation(DisableKeyRotationRequest request)
```
    Disables rotation of the specified key.
    
    Specified by:
    
    disableKeyRotation in interface AWSKMS
    
    Parameters:
    
    disableKeyRotationRequest -
    
    Returns:
    
    Result of the DisableKeyRotation operation returned by the service.
    
    Throws:
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    DisabledException - The request was rejected because the specified CMK is not enabled.
    
    InvalidArnException - The request was rejected because a specified ARN was not valid.
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    UnsupportedOperationException - The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
    
    See Also:
    
    AWS API Documentation
  - enableKey
```
public EnableKeyResult enableKey(EnableKeyRequest request)
```
    Marks a key as enabled, thereby permitting its use.
    
    Specified by:
    
    enableKey in interface AWSKMS
    
    Parameters:
    
    enableKeyRequest -
    
    Returns:
    
    Result of the EnableKey operation returned by the service.
    
    Throws:
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    InvalidArnException - The request was rejected because a specified ARN was not valid.
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    LimitExceededException - The request was rejected because a limit was exceeded. For more information, see Limits in the AWS Key Management Service Developer Guide.
    
    KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    AWS API Documentation
  - enableKeyRotation
```
public EnableKeyRotationResult enableKeyRotation(EnableKeyRotationRequest request)
```
    Enables rotation of the specified customer master key.
    
    Specified by:
    
    enableKeyRotation in interface AWSKMS
    
    Parameters:
    
    enableKeyRotationRequest -
    
    Returns:
    
    Result of the EnableKeyRotation operation returned by the service.
    
    Throws:
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    DisabledException - The request was rejected because the specified CMK is not enabled.
    
    InvalidArnException - The request was rejected because a specified ARN was not valid.
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    UnsupportedOperationException - The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
    
    See Also:
    
    AWS API Documentation
  - encrypt
```
public EncryptResult encrypt(EncryptRequest request)
```
    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:
    
    encrypt in interface AWSKMS
    
    Parameters:
    
    encryptRequest -
    
    Returns:
    
    Result of the Encrypt operation returned by the service.
    
    Throws:
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    DisabledException - The request was rejected because the specified CMK is not enabled.
    
    KeyUnavailableException - The request was rejected because the specified CMK was not available. The request can be retried.
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    InvalidKeyUsageException - The request was rejected because the specified KeySpec value is not valid.
    
    InvalidGrantTokenException - The request was rejected because the specified grant token is not valid.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    AWS API Documentation
  - generateDataKey
```
public GenerateDataKeyResult generateDataKey(GenerateDataKeyRequest request)
```
    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:
    1. Use this operation (GenerateDataKey) to retrieve a data encryption key.
    2. 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.
    3. Store the encrypted data key (returned in the CiphertextBlob field of the response) alongside the locally encrypted data.
    To decrypt data locally:
    1. Use the Decrypt operation to decrypt the encrypted data key into a plaintext copy of the data key.
    2. 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.
    Specified by:
    
    generateDataKey in interface AWSKMS
    
    Parameters:
    
    generateDataKeyRequest -
    
    Returns:
    
    Result of the GenerateDataKey operation returned by the service.
    
    Throws:
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    DisabledException - The request was rejected because the specified CMK is not enabled.
    
    KeyUnavailableException - The request was rejected because the specified CMK was not available. The request can be retried.
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    InvalidKeyUsageException - The request was rejected because the specified KeySpec value is not valid.
    
    InvalidGrantTokenException - The request was rejected because the specified grant token is not valid.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    AWS API Documentation
  - generateDataKeyWithoutPlaintext
```
public GenerateDataKeyWithoutPlaintextResult generateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest request)
```
    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.
    
    Specified by:
    
    generateDataKeyWithoutPlaintext in interface AWSKMS
    
    Parameters:
    
    generateDataKeyWithoutPlaintextRequest -
    
    Returns:
    
    Result of the GenerateDataKeyWithoutPlaintext operation returned by the service.
    
    Throws:
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    DisabledException - The request was rejected because the specified CMK is not enabled.
    
    KeyUnavailableException - The request was rejected because the specified CMK was not available. The request can be retried.
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    InvalidKeyUsageException - The request was rejected because the specified KeySpec value is not valid.
    
    InvalidGrantTokenException - The request was rejected because the specified grant token is not valid.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    AWS API Documentation
  - generateRandom
```
public GenerateRandomResult generateRandom(GenerateRandomRequest request)
```
    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.
    
    Specified by:
    
    generateRandom in interface AWSKMS
    
    Parameters:
    
    generateRandomRequest -
    
    Returns:
    
    Result of the GenerateRandom operation returned by the service.
    
    Throws:
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    See Also:
    
    AWS API Documentation
  - generateRandom
```
public GenerateRandomResult generateRandom()
```
    Description copied from interface: AWSKMS
    
    Simplified method form for invoking the GenerateRandom operation.
    
    Specified by:
    
    generateRandom in interface AWSKMS
    
    See Also:
    
    AWSKMS.generateRandom(GenerateRandomRequest)
  - getKeyPolicy
```
public GetKeyPolicyResult getKeyPolicy(GetKeyPolicyRequest request)
```
    Retrieves a policy attached to the specified key.
    
    Specified by:
    
    getKeyPolicy in interface AWSKMS
    
    Parameters:
    
    getKeyPolicyRequest -
    
    Returns:
    
    Result of the GetKeyPolicy operation returned by the service.
    
    Throws:
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    InvalidArnException - The request was rejected because a specified ARN was not valid.
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    AWS API Documentation
  - getKeyRotationStatus
```
public GetKeyRotationStatusResult getKeyRotationStatus(GetKeyRotationStatusRequest request)
```
    Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.
    
    Specified by:
    
    getKeyRotationStatus in interface AWSKMS
    
    Parameters:
    
    getKeyRotationStatusRequest -
    
    Returns:
    
    Result of the GetKeyRotationStatus operation returned by the service.
    
    Throws:
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    InvalidArnException - The request was rejected because a specified ARN was not valid.
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    UnsupportedOperationException - The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
    
    See Also:
    
    AWS API Documentation
  - getParametersForImport
```
public GetParametersForImportResult getParametersForImport(GetParametersForImportRequest request)
```
    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.
    
    Specified by:
    
    getParametersForImport in interface AWSKMS
    
    Parameters:
    
    getParametersForImportRequest -
    
    Returns:
    
    Result of the GetParametersForImport operation returned by the service.
    
    Throws:
    
    InvalidArnException - The request was rejected because a specified ARN was not valid.
    
    UnsupportedOperationException - The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    AWS API Documentation
  - importKeyMaterial
```
public ImportKeyMaterialResult importKeyMaterial(ImportKeyMaterialRequest request)
```
    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.
    
    Specified by:
    
    importKeyMaterial in interface AWSKMS
    
    Parameters:
    
    importKeyMaterialRequest -
    
    Returns:
    
    Result of the ImportKeyMaterial operation returned by the service.
    
    Throws:
    
    InvalidArnException - The request was rejected because a specified ARN was not valid.
    
    UnsupportedOperationException - The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    InvalidCiphertextException - The request was rejected because the specified ciphertext has been corrupted or is otherwise invalid.
    
    IncorrectKeyMaterialException - The request was rejected because the provided key material is invalid or is not the same key material that was previously imported into this customer master key (CMK).
    
    ExpiredImportTokenException - The request was rejected because the provided import token is expired. Use GetParametersForImport to retrieve a new import token and public key, use the new public key to encrypt the key material, and then try the request again.
    
    InvalidImportTokenException - The request was rejected because the provided import token is invalid or is associated with a different customer master key (CMK).
    
    See Also:
    
    AWS API Documentation
  - listAliases
```
public ListAliasesResult listAliases(ListAliasesRequest request)
```
    Lists all of the key aliases in the account.
    
    Specified by:
    
    listAliases in interface AWSKMS
    
    Parameters:
    
    listAliasesRequest -
    
    Returns:
    
    Result of the ListAliases operation returned by the service.
    
    Throws:
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    InvalidMarkerException - The request was rejected because the marker that specifies where pagination should next begin is not valid.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    See Also:
    
    AWS API Documentation
  - listAliases
```
public ListAliasesResult listAliases()
```
    Description copied from interface: AWSKMS
    
    Simplified method form for invoking the ListAliases operation.
    
    Specified by:
    
    listAliases in interface AWSKMS
    
    See Also:
    
    AWSKMS.listAliases(ListAliasesRequest)
  - listGrants
```
public ListGrantsResult listGrants(ListGrantsRequest request)
```
    List the grants for a specified key.
    
    Specified by:
    
    listGrants in interface AWSKMS
    
    Parameters:
    
    listGrantsRequest -
    
    Returns:
    
    Result of the ListGrants operation returned by the service.
    
    Throws:
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    InvalidMarkerException - The request was rejected because the marker that specifies where pagination should next begin is not valid.
    
    InvalidArnException - The request was rejected because a specified ARN was not valid.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    AWS API Documentation
  - listKeyPolicies
```
public ListKeyPoliciesResult listKeyPolicies(ListKeyPoliciesRequest request)
```
    Retrieves a list of policies attached to a key.
    
    Specified by:
    
    listKeyPolicies in interface AWSKMS
    
    Parameters:
    
    listKeyPoliciesRequest -
    
    Returns:
    
    Result of the ListKeyPolicies operation returned by the service.
    
    Throws:
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    InvalidArnException - The request was rejected because a specified ARN was not valid.
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    AWS API Documentation
  - listKeys
```
public ListKeysResult listKeys(ListKeysRequest request)
```
    Lists the customer master keys.
    
    Specified by:
    
    listKeys in interface AWSKMS
    
    Parameters:
    
    listKeysRequest -
    
    Returns:
    
    Result of the ListKeys operation returned by the service.
    
    Throws:
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    InvalidMarkerException - The request was rejected because the marker that specifies where pagination should next begin is not valid.
    
    See Also:
    
    AWS API Documentation
  - listKeys
```
public ListKeysResult listKeys()
```
    Description copied from interface: AWSKMS
    
    Simplified method form for invoking the ListKeys operation.
    
    Specified by:
    
    listKeys in interface AWSKMS
    
    See Also:
    
    AWSKMS.listKeys(ListKeysRequest)
  - listResourceTags
```
public ListResourceTagsResult listResourceTags(ListResourceTagsRequest request)
```
    Returns a list of all tags for the specified customer master key (CMK).
    
    Specified by:
    
    listResourceTags in interface AWSKMS
    
    Parameters:
    
    listResourceTagsRequest -
    
    Returns:
    
    Result of the ListResourceTags operation returned by the service.
    
    Throws:
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    InvalidArnException - The request was rejected because a specified ARN was not valid.
    
    InvalidMarkerException - The request was rejected because the marker that specifies where pagination should next begin is not valid.
    
    See Also:
    
    AWS API Documentation
  - listRetirableGrants
```
public ListRetirableGrantsResult listRetirableGrants(ListRetirableGrantsRequest request)
```
    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:
    
    listRetirableGrants in interface AWSKMS
    
    Parameters:
    
    listRetirableGrantsRequest -
    
    Returns:
    
    Result of the ListRetirableGrants operation returned by the service.
    
    Throws:
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    InvalidMarkerException - The request was rejected because the marker that specifies where pagination should next begin is not valid.
    
    InvalidArnException - The request was rejected because a specified ARN was not valid.
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    See Also:
    
    AWS API Documentation
  - putKeyPolicy
```
public PutKeyPolicyResult putKeyPolicy(PutKeyPolicyRequest request)
```
    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:
    
    putKeyPolicy in interface AWSKMS
    
    Parameters:
    
    putKeyPolicyRequest -
    
    Returns:
    
    Result of the PutKeyPolicy operation returned by the service.
    
    Throws:
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    InvalidArnException - The request was rejected because a specified ARN was not valid.
    
    MalformedPolicyDocumentException - The request was rejected because the specified policy is not syntactically or semantically correct.
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    UnsupportedOperationException - The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    LimitExceededException - The request was rejected because a limit was exceeded. For more information, see Limits in the AWS Key Management Service Developer Guide.
    
    KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    AWS API Documentation
  - reEncrypt
```
public ReEncryptResult reEncrypt(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. 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.
    
    Specified by:
    
    reEncrypt in interface AWSKMS
    
    Parameters:
    
    reEncryptRequest -
    
    Returns:
    
    Result of the ReEncrypt operation returned by the service.
    
    Throws:
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    DisabledException - The request was rejected because the specified CMK is not enabled.
    
    InvalidCiphertextException - The request was rejected because the specified ciphertext has been corrupted or is otherwise invalid.
    
    KeyUnavailableException - The request was rejected because the specified CMK was not available. The request can be retried.
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    InvalidKeyUsageException - The request was rejected because the specified KeySpec value is not valid.
    
    InvalidGrantTokenException - The request was rejected because the specified grant token is not valid.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    AWS API Documentation
  - retireGrant
```
public RetireGrantResult retireGrant(RetireGrantRequest request)
```
    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.
    Specified by:
    
    retireGrant in interface AWSKMS
    
    Parameters:
    
    retireGrantRequest -
    
    Returns:
    
    Result of the RetireGrant operation returned by the service.
    
    Throws:
    
    InvalidGrantTokenException - The request was rejected because the specified grant token is not valid.
    
    InvalidGrantIdException - The request was rejected because the specified GrantId is not valid.
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    AWS API Documentation
  - retireGrant
```
public RetireGrantResult retireGrant()
```
    Description copied from interface: AWSKMS
    
    Simplified method form for invoking the RetireGrant operation.
    
    Specified by:
    
    retireGrant in interface AWSKMS
    
    See Also:
    
    AWSKMS.retireGrant(RetireGrantRequest)
  - revokeGrant
```
public RevokeGrantResult revokeGrant(RevokeGrantRequest request)
```
    Revokes a grant. You can revoke a grant to actively deny operations that depend on it.
    
    Specified by:
    
    revokeGrant in interface AWSKMS
    
    Parameters:
    
    revokeGrantRequest -
    
    Returns:
    
    Result of the RevokeGrant operation returned by the service.
    
    Throws:
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    InvalidArnException - The request was rejected because a specified ARN was not valid.
    
    InvalidGrantIdException - The request was rejected because the specified GrantId is not valid.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    AWS API Documentation
  - scheduleKeyDeletion
```
public ScheduleKeyDeletionResult scheduleKeyDeletion(ScheduleKeyDeletionRequest request)
```
    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.
    
    Specified by:
    
    scheduleKeyDeletion in interface AWSKMS
    
    Parameters:
    
    scheduleKeyDeletionRequest -
    
    Returns:
    
    Result of the ScheduleKeyDeletion operation returned by the service.
    
    Throws:
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    InvalidArnException - The request was rejected because a specified ARN was not valid.
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    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.
    
    Specified by:
    
    tagResource in interface AWSKMS
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    InvalidArnException - The request was rejected because a specified ARN was not valid.
    
    KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    LimitExceededException - The request was rejected because a limit was exceeded. For more information, see Limits in the AWS Key Management Service Developer Guide.
    
    TagException - The request was rejected because one or more tags are not valid.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    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.
    
    Specified by:
    
    untagResource in interface AWSKMS
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    InvalidArnException - The request was rejected because a specified ARN was not valid.
    
    KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    TagException - The request was rejected because one or more tags are not valid.
    
    See Also:
    
    AWS API Documentation
  - updateAlias
```
public UpdateAliasResult updateAlias(UpdateAliasRequest request)
```
    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:
    
    updateAlias in interface AWSKMS
    
    Parameters:
    
    updateAliasRequest -
    
    Returns:
    
    Result of the UpdateAlias operation returned by the service.
    
    Throws:
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    AWS API Documentation
  - updateKeyDescription
```
public UpdateKeyDescriptionResult updateKeyDescription(UpdateKeyDescriptionRequest request)
```
    Updates the description of a customer master key (CMK).
    
    Specified by:
    
    updateKeyDescription in interface AWSKMS
    
    Parameters:
    
    updateKeyDescriptionRequest -
    
    Returns:
    
    Result of the UpdateKeyDescription operation returned by the service.
    
    Throws:
    
    NotFoundException - The request was rejected because the specified entity or resource could not be found.
    
    InvalidArnException - The request was rejected because a specified ARN was not valid.
    
    DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.
    
    KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.
    
    KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSKMS
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Class AWSKMSClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.kms.AWSKMS

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazonaws.services.kms.AWSKMS

Field Detail

configFactory

Constructor Detail

AWSKMSClient

AWSKMSClient

AWSKMSClient

AWSKMSClient

AWSKMSClient

AWSKMSClient

AWSKMSClient

Method Detail

builder

cancelKeyDeletion

createAlias

createGrant

createKey

createKey

decrypt

deleteAlias

deleteImportedKeyMaterial

describeKey

disableKey

disableKeyRotation

enableKey

enableKeyRotation

encrypt

generateDataKey

generateDataKeyWithoutPlaintext

generateRandom

generateRandom

getKeyPolicy

getKeyRotationStatus

getParametersForImport

importKeyMaterial

listAliases

listAliases

listGrants

listKeyPolicies

listKeys

listKeys

listResourceTags

listRetirableGrants

putKeyPolicy

reEncrypt

retireGrant

retireGrant

revokeGrant

scheduleKeyDeletion

tagResource

untagResource

updateAlias

updateKeyDescription

getCachedResponseMetadata