com.amazonaws.services.kms

Class AWSKMSClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.kms.AWSKMSClient

All Implemented Interfaces:

AWSKMS

Direct Known Subclasses:

AWSKMSAsyncClient

public class AWSKMSClient
extends AmazonWebServiceClient
implements AWSKMS

Client for accessing AWSKMS. 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 (KMS) is an encryption and key management web service. This guide describes the KMS actions that you can call programmatically. For general information about KMS, see the AWS Key Management Service Developer Guide

NOTE: 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 KMS and AWS. 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 KMS.

Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes.

Signing Requests

Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account access key ID and secret key for everyday work with 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 KMS operations require Signature Version 4 .

Recording API Requests

KMS supports AWS CloudTrail, a service that records 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 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.
• AWS Security Token Service . This guide describes how to create and use temporary security credentials.
• Signing AWS API Requests . 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.

• Encrypt
• Decrypt
• GenerateDataKey
• GenerateDataKeyWithoutPlaintext

Field Summary

Fields

Modifier and Type	Field and Description
protected List<com.amazonaws.transform.JsonErrorUnmarshaller>	jsonErrorUnmarshallers List of exception unmarshallers for all AWSKMS exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AWSKMSClient() Constructs a new client to invoke service methods on AWSKMS.
AWSKMSClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AWSKMS using the specified AWS account credentials.
AWSKMSClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSKMS using the specified AWS account credentials and client configuration options.
AWSKMSClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AWSKMS using the specified AWS account credentials provider.
AWSKMSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSKMS using the specified AWS account credentials provider and client configuration options.
AWSKMSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on AWSKMS using the specified AWS account credentials provider, client configuration options and request metric collector.
AWSKMSClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSKMS.

Method Summary

Methods

Modifier and Type	Method and Description
void	createAlias(CreateAliasRequest createAliasRequest) Creates a display name for a customer master key.
CreateGrantResult	createGrant(CreateGrantRequest createGrantRequest) Adds a grant to a key to specify who can access the key and under what conditions.
CreateKeyResult	createKey() Creates a customer master key.
CreateKeyResult	createKey(CreateKeyRequest createKeyRequest) Creates a customer master key.
DecryptResult	decrypt(DecryptRequest decryptRequest) Decrypts ciphertext.
void	deleteAlias(DeleteAliasRequest deleteAliasRequest) Deletes the specified alias.
DescribeKeyResult	describeKey(DescribeKeyRequest describeKeyRequest) Provides detailed information about the specified customer master key.
void	disableKey(DisableKeyRequest disableKeyRequest) Marks a key as disabled, thereby preventing its use.
void	disableKeyRotation(DisableKeyRotationRequest disableKeyRotationRequest) Disables rotation of the specified key.
void	enableKey(EnableKeyRequest enableKeyRequest) Marks a key as enabled, thereby permitting its use.
void	enableKeyRotation(EnableKeyRotationRequest enableKeyRotationRequest) Enables rotation of the specified customer master key.
EncryptResult	encrypt(EncryptRequest encryptRequest) Encrypts plaintext into ciphertext by using a customer master key.
GenerateDataKeyResult	generateDataKey(GenerateDataKeyRequest generateDataKeyRequest) Generates a data key that you can use in your application to locally encrypt data.
GenerateDataKeyWithoutPlaintextResult	generateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest generateDataKeyWithoutPlaintextRequest) Returns a data key encrypted by a customer master key without the plaintext copy of that key.
GenerateRandomResult	generateRandom() Generates an unpredictable byte string.
GenerateRandomResult	generateRandom(GenerateRandomRequest generateRandomRequest) Generates an unpredictable byte string.
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 getKeyPolicyRequest) Retrieves a policy attached to the specified key.
GetKeyRotationStatusResult	getKeyRotationStatus(GetKeyRotationStatusRequest getKeyRotationStatusRequest) Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.
ListAliasesResult	listAliases() Lists all of the key aliases in the account.
ListAliasesResult	listAliases(ListAliasesRequest listAliasesRequest) Lists all of the key aliases in the account.
ListGrantsResult	listGrants(ListGrantsRequest listGrantsRequest) List the grants for a specified key.
ListKeyPoliciesResult	listKeyPolicies(ListKeyPoliciesRequest listKeyPoliciesRequest) Retrieves a list of policies attached to a key.
ListKeysResult	listKeys() Lists the customer master keys.
ListKeysResult	listKeys(ListKeysRequest listKeysRequest) Lists the customer master keys.
void	putKeyPolicy(PutKeyPolicyRequest putKeyPolicyRequest) Attaches a policy to the specified key.
ReEncryptResult	reEncrypt(ReEncryptRequest reEncryptRequest) Encrypts data on the server side with a new customer master key without exposing the plaintext of the data on the client side.
void	retireGrant() Retires a grant.
void	retireGrant(RetireGrantRequest retireGrantRequest) Retires a grant.
void	revokeGrant(RevokeGrantRequest revokeGrantRequest) Revokes a grant.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client.
void	setEndpoint(String endpoint, String serviceName, String regionId) An internal method that is not expected to be normally called except for AWS internal development purposes.
void	updateAlias(UpdateAliasRequest updateAliasRequest) Updates an alias to associate it with a different key.
void	updateKeyDescription(UpdateKeyDescriptionRequest updateKeyDescriptionRequest) Updates the description of a key.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, 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

setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

protected List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers

List of exception unmarshallers for all AWSKMS exceptions.

Constructor Detail

AWSKMSClient

public AWSKMSClient()

Constructs a new client to invoke service methods on AWSKMS. 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

public AWSKMSClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSKMS. 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 AWSKMS (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSKMSClient

public AWSKMSClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AWSKMS 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

public AWSKMSClient(AWSCredentials awsCredentials,
            ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSKMS 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 AWSKMS (ex: proxy settings, retry counts, etc.).

AWSKMSClient

public AWSKMSClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AWSKMS 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

public AWSKMSClient(AWSCredentialsProvider awsCredentialsProvider,
            ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSKMS 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 AWSKMS (ex: proxy settings, retry counts, etc.).

AWSKMSClient

public AWSKMSClient(AWSCredentialsProvider awsCredentialsProvider,
            ClientConfiguration clientConfiguration,
            RequestMetricCollector requestMetricCollector)

Constructs a new client to invoke service methods on AWSKMS 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 AWSKMS (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

createKey

public CreateKeyResult createKey(CreateKeyRequest createKeyRequest)

Creates a customer master key. Customer master keys can be used to encrypt small amounts of data (less than 4K) directly, but they are most commonly used to encrypt or envelope data keys that are then used to encrypt customer data. For more information about data keys, see GenerateDataKey and GenerateDataKeyWithoutPlaintext.

Specified by:

createKey in interface AWSKMS

Parameters:

createKeyRequest - Container for the necessary parameters to execute the CreateKey service method on AWSKMS.

Returns:

The response from the CreateKey service method, as returned by AWSKMS.

Throws:

DependencyTimeoutException

MalformedPolicyDocumentException

InvalidArnException

UnsupportedOperationException

KMSInternalException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

encrypt

public EncryptResult encrypt(EncryptRequest encryptRequest)

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 - Container for the necessary parameters to execute the Encrypt service method on AWSKMS.

Returns:

The response from the Encrypt service method, as returned by AWSKMS.

Throws:

DependencyTimeoutException

InvalidGrantTokenException

KeyUnavailableException

NotFoundException

DisabledException

InvalidKeyUsageException

KMSInternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

getKeyPolicy

public GetKeyPolicyResult getKeyPolicy(GetKeyPolicyRequest getKeyPolicyRequest)

Retrieves a policy attached to the specified key.

Specified by:

getKeyPolicy in interface AWSKMS

Parameters:

getKeyPolicyRequest - Container for the necessary parameters to execute the GetKeyPolicy service method on AWSKMS.

Returns:

The response from the GetKeyPolicy service method, as returned by AWSKMS.

Throws:

DependencyTimeoutException

InvalidArnException

NotFoundException

KMSInternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

updateKeyDescription

public void updateKeyDescription(UpdateKeyDescriptionRequest updateKeyDescriptionRequest)

Updates the description of a key.

Specified by:

updateKeyDescription in interface AWSKMS

Parameters:

updateKeyDescriptionRequest - Container for the necessary parameters to execute the UpdateKeyDescription service method on AWSKMS.

Throws:

DependencyTimeoutException

InvalidArnException

NotFoundException

KMSInternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

listKeys

public ListKeysResult listKeys(ListKeysRequest listKeysRequest)

Lists the customer master keys.

Specified by:

listKeys in interface AWSKMS

Parameters:

listKeysRequest - Container for the necessary parameters to execute the ListKeys service method on AWSKMS.

Returns:

The response from the ListKeys service method, as returned by AWSKMS.

Throws:

DependencyTimeoutException

KMSInternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

generateDataKey

public GenerateDataKeyResult generateDataKey(GenerateDataKeyRequest generateDataKeyRequest)

Generates a data key that you can use in your application to locally encrypt data. This call returns a plaintext version of the key in the Plaintext field of the response object and an encrypted copy of the key in the CiphertextBlob field. The key is encrypted by using the master key specified by the KeyId field. To decrypt the encrypted key, pass it to the Decrypt API.

We recommend that you use the following pattern to locally encrypt data: call the GenerateDataKey API, use the key returned in the Plaintext response field to locally encrypt data, and then erase the plaintext data key from memory. Store the encrypted data key (contained in the CiphertextBlob field) alongside of the locally encrypted data.

NOTE:You should not call the Encrypt function to re-encrypt your data keys within a region. GenerateDataKey always returns the data key encrypted and tied to the customer master key that will be used to decrypt it. There is no need to decrypt it twice.

If you decide to use the optional EncryptionContext parameter, you must also store the context in full or at least store enough information along with the encrypted data to be able to reconstruct the context when submitting the ciphertext to the Decrypt API. It is a good practice to choose a context that you can reconstruct on the fly to better secure the ciphertext. For more information about how this parameter is used, see Encryption Context .

To decrypt data, pass the encrypted data key to the Decrypt API. Decrypt uses the associated master key to decrypt the encrypted data key and returns it as plaintext. Use the plaintext data key to locally decrypt your data and then erase the key from memory. You must specify the encryption context, if any, that you specified when you generated the key. The encryption context is logged by CloudTrail, and you can use this log to help track the use of particular data.

Specified by:

generateDataKey in interface AWSKMS

Parameters:

generateDataKeyRequest - Container for the necessary parameters to execute the GenerateDataKey service method on AWSKMS.

Returns:

The response from the GenerateDataKey service method, as returned by AWSKMS.

Throws:

DependencyTimeoutException

InvalidGrantTokenException

KeyUnavailableException

NotFoundException

DisabledException

InvalidKeyUsageException

KMSInternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

createGrant

public CreateGrantResult createGrant(CreateGrantRequest createGrantRequest)

Adds a grant to a key to specify who can access the key and under what conditions. Grants are alternate permission mechanisms to key policies. For more information about grants, see Grants in the developer guide. If a grant is absent, access to the key is evaluated based on IAM policies attached to the user.

1. ListGrants
2. RetireGrant
3. RevokeGrant

Specified by:

createGrant in interface AWSKMS

Parameters:

createGrantRequest - Container for the necessary parameters to execute the CreateGrant service method on AWSKMS.

Returns:

The response from the CreateGrant service method, as returned by AWSKMS.

Throws:

DependencyTimeoutException

InvalidGrantTokenException

InvalidArnException

NotFoundException

DisabledException

KMSInternalException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

listAliases

public ListAliasesResult listAliases(ListAliasesRequest listAliasesRequest)

Lists all of the key aliases in the account.

Specified by:

listAliases in interface AWSKMS

Parameters:

listAliasesRequest - Container for the necessary parameters to execute the ListAliases service method on AWSKMS.

Returns:

The response from the ListAliases service method, as returned by AWSKMS.

Throws:

DependencyTimeoutException

InvalidMarkerException

KMSInternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

generateDataKeyWithoutPlaintext

public GenerateDataKeyWithoutPlaintextResult generateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest generateDataKeyWithoutPlaintextRequest)

Returns a data key encrypted by a customer master key without the plaintext copy of that key. Otherwise, this API functions exactly like GenerateDataKey. You can use this API to, for example, satisfy an audit requirement that an encrypted key be made available without exposing the plaintext copy of that key.

Specified by:

generateDataKeyWithoutPlaintext in interface AWSKMS

Parameters:

generateDataKeyWithoutPlaintextRequest - Container for the necessary parameters to execute the GenerateDataKeyWithoutPlaintext service method on AWSKMS.

Returns:

The response from the GenerateDataKeyWithoutPlaintext service method, as returned by AWSKMS.

Throws:

DependencyTimeoutException

InvalidGrantTokenException

KeyUnavailableException

NotFoundException

DisabledException

InvalidKeyUsageException

KMSInternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

deleteAlias

public void deleteAlias(DeleteAliasRequest deleteAliasRequest)

Deletes the specified alias. To associate an alias with a different key, call UpdateAlias.

Specified by:

deleteAlias in interface AWSKMS

Parameters:

deleteAliasRequest - Container for the necessary parameters to execute the DeleteAlias service method on AWSKMS.

Throws:

DependencyTimeoutException

NotFoundException

KMSInternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

updateAlias

public void updateAlias(UpdateAliasRequest updateAliasRequest)

Updates an alias to associate it with a different 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).

An alias is not a property of a key. Therefore, an alias can be associated with and disassociated from an existing key without changing the properties of the key.

Note that you cannot create or update an alias that represents a key in another account.

Specified by:

updateAlias in interface AWSKMS

Parameters:

updateAliasRequest - Container for the necessary parameters to execute the UpdateAlias service method on AWSKMS.

Throws:

DependencyTimeoutException

NotFoundException

KMSInternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

enableKeyRotation

public void enableKeyRotation(EnableKeyRotationRequest enableKeyRotationRequest)

Enables rotation of the specified customer master key.

Specified by:

enableKeyRotation in interface AWSKMS

Parameters:

enableKeyRotationRequest - Container for the necessary parameters to execute the EnableKeyRotation service method on AWSKMS.

Throws:

DependencyTimeoutException

InvalidArnException

NotFoundException

DisabledException

KMSInternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

retireGrant

public void retireGrant(RetireGrantRequest retireGrantRequest)

Retires a grant. You can retire a grant when you're done using it to clean up. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:

• The account that created the grant
• The RetiringPrincipal , if present
• The GranteePrincipal , if RetireGrant is a grantee operation

The grant to retire must be identified by its grant token or by a combination of the key ARN and the grant ID. A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. Both are returned by the CreateGrant function.

Specified by:

retireGrant in interface AWSKMS

Parameters:

retireGrantRequest - Container for the necessary parameters to execute the RetireGrant service method on AWSKMS.

Throws:

DependencyTimeoutException

InvalidGrantTokenException

NotFoundException

KMSInternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

describeKey

public DescribeKeyResult describeKey(DescribeKeyRequest describeKeyRequest)

Provides detailed information about the specified customer master key.

Specified by:

describeKey in interface AWSKMS

Parameters:

describeKeyRequest - Container for the necessary parameters to execute the DescribeKey service method on AWSKMS.

Returns:

The response from the DescribeKey service method, as returned by AWSKMS.

Throws:

DependencyTimeoutException

InvalidArnException

NotFoundException

KMSInternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

listGrants

public ListGrantsResult listGrants(ListGrantsRequest listGrantsRequest)

List the grants for a specified key.

Specified by:

listGrants in interface AWSKMS

Parameters:

listGrantsRequest - Container for the necessary parameters to execute the ListGrants service method on AWSKMS.

Returns:

The response from the ListGrants service method, as returned by AWSKMS.

Throws:

DependencyTimeoutException

InvalidMarkerException

InvalidArnException

KMSInternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

decrypt

public DecryptResult decrypt(DecryptRequest decryptRequest)

Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following functions:

• GenerateDataKey
• GenerateDataKeyWithoutPlaintext
• Encrypt

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 - Container for the necessary parameters to execute the Decrypt service method on AWSKMS.

Returns:

The response from the Decrypt service method, as returned by AWSKMS.

Throws:

DependencyTimeoutException

InvalidGrantTokenException

KeyUnavailableException

NotFoundException

DisabledException

InvalidCiphertextException

KMSInternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

generateRandom

public GenerateRandomResult generateRandom(GenerateRandomRequest generateRandomRequest)

Generates an unpredictable byte string.

Specified by:

generateRandom in interface AWSKMS

Parameters:

generateRandomRequest - Container for the necessary parameters to execute the GenerateRandom service method on AWSKMS.

Returns:

The response from the GenerateRandom service method, as returned by AWSKMS.

Throws:

DependencyTimeoutException

KMSInternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

getKeyRotationStatus

public GetKeyRotationStatusResult getKeyRotationStatus(GetKeyRotationStatusRequest getKeyRotationStatusRequest)

Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.

Specified by:

getKeyRotationStatus in interface AWSKMS

Parameters:

getKeyRotationStatusRequest - Container for the necessary parameters to execute the GetKeyRotationStatus service method on AWSKMS.

Returns:

The response from the GetKeyRotationStatus service method, as returned by AWSKMS.

Throws:

DependencyTimeoutException

InvalidArnException

NotFoundException

KMSInternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

disableKeyRotation

public void disableKeyRotation(DisableKeyRotationRequest disableKeyRotationRequest)

Disables rotation of the specified key.

Specified by:

disableKeyRotation in interface AWSKMS

Parameters:

disableKeyRotationRequest - Container for the necessary parameters to execute the DisableKeyRotation service method on AWSKMS.

Throws:

DependencyTimeoutException

InvalidArnException

NotFoundException

DisabledException

KMSInternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

listKeyPolicies

public ListKeyPoliciesResult listKeyPolicies(ListKeyPoliciesRequest listKeyPoliciesRequest)

Retrieves a list of policies attached to a key.

Specified by:

listKeyPolicies in interface AWSKMS

Parameters:

listKeyPoliciesRequest - Container for the necessary parameters to execute the ListKeyPolicies service method on AWSKMS.

Returns:

The response from the ListKeyPolicies service method, as returned by AWSKMS.

Throws:

DependencyTimeoutException

InvalidArnException

NotFoundException

KMSInternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

createAlias

public void createAlias(CreateAliasRequest createAliasRequest)

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).

To associate an alias with a different key, call UpdateAlias.

Note that you cannot create or update an alias that represents a key in another account.

Specified by:

createAlias in interface AWSKMS

Parameters:

createAliasRequest - Container for the necessary parameters to execute the CreateAlias service method on AWSKMS.

Throws:

DependencyTimeoutException

AlreadyExistsException

InvalidAliasNameException

NotFoundException

KMSInternalException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

putKeyPolicy

public void putKeyPolicy(PutKeyPolicyRequest putKeyPolicyRequest)

Attaches a policy to the specified key.

Specified by:

putKeyPolicy in interface AWSKMS

Parameters:

putKeyPolicyRequest - Container for the necessary parameters to execute the PutKeyPolicy service method on AWSKMS.

Throws:

DependencyTimeoutException

MalformedPolicyDocumentException

InvalidArnException

NotFoundException

UnsupportedOperationException

KMSInternalException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

disableKey

public void disableKey(DisableKeyRequest disableKeyRequest)

Marks a key as disabled, thereby preventing its use.

Specified by:

disableKey in interface AWSKMS

Parameters:

disableKeyRequest - Container for the necessary parameters to execute the DisableKey service method on AWSKMS.

Throws:

DependencyTimeoutException

InvalidArnException

NotFoundException

KMSInternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

reEncrypt

public ReEncryptResult reEncrypt(ReEncryptRequest reEncryptRequest)

Encrypts data on the server side with a new customer master key without exposing the plaintext of the data on the client side. The data is first decrypted and then encrypted. This operation can also be used to change the encryption context of a ciphertext.

Unlike other actions, ReEncrypt is authorized twice - once as ReEncryptFrom on the source key and once as ReEncryptTo on the destination key. We therefore recommend that you include the "action":"kms:ReEncrypt*" statement in your key policies to permit re-encryption from or to the key. The statement is included automatically when you authorize use of the key through the console but must be included manually when you set a policy by using the PutKeyPolicy function.

Specified by:

reEncrypt in interface AWSKMS

Parameters:

reEncryptRequest - Container for the necessary parameters to execute the ReEncrypt service method on AWSKMS.

Returns:

The response from the ReEncrypt service method, as returned by AWSKMS.

Throws:

DependencyTimeoutException

InvalidGrantTokenException

KeyUnavailableException

NotFoundException

DisabledException

InvalidCiphertextException

InvalidKeyUsageException

KMSInternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

revokeGrant

public void revokeGrant(RevokeGrantRequest revokeGrantRequest)

Revokes a grant. You can revoke a grant to actively deny operations that depend on it.

Specified by:

revokeGrant in interface AWSKMS

Parameters:

revokeGrantRequest - Container for the necessary parameters to execute the RevokeGrant service method on AWSKMS.

Throws:

DependencyTimeoutException

InvalidArnException

NotFoundException

KMSInternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

enableKey

public void enableKey(EnableKeyRequest enableKeyRequest)

Marks a key as enabled, thereby permitting its use. You can have up to 25 enabled keys at one time.

Specified by:

enableKey in interface AWSKMS

Parameters:

enableKeyRequest - Container for the necessary parameters to execute the EnableKey service method on AWSKMS.

Throws:

DependencyTimeoutException

InvalidArnException

NotFoundException

KMSInternalException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

createKey

public CreateKeyResult createKey()
                          throws AmazonServiceException,
                                 AmazonClientException

Creates a customer master key. Customer master keys can be used to encrypt small amounts of data (less than 4K) directly, but they are most commonly used to encrypt or envelope data keys that are then used to encrypt customer data. For more information about data keys, see GenerateDataKey and GenerateDataKeyWithoutPlaintext.

Specified by:

createKey in interface AWSKMS

Returns:

The response from the CreateKey service method, as returned by AWSKMS.

Throws:

DependencyTimeoutException

MalformedPolicyDocumentException

InvalidArnException

UnsupportedOperationException

KMSInternalException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

listKeys

public ListKeysResult listKeys()
                        throws AmazonServiceException,
                               AmazonClientException

Lists the customer master keys.

Specified by:

listKeys in interface AWSKMS

Returns:

The response from the ListKeys service method, as returned by AWSKMS.

Throws:

DependencyTimeoutException

KMSInternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

listAliases

public ListAliasesResult listAliases()
                              throws AmazonServiceException,
                                     AmazonClientException

Lists all of the key aliases in the account.

Specified by:

listAliases in interface AWSKMS

Returns:

The response from the ListAliases service method, as returned by AWSKMS.

Throws:

DependencyTimeoutException

InvalidMarkerException

KMSInternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

retireGrant

public void retireGrant()
                 throws AmazonServiceException,
                        AmazonClientException

Retires a grant. You can retire a grant when you're done using it to clean up. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:

• The account that created the grant
• The RetiringPrincipal , if present
• The GranteePrincipal , if RetireGrant is a grantee operation

The grant to retire must be identified by its grant token or by a combination of the key ARN and the grant ID. A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. Both are returned by the CreateGrant function.

Specified by:

retireGrant in interface AWSKMS

Throws:

DependencyTimeoutException

InvalidGrantTokenException

NotFoundException

KMSInternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

generateRandom

public GenerateRandomResult generateRandom()
                                    throws AmazonServiceException,
                                           AmazonClientException

Generates an unpredictable byte string.

Specified by:

generateRandom in interface AWSKMS

Returns:

The response from the GenerateRandom service method, as returned by AWSKMS.

Throws:

DependencyTimeoutException

KMSInternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.

setEndpoint

public void setEndpoint(String endpoint)

Description copied from class: AmazonWebServiceClient

Overrides the default endpoint for this client. Callers can use this method to control which AWS region they want to work with.

This method is not threadsafe. Endpoints should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit.

Callers can pass in just the endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

Specified by:

setEndpoint in interface AWSKMS

Overrides:

setEndpoint in class AmazonWebServiceClient

Parameters:

endpoint - The endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setEndpoint

public void setEndpoint(String endpoint,
               String serviceName,
               String regionId)
                 throws IllegalArgumentException

Description copied from class: AmazonWebServiceClient

An internal method that is not expected to be normally called except for AWS internal development purposes.

Overrides the default endpoint for this client ("http://dynamodb.us-east-1.amazonaws.com/") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests. In almost all cases, this region ID and service name are automatically determined from the endpoint, and callers should use the simpler one-argument form of setEndpoint instead of this method.

Callers can pass in just the endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "http://dynamodb.us-east-1.amazonaws.com/"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912

Overrides:

setEndpoint in class AmazonWebServiceClient

Parameters:

endpoint - The endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "http://dynamodb.us-east-1.amazonaws.com/") of the region specific AWS endpoint this client will communicate with.

serviceName - This parameter is ignored.

regionId - The ID of the region in which this service resides AND the overriding region for signing purposes.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

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.