com.amazonaws.services.kms

Interface AWSKMS

All Known Subinterfaces:

AWSKMSAsync

All Known Implementing Classes:

AWSKMSAsyncClient, AWSKMSClient

public interface AWSKMS

Interface for accessing AWSKMS. 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 (need an address here). For the KMS developer guide, see (need address here).

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. However, you can also use the KMS Query API to make to make direct calls to the KMS web service.

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.

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 secure data key.
GenerateDataKeyWithoutPlaintextResult	generateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest generateDataKeyWithoutPlaintextRequest) Returns a key wrapped 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(RetireGrantRequest retireGrantRequest) Retires a grant.
void	revokeGrant(RevokeGrantRequest revokeGrantRequest) Revokes a grant.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://kms.us-east-1.amazonaws.com/").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
void	updateKeyDescription(UpdateKeyDescriptionRequest updateKeyDescriptionRequest) Updates the description of a key.

Method Detail

setEndpoint

void setEndpoint(String endpoint)
                 throws IllegalArgumentException

Overrides the default endpoint for this client ("https://kms.us-east-1.amazonaws.com/"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "kms.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "https://kms.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

This method is not threadsafe. An endpoint 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 or retrying.

Parameters:

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

Throws:

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

setRegion

void setRegion(Region region)
               throws IllegalArgumentException

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region 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 or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

createKey

CreateKeyResult createKey(CreateKeyRequest createKeyRequest)
                          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.

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

EncryptResult encrypt(EncryptRequest encryptRequest)
                      throws AmazonServiceException,
                             AmazonClientException

Encrypts plaintext into ciphertext by using a customer master key.

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

GetKeyPolicyResult getKeyPolicy(GetKeyPolicyRequest getKeyPolicyRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

Retrieves a policy attached to the specified key.

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

void updateKeyDescription(UpdateKeyDescriptionRequest updateKeyDescriptionRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

Updates the description of a key.

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

ListKeysResult listKeys(ListKeysRequest listKeysRequest)
                        throws AmazonServiceException,
                               AmazonClientException

Lists the customer master keys.

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

GenerateDataKeyResult generateDataKey(GenerateDataKeyRequest generateDataKeyRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException

Generates a secure data key. Data keys are used to encrypt and decrypt data. They are wrapped by customer master keys.

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

CreateGrantResult createGrant(CreateGrantRequest createGrantRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

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. If absent, access to the key is evaluated based on IAM policies attached to the user. By default, grants do not expire. Grants can be listed, retired, or revoked as indicated by the following APIs. Typically, when you are finished using a grant, you retire it. When you want to end a grant immediately, revoke it. For more information about grants, see Grants .

1. ListGrants
2. RetireGrant
3. RevokeGrant

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

ListAliasesResult listAliases(ListAliasesRequest listAliasesRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Lists all of the key aliases in the account.

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

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

GenerateDataKeyWithoutPlaintextResult generateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest generateDataKeyWithoutPlaintextRequest)
                                                                      throws AmazonServiceException,
                                                                             AmazonClientException

Returns a key wrapped by a customer master key without the plaintext copy of that key. To retrieve the plaintext, see GenerateDataKey.

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

void deleteAlias(DeleteAliasRequest deleteAliasRequest)
                 throws AmazonServiceException,
                        AmazonClientException

Deletes the specified alias.

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.

enableKeyRotation

void enableKeyRotation(EnableKeyRotationRequest enableKeyRotationRequest)
                       throws AmazonServiceException,
                              AmazonClientException

Enables rotation of the specified customer master key.

Parameters:

enableKeyRotationRequest - Container for the necessary parameters to execute the EnableKeyRotation 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.

retireGrant

void retireGrant(RetireGrantRequest retireGrantRequest)
                 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.

Parameters:

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

Throws:

DependencyTimeoutException

InvalidGrantTokenException

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

DescribeKeyResult describeKey(DescribeKeyRequest describeKeyRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Provides detailed information about the specified customer master key.

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

ListGrantsResult listGrants(ListGrantsRequest listGrantsRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

List the grants for a specified key.

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

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

DecryptResult decrypt(DecryptRequest decryptRequest)
                      throws AmazonServiceException,
                             AmazonClientException

Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using the Encrypt function.

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

GenerateRandomResult generateRandom(GenerateRandomRequest generateRandomRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Generates an unpredictable byte string.

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

GetKeyRotationStatusResult getKeyRotationStatus(GetKeyRotationStatusRequest getKeyRotationStatusRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

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

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

void disableKeyRotation(DisableKeyRotationRequest disableKeyRotationRequest)
                        throws AmazonServiceException,
                               AmazonClientException

Disables rotation of the specified key.

Parameters:

disableKeyRotationRequest - Container for the necessary parameters to execute the DisableKeyRotation 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.

listKeyPolicies

ListKeyPoliciesResult listKeyPolicies(ListKeyPoliciesRequest listKeyPoliciesRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException

Retrieves a list of policies attached to a key.

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

void createAlias(CreateAliasRequest createAliasRequest)
                 throws AmazonServiceException,
                        AmazonClientException

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

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

void putKeyPolicy(PutKeyPolicyRequest putKeyPolicyRequest)
                  throws AmazonServiceException,
                         AmazonClientException

Attaches a policy to the specified key.

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.

reEncrypt

ReEncryptResult reEncrypt(ReEncryptRequest reEncryptRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

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.

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

void revokeGrant(RevokeGrantRequest revokeGrantRequest)
                 throws AmazonServiceException,
                        AmazonClientException

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

Parameters:

revokeGrantRequest - Container for the necessary parameters to execute the RevokeGrant 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.

enableKey

void enableKey(EnableKeyRequest enableKeyRequest)
               throws AmazonServiceException,
                      AmazonClientException

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

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.

disableKey

void disableKey(DisableKeyRequest disableKeyRequest)
                throws AmazonServiceException,
                       AmazonClientException

Marks a key as disabled, thereby preventing its use.

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.

createKey

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.

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

ListKeysResult listKeys()
                        throws AmazonServiceException,
                               AmazonClientException

Lists the customer master keys.

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

ListAliasesResult listAliases()
                              throws AmazonServiceException,
                                     AmazonClientException

Lists all of the key aliases in the account.

Returns:

The response from the ListAliases 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.

generateRandom

GenerateRandomResult generateRandom()
                                    throws AmazonServiceException,
                                           AmazonClientException

Generates an unpredictable byte string.

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.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.