AbstractAWSKMS (AWS Java SDK for AWS KMS 1.11.60 API)

java.lang.Object
- com.amazonaws.services.kms.AbstractAWSKMS

All Implemented Interfaces:

AWSKMS

Direct Known Subclasses:

AbstractAWSKMSAsync
```
public class AbstractAWSKMS
extends Object
implements AWSKMS
```
Abstract implementation of AWSKMS. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.kms.AWSKMS
  ENDPOINT_PREFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractAWSKMS()

Constructors
Modifier	Constructor and Description
`protected`	`AbstractAWSKMS()`

Method Summary

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractAWSKMS
```
protected AbstractAWSKMS()
```
- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from 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 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.
    
    Specified by:
    
    setEndpoint in interface AWSKMS
    
    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.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AWSKMS
    
    An alternative to AWSKMS.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.
    
    Specified by:
    
    setRegion in interface AWSKMS
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - cancelKeyDeletion
```
public CancelKeyDeletionResult cancelKeyDeletion(CancelKeyDeletionRequest request)
```
    Description copied from interface: AWSKMS
    
    Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the Disabled state. To enable a CMK, use EnableKey.
    
    For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
    
    Specified by:
    
    cancelKeyDeletion in interface AWSKMS
    
    Returns:
    
    Result of the CancelKeyDeletion operation returned by the service.
  - createAlias
```
public CreateAliasResult createAlias(CreateAliasRequest request)
```
    Description copied from interface: AWSKMS
    
    Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).
    
    The alias and the key it is mapped to must be in the same AWS account and the same region.
    
    To map an alias to a different key, call UpdateAlias.
    
    Specified by:
    
    createAlias in interface AWSKMS
    
    Returns:
    
    Result of the CreateAlias operation returned by the service.
  - createGrant
```
public CreateGrantResult createGrant(CreateGrantRequest request)
```
    Description copied from interface: AWSKMS
    
    Adds a grant to a key to specify who can use the key and under what conditions. Grants are alternate permission mechanisms to key policies.
    
    For more information about grants, see Grants in the AWS Key Management Service Developer Guide.
    
    Specified by:
    
    createGrant in interface AWSKMS
    
    Returns:
    
    Result of the CreateGrant operation returned by the service.
  - createKey
```
public CreateKeyResult createKey(CreateKeyRequest request)
```
    Description copied from interface: AWSKMS
    Creates a customer master key (CMK).
    
    You can use a CMK to encrypt small amounts of data (4 KiB or less) directly, but CMKs are more commonly used to encrypt data encryption keys (DEKs), which are used to encrypt raw data. For more information about DEKs and the difference between CMKs and DEKs, see the following:
    - The GenerateDataKey operation
    - AWS Key Management Service Concepts in the AWS Key Management Service Developer Guide
    Specified by:
    
    createKey in interface AWSKMS
    
    Returns:
    
    Result of the CreateKey operation returned by the service.
  - createKey
```
public CreateKeyResult createKey()
```
    Description copied from interface: AWSKMS
    
    Simplified method form for invoking the CreateKey operation.
    
    Specified by:
    
    createKey in interface AWSKMS
    
    See Also:
    
    AWSKMS.createKey(CreateKeyRequest)
  - decrypt
```
public DecryptResult decrypt(DecryptRequest request)
```
    Description copied from interface: AWSKMS
    Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following functions:
    Note that if a caller has been granted access permissions to all keys (through, for example, IAM user policies that grant Decrypt permission on all resources), then ciphertext encrypted by using keys in other accounts where the key grants access to the caller can be decrypted. To remedy this, we recommend that you do not grant Decrypt access in an IAM user policy. Instead grant Decrypt access only in key policies. If you must grant Decrypt access in an IAM user policy, you should scope the resource to specific keys or to specific trusted accounts.
    Specified by:
    
    decrypt in interface AWSKMS
    
    Returns:
    
    Result of the Decrypt operation returned by the service.
  - deleteAlias
```
public DeleteAliasResult deleteAlias(DeleteAliasRequest request)
```
    Description copied from interface: AWSKMS
    
    Deletes the specified alias. To map an alias to a different key, call UpdateAlias.
    
    Specified by:
    
    deleteAlias in interface AWSKMS
    
    Returns:
    
    Result of the DeleteAlias operation returned by the service.
  - deleteImportedKeyMaterial
```
public DeleteImportedKeyMaterialResult deleteImportedKeyMaterial(DeleteImportedKeyMaterialRequest request)
```
    Description copied from interface: AWSKMS
    
    Deletes key material that you previously imported and makes the specified customer master key (CMK) unusable. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.
    
    When the specified CMK is in the PendingDeletion state, this operation does not change the CMK's state. Otherwise, it changes the CMK's state to PendingImport.
    
    After you delete key material, you can use ImportKeyMaterial to reimport the same key material into the CMK.
    
    Specified by:
    
    deleteImportedKeyMaterial in interface AWSKMS
    
    Returns:
    
    Result of the DeleteImportedKeyMaterial operation returned by the service.
  - describeKey
```
public DescribeKeyResult describeKey(DescribeKeyRequest request)
```
    Description copied from interface: AWSKMS
    
    Provides detailed information about the specified customer master key.
    
    Specified by:
    
    describeKey in interface AWSKMS
    
    Returns:
    
    Result of the DescribeKey operation returned by the service.
  - disableKey
```
public DisableKeyResult disableKey(DisableKeyRequest request)
```
    Description copied from interface: AWSKMS
    
    Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
    
    Specified by:
    
    disableKey in interface AWSKMS
    
    Returns:
    
    Result of the DisableKey operation returned by the service.
  - disableKeyRotation
```
public DisableKeyRotationResult disableKeyRotation(DisableKeyRotationRequest request)
```
    Description copied from interface: AWSKMS
    
    Disables rotation of the specified key.
    
    Specified by:
    
    disableKeyRotation in interface AWSKMS
    
    Returns:
    
    Result of the DisableKeyRotation operation returned by the service.
  - enableKey
```
public EnableKeyResult enableKey(EnableKeyRequest request)
```
    Description copied from interface: AWSKMS
    
    Marks a key as enabled, thereby permitting its use.
    
    Specified by:
    
    enableKey in interface AWSKMS
    
    Returns:
    
    Result of the EnableKey operation returned by the service.
  - enableKeyRotation
```
public EnableKeyRotationResult enableKeyRotation(EnableKeyRotationRequest request)
```
    Description copied from interface: AWSKMS
    
    Enables rotation of the specified customer master key.
    
    Specified by:
    
    enableKeyRotation in interface AWSKMS
    
    Returns:
    
    Result of the EnableKeyRotation operation returned by the service.
  - encrypt
```
public EncryptResult encrypt(EncryptRequest request)
```
    Description copied from interface: AWSKMS
    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
    
    Returns:
    
    Result of the Encrypt operation returned by the service.
  - generateDataKey
```
public GenerateDataKeyResult generateDataKey(GenerateDataKeyRequest request)
```
    Description copied from interface: AWSKMS
    Returns a data encryption key that you can use in your application to encrypt data locally.
    
    You must specify the customer master key (CMK) under which to generate the data key. You must also specify the length of the data key using either the KeySpec or NumberOfBytes field. You must specify one field or the other, but not both. For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use KeySpec.
    
    This operation returns a plaintext copy of the data key in the Plaintext field of the response, and an encrypted copy of the data key in the CiphertextBlob field. The data key is encrypted under the CMK specified in the KeyId field of the request.
    
    We recommend that you use the following pattern to encrypt data locally in your application:
    1. Use this operation (GenerateDataKey) to retrieve a data encryption key.
    2. Use the plaintext data encryption key (returned in the Plaintext field of the response) to encrypt data locally, then erase the plaintext data key from memory.
    3. Store the encrypted data key (returned in the CiphertextBlob field of the response) alongside the locally encrypted data.
    To decrypt data locally:
    1. Use the Decrypt operation to decrypt the encrypted data key into a plaintext copy of the data key.
    2. Use the plaintext data key to decrypt data locally, then erase the plaintext data key from memory.
    To return only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To return an arbitrary unpredictable byte string, use GenerateRandom.
    
    If you use the optional EncryptionContext field, you must store at least enough information to be able to reconstruct the full encryption context when you later send the ciphertext to the Decrypt operation. It is a good practice to choose an encryption context that you can reconstruct on the fly to better secure the ciphertext. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
    Specified by:
    
    generateDataKey in interface AWSKMS
    
    Returns:
    
    Result of the GenerateDataKey operation returned by the service.
  - generateDataKeyWithoutPlaintext
```
public GenerateDataKeyWithoutPlaintextResult generateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest request)
```
    Description copied from interface: AWSKMS
    
    Returns a data encryption key encrypted under a customer master key (CMK). This operation is identical to GenerateDataKey but returns only the encrypted copy of the data key.
    
    This operation is useful in a system that has multiple components with different degrees of trust. For example, consider a system that stores encrypted data in containers. Each container stores the encrypted data and an encrypted copy of the data key. One component of the system, called the control plane, creates new containers. When it creates a new container, it uses this operation (GenerateDataKeyWithoutPlaintext ) to get an encrypted data key and then stores it in the container. Later, a different component of the system, called the data plane, puts encrypted data into the containers. To do this, it passes the encrypted data key to the Decrypt operation, then uses the returned plaintext data key to encrypt data, and finally stores the encrypted data in the container. In this system, the control plane never sees the plaintext data key.
    
    Specified by:
    
    generateDataKeyWithoutPlaintext in interface AWSKMS
    
    Returns:
    
    Result of the GenerateDataKeyWithoutPlaintext operation returned by the service.
  - generateRandom
```
public GenerateRandomResult generateRandom(GenerateRandomRequest request)
```
    Description copied from interface: AWSKMS
    
    Generates an unpredictable byte string.
    
    Specified by:
    
    generateRandom in interface AWSKMS
    
    Returns:
    
    Result of the GenerateRandom operation returned by the service.
  - generateRandom
```
public GenerateRandomResult generateRandom()
```
    Description copied from interface: AWSKMS
    
    Simplified method form for invoking the GenerateRandom operation.
    
    Specified by:
    
    generateRandom in interface AWSKMS
    
    See Also:
    
    AWSKMS.generateRandom(GenerateRandomRequest)
  - getKeyPolicy
```
public GetKeyPolicyResult getKeyPolicy(GetKeyPolicyRequest request)
```
    Description copied from interface: AWSKMS
    
    Retrieves a policy attached to the specified key.
    
    Specified by:
    
    getKeyPolicy in interface AWSKMS
    
    Returns:
    
    Result of the GetKeyPolicy operation returned by the service.
  - getKeyRotationStatus
```
public GetKeyRotationStatusResult getKeyRotationStatus(GetKeyRotationStatusRequest request)
```
    Description copied from interface: AWSKMS
    
    Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.
    
    Specified by:
    
    getKeyRotationStatus in interface AWSKMS
    
    Returns:
    
    Result of the GetKeyRotationStatus operation returned by the service.
  - getParametersForImport
```
public GetParametersForImportResult getParametersForImport(GetParametersForImportRequest request)
```
    Description copied from interface: AWSKMS
    
    Returns the items you need in order to import key material into AWS KMS from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.
    
    You must specify the key ID of the customer master key (CMK) into which you will import key material. This CMK's Origin must be EXTERNAL. You must also specify the wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key material.
    
    This operation returns a public key and an import token. Use the public key to encrypt the key material. Store the import token to send with a subsequent ImportKeyMaterial request. The public key and import token from the same response must be used together. These items are valid for 24 hours, after which they cannot be used for a subsequent ImportKeyMaterial request. To retrieve new ones, send another GetParametersForImport request.
    
    Specified by:
    
    getParametersForImport in interface AWSKMS
    
    Returns:
    
    Result of the GetParametersForImport operation returned by the service.
  - importKeyMaterial
```
public ImportKeyMaterialResult importKeyMaterial(ImportKeyMaterialRequest request)
```
    Description copied from interface: AWSKMS
    
    Imports key material into an AWS KMS customer master key (CMK) from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.
    
    You must specify the key ID of the CMK to import the key material into. This CMK's Origin must be EXTERNAL. You must also send an import token and the encrypted key material. Send the import token that you received in the same GetParametersForImport response that contained the public key that you used to encrypt the key material. You must also specify whether the key material expires and if so, when. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. To use the CMK again, you can reimport the same key material. If you set an expiration date, you can change it only by reimporting the same key material and specifying a new expiration date.
    
    When this operation is successful, the specified CMK's key state changes to Enabled, and you can use the CMK.
    
    After you successfully import key material into a CMK, you can reimport the same key material into that CMK, but you cannot import different key material.
    
    Specified by:
    
    importKeyMaterial in interface AWSKMS
    
    Returns:
    
    Result of the ImportKeyMaterial operation returned by the service.
  - listAliases
```
public ListAliasesResult listAliases(ListAliasesRequest request)
```
    Description copied from interface: AWSKMS
    
    Lists all of the key aliases in the account.
    
    Specified by:
    
    listAliases in interface AWSKMS
    
    Returns:
    
    Result of the ListAliases operation returned by the service.
  - listAliases
```
public ListAliasesResult listAliases()
```
    Description copied from interface: AWSKMS
    
    Simplified method form for invoking the ListAliases operation.
    
    Specified by:
    
    listAliases in interface AWSKMS
    
    See Also:
    
    AWSKMS.listAliases(ListAliasesRequest)
  - listGrants
```
public ListGrantsResult listGrants(ListGrantsRequest request)
```
    Description copied from interface: AWSKMS
    
    List the grants for a specified key.
    
    Specified by:
    
    listGrants in interface AWSKMS
    
    Returns:
    
    Result of the ListGrants operation returned by the service.
  - listKeyPolicies
```
public ListKeyPoliciesResult listKeyPolicies(ListKeyPoliciesRequest request)
```
    Description copied from interface: AWSKMS
    
    Retrieves a list of policies attached to a key.
    
    Specified by:
    
    listKeyPolicies in interface AWSKMS
    
    Returns:
    
    Result of the ListKeyPolicies operation returned by the service.
  - listKeys
```
public ListKeysResult listKeys(ListKeysRequest request)
```
    Description copied from interface: AWSKMS
    
    Lists the customer master keys.
    
    Specified by:
    
    listKeys in interface AWSKMS
    
    Returns:
    
    Result of the ListKeys operation returned by the service.
  - listKeys
```
public ListKeysResult listKeys()
```
    Description copied from interface: AWSKMS
    
    Simplified method form for invoking the ListKeys operation.
    
    Specified by:
    
    listKeys in interface AWSKMS
    
    See Also:
    
    AWSKMS.listKeys(ListKeysRequest)
  - listRetirableGrants
```
public ListRetirableGrantsResult listRetirableGrants(ListRetirableGrantsRequest request)
```
    Description copied from interface: AWSKMS
    
    Returns a list of all grants for which the grant's RetiringPrincipal matches the one specified.
    
    A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.
    
    Specified by:
    
    listRetirableGrants in interface AWSKMS
    
    Returns:
    
    Result of the ListRetirableGrants operation returned by the service.
  - putKeyPolicy
```
public PutKeyPolicyResult putKeyPolicy(PutKeyPolicyRequest request)
```
    Description copied from interface: AWSKMS
    
    Attaches a key policy to the specified customer master key (CMK).
    
    For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.
    
    Specified by:
    
    putKeyPolicy in interface AWSKMS
    
    Returns:
    
    Result of the PutKeyPolicy operation returned by the service.
  - reEncrypt
```
public ReEncryptResult reEncrypt(ReEncryptRequest request)
```
    Description copied from interface: AWSKMS
    
    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
    
    Returns:
    
    Result of the ReEncrypt operation returned by the service.
  - retireGrant
```
public RetireGrantResult retireGrant(RetireGrantRequest request)
```
    Description copied from interface: AWSKMS
    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
    
    Returns:
    
    Result of the RetireGrant operation returned by the service.
  - retireGrant
```
public RetireGrantResult retireGrant()
```
    Description copied from interface: AWSKMS
    
    Simplified method form for invoking the RetireGrant operation.
    
    Specified by:
    
    retireGrant in interface AWSKMS
    
    See Also:
    
    AWSKMS.retireGrant(RetireGrantRequest)
  - revokeGrant
```
public RevokeGrantResult revokeGrant(RevokeGrantRequest request)
```
    Description copied from interface: AWSKMS
    
    Revokes a grant. You can revoke a grant to actively deny operations that depend on it.
    
    Specified by:
    
    revokeGrant in interface AWSKMS
    
    Returns:
    
    Result of the RevokeGrant operation returned by the service.
  - scheduleKeyDeletion
```
public ScheduleKeyDeletionResult scheduleKeyDeletion(ScheduleKeyDeletionRequest request)
```
    Description copied from interface: AWSKMS
    
    Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the state of the CMK changes to PendingDeletion. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that point to it.
    
    Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use DisableKey.
    
    For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
    
    Specified by:
    
    scheduleKeyDeletion in interface AWSKMS
    
    Returns:
    
    Result of the ScheduleKeyDeletion operation returned by the service.
  - updateAlias
```
public UpdateAliasResult updateAlias(UpdateAliasRequest request)
```
    Description copied from interface: AWSKMS
    
    Updates an alias to map it to a different key.
    
    An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the key.
    
    An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).
    
    The alias and the key it is mapped to must be in the same AWS account and the same region.
    
    Specified by:
    
    updateAlias in interface AWSKMS
    
    Returns:
    
    Result of the UpdateAlias operation returned by the service.
  - updateKeyDescription
```
public UpdateKeyDescriptionResult updateKeyDescription(UpdateKeyDescriptionRequest request)
```
    Description copied from interface: AWSKMS
    
    Updates the description of a key.
    
    Specified by:
    
    updateKeyDescription in interface AWSKMS
    
    Returns:
    
    Result of the UpdateKeyDescription operation returned by the service.
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSKMS
    
    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.
    
    Specified by:
    
    shutdown in interface AWSKMS
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSKMS
    
    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.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSKMS
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Class AbstractAWSKMS

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractAWSKMS

Method Detail

setEndpoint

setRegion

cancelKeyDeletion

createAlias

createGrant

createKey

createKey

decrypt

deleteAlias

deleteImportedKeyMaterial

describeKey

disableKey

disableKeyRotation

enableKey

enableKeyRotation

encrypt

generateDataKey

generateDataKeyWithoutPlaintext

generateRandom

generateRandom

getKeyPolicy

getKeyRotationStatus

getParametersForImport

importKeyMaterial

listAliases

listAliases

listGrants

listKeyPolicies

listKeys

listKeys

listRetirableGrants

putKeyPolicy

reEncrypt

retireGrant

retireGrant

revokeGrant

scheduleKeyDeletion

updateAlias

updateKeyDescription

shutdown

getCachedResponseMetadata