Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
   /*
    * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
    * 
    * Licensed under the Apache License, Version 2.0 (the "License").
    * You may not use this file except in compliance with the License.
    * A copy of the License is located at
    * 
    *  http://aws.amazon.com/apache2.0
    * 
   * or in the "license" file accompanying this file. This file is distributed
   * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
   * express or implied. See the License for the specific language governing
   * permissions and limitations under the License.
   */
  package com.amazonaws.services.kms;
  
  import com.amazonaws.*;
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 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
 
 public interface AWSKMS {

    
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 com.amazonaws.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:
java.lang.IllegalArgumentException If any problems are detected with the specified endpoint.
 
     public void setEndpoint(String endpointthrows java.lang.IllegalArgumentException;

    
An alternative to setEndpoint(java.lang.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 com.amazonaws.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.

 
     public void setRegion(Region regionthrows java.lang.IllegalArgumentException;
    
    

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:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.MalformedPolicyDocumentException
com.amazonaws.services.kms.model.InvalidArnException
UnsupportedOperationException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.services.kms.model.LimitExceededException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
 
     public CreateKeyResult createKey(CreateKeyRequest createKeyRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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.

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:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.InvalidGrantTokenException
com.amazonaws.services.kms.model.KeyUnavailableException
com.amazonaws.services.kms.model.NotFoundException
com.amazonaws.services.kms.model.DisabledException
com.amazonaws.services.kms.model.InvalidKeyUsageException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
 
     public EncryptResult encrypt(EncryptRequest encryptRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.InvalidArnException
com.amazonaws.services.kms.model.NotFoundException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
 
     public GetKeyPolicyResult getKeyPolicy(GetKeyPolicyRequest getKeyPolicyRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Updates the description of a key.

Parameters:
updateKeyDescriptionRequest Container for the necessary parameters to execute the UpdateKeyDescription service method on AWSKMS.
Throws:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.InvalidArnException
com.amazonaws.services.kms.model.NotFoundException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
 
     public void updateKeyDescription(UpdateKeyDescriptionRequest updateKeyDescriptionRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
 
     public ListKeysResult listKeys(ListKeysRequest listKeysRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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.

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:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.InvalidGrantTokenException
com.amazonaws.services.kms.model.KeyUnavailableException
com.amazonaws.services.kms.model.NotFoundException
com.amazonaws.services.kms.model.DisabledException
com.amazonaws.services.kms.model.InvalidKeyUsageException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
 
     public GenerateDataKeyResult generateDataKey(GenerateDataKeyRequest generateDataKeyRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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

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:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.InvalidGrantTokenException
com.amazonaws.services.kms.model.InvalidArnException
com.amazonaws.services.kms.model.NotFoundException
com.amazonaws.services.kms.model.DisabledException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.services.kms.model.LimitExceededException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
 
     public CreateGrantResult createGrant(CreateGrantRequest createGrantRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.InvalidMarkerException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
 
     public ListAliasesResult listAliases(ListAliasesRequest listAliasesRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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.

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:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.InvalidGrantTokenException
com.amazonaws.services.kms.model.KeyUnavailableException
com.amazonaws.services.kms.model.NotFoundException
com.amazonaws.services.kms.model.DisabledException
com.amazonaws.services.kms.model.InvalidKeyUsageException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

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

Parameters:
deleteAliasRequest Container for the necessary parameters to execute the DeleteAlias service method on AWSKMS.
Throws:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.NotFoundException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
 
     public void deleteAlias(DeleteAliasRequest deleteAliasRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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.

Parameters:
updateAliasRequest Container for the necessary parameters to execute the UpdateAlias service method on AWSKMS.
Throws:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.NotFoundException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
 
     public void updateAlias(UpdateAliasRequest updateAliasRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Enables rotation of the specified customer master key.

Parameters:
enableKeyRotationRequest Container for the necessary parameters to execute the EnableKeyRotation service method on AWSKMS.
Throws:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.InvalidArnException
com.amazonaws.services.kms.model.NotFoundException
com.amazonaws.services.kms.model.DisabledException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
 
     public void enableKeyRotation(EnableKeyRotationRequest enableKeyRotationRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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.

Parameters:
retireGrantRequest Container for the necessary parameters to execute the RetireGrant service method on AWSKMS.
Throws:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.InvalidGrantTokenException
com.amazonaws.services.kms.model.NotFoundException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
 
     public void retireGrant(RetireGrantRequest retireGrantRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.InvalidArnException
com.amazonaws.services.kms.model.NotFoundException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
 
     public DescribeKeyResult describeKey(DescribeKeyRequest describeKeyRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.InvalidMarkerException
com.amazonaws.services.kms.model.InvalidArnException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
 
     public ListGrantsResult listGrants(ListGrantsRequest listGrantsRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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.

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:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.InvalidGrantTokenException
com.amazonaws.services.kms.model.KeyUnavailableException
com.amazonaws.services.kms.model.NotFoundException
com.amazonaws.services.kms.model.DisabledException
com.amazonaws.services.kms.model.InvalidCiphertextException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
 
     public DecryptResult decrypt(DecryptRequest decryptRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
 
     public GenerateRandomResult generateRandom(GenerateRandomRequest generateRandomRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.InvalidArnException
com.amazonaws.services.kms.model.NotFoundException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
 
     public GetKeyRotationStatusResult getKeyRotationStatus(GetKeyRotationStatusRequest getKeyRotationStatusRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Disables rotation of the specified key.

Parameters:
disableKeyRotationRequest Container for the necessary parameters to execute the DisableKeyRotation service method on AWSKMS.
Throws:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.InvalidArnException
com.amazonaws.services.kms.model.NotFoundException
com.amazonaws.services.kms.model.DisabledException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
 
     public void disableKeyRotation(DisableKeyRotationRequest disableKeyRotationRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.InvalidArnException
com.amazonaws.services.kms.model.NotFoundException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
 
     public ListKeyPoliciesResult listKeyPolicies(ListKeyPoliciesRequest listKeyPoliciesRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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.

Parameters:
createAliasRequest Container for the necessary parameters to execute the CreateAlias service method on AWSKMS.
Throws:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.AlreadyExistsException
com.amazonaws.services.kms.model.InvalidAliasNameException
com.amazonaws.services.kms.model.NotFoundException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.services.kms.model.LimitExceededException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
 
     public void createAlias(CreateAliasRequest createAliasRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Attaches a policy to the specified key.

Parameters:
putKeyPolicyRequest Container for the necessary parameters to execute the PutKeyPolicy service method on AWSKMS.
Throws:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.MalformedPolicyDocumentException
com.amazonaws.services.kms.model.InvalidArnException
com.amazonaws.services.kms.model.NotFoundException
UnsupportedOperationException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.services.kms.model.LimitExceededException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
 
     public void putKeyPolicy(PutKeyPolicyRequest putKeyPolicyRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.InvalidArnException
com.amazonaws.services.kms.model.NotFoundException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
 
     public void disableKey(DisableKeyRequest disableKeyRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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.

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:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.InvalidGrantTokenException
com.amazonaws.services.kms.model.KeyUnavailableException
com.amazonaws.services.kms.model.NotFoundException
com.amazonaws.services.kms.model.DisabledException
com.amazonaws.services.kms.model.InvalidCiphertextException
com.amazonaws.services.kms.model.InvalidKeyUsageException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
 
     public ReEncryptResult reEncrypt(ReEncryptRequest reEncryptRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.InvalidArnException
com.amazonaws.services.kms.model.NotFoundException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
    public void revokeGrant(RevokeGrantRequest revokeGrantRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.InvalidArnException
com.amazonaws.services.kms.model.NotFoundException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.services.kms.model.LimitExceededException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
    public void enableKey(EnableKeyRequest enableKeyRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.MalformedPolicyDocumentException
com.amazonaws.services.kms.model.InvalidArnException
UnsupportedOperationException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.services.kms.model.LimitExceededException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
    public CreateKeyResult createKey() throws AmazonServiceExceptionAmazonClientException;
    
    

Lists the customer master keys.

Returns:
The response from the ListKeys service method, as returned by AWSKMS.
Throws:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
    public ListKeysResult listKeys() throws AmazonServiceExceptionAmazonClientException;
    
    

Lists all of the key aliases in the account.

Returns:
The response from the ListAliases service method, as returned by AWSKMS.
Throws:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.InvalidMarkerException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
    public ListAliasesResult listAliases() throws AmazonServiceExceptionAmazonClientException;
    
    

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.

Throws:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.InvalidGrantTokenException
com.amazonaws.services.kms.model.NotFoundException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
    public void retireGrant() throws AmazonServiceExceptionAmazonClientException;
    
    

Generates an unpredictable byte string.

Returns:
The response from the GenerateRandom service method, as returned by AWSKMS.
Throws:
com.amazonaws.services.kms.model.DependencyTimeoutException
com.amazonaws.services.kms.model.KMSInternalException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSKMS indicating either a problem with the data in the request, or a server side issue.
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.
    public void shutdown();
    
    
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.
}
        
New to GrepCode? Check out our FAQ X