AbstractAWSKMS (AWS SDK for Java

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

All Implemented Interfaces:

AWSKMS

Direct Known Subclasses:

AbstractAWSKMSAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
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

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 (CMK).
`CreateGrantResult`	`createGrant(CreateGrantRequest request)` Adds a grant to a customer master key (CMK).
`CreateKeyResult`	`createKey()` Simplified method form for invoking the CreateKey operation.
`CreateKeyResult`	`createKey(CreateKeyRequest request)` Creates a customer master key (CMK) in the caller's AWS account.
`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.
`DescribeKeyResult`	`describeKey(DescribeKeyRequest request)` Provides detailed information about the specified customer master key (CMK).
`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 automatic rotation of the key material for the specified customer master key (CMK).
`EnableKeyResult`	`enableKey(EnableKeyRequest request)` Sets the state of a customer master key (CMK) to enabled, thereby permitting its use for cryptographic operations.
`EnableKeyRotationResult`	`enableKeyRotation(EnableKeyRotationRequest request)` Enables automatic rotation of the key material for the specified customer master key (CMK).
`EncryptResult`	`encrypt(EncryptRequest request)` Encrypts plaintext into ciphertext by using a customer master key (CMK).
`GenerateDataKeyResult`	`generateDataKey(GenerateDataKeyRequest request)` Returns a data encryption key that you can use in your application to encrypt data locally.
`GenerateDataKeyWithoutPlaintextResult`	`generateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest request)` Returns a data encryption key encrypted under a customer master key (CMK).
`GenerateRandomResult`	`generateRandom()` Simplified method form for invoking the GenerateRandom operation.
`GenerateRandomResult`	`generateRandom(GenerateRandomRequest request)` Returns a random byte string that is cryptographically secure.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetKeyPolicyResult`	`getKeyPolicy(GetKeyPolicyRequest request)` Gets a key policy attached to the specified customer master key (CMK).
`GetKeyRotationStatusResult`	`getKeyRotationStatus(GetKeyRotationStatusRequest request)` Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified customer master key (CMK).
`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 existing AWS KMS customer master key (CMK) that was created without key material.
`ListAliasesResult`	`listAliases()` Simplified method form for invoking the ListAliases operation.
`ListAliasesResult`	`listAliases(ListAliasesRequest request)` Gets a list of all aliases in the caller's AWS account and region.
`ListGrantsResult`	`listGrants(ListGrantsRequest request)` Gets a list of all grants for the specified customer master key (CMK).
`ListKeyPoliciesResult`	`listKeyPolicies(ListKeyPoliciesRequest request)` Gets the names of the key policies that are attached to a customer master key (CMK).
`ListKeysResult`	`listKeys()` Simplified method form for invoking the ListKeys operation.
`ListKeysResult`	`listKeys(ListKeysRequest request)` Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.
`ListResourceTagsResult`	`listResourceTags(ListResourceTagsRequest request)` Returns a list of all tags for the specified customer master key (CMK).
`ListRetirableGrantsResult`	`listRetirableGrants(ListRetirableGrantsRequest request)` Returns a list of all grants for which the grant's `RetiringPrincipal` matches the one specified.
`PutKeyPolicyResult`	`putKeyPolicy(PutKeyPolicyRequest request)` Attaches a key policy to the specified customer master key (CMK).
`ReEncryptResult`	`reEncrypt(ReEncryptRequest request)` Encrypts data on the server side with a new customer master key (CMK) without exposing the plaintext of the data on the client side.
`RetireGrantResult`	`retireGrant()` Simplified method form for invoking the RetireGrant operation.
`RetireGrantResult`	`retireGrant(RetireGrantRequest request)` Retires a grant.
`RevokeGrantResult`	`revokeGrant(RevokeGrantRequest request)` Revokes the specified grant for the specified customer master key (CMK).
`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.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Adds or overwrites one or more tags for the specified customer master key (CMK).
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes the specified tag or tags from the specified customer master key (CMK).
`UpdateAliasResult`	`updateAlias(UpdateAliasRequest request)` Associates an existing alias with a different customer master key (CMK).
`UpdateKeyDescriptionResult`	`updateKeyDescription(UpdateKeyDescriptionRequest request)` Updates the description of a customer master key (CMK).

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

- 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. You cannot perform this operation on a CMK in a different AWS account.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createAlias
```
public CreateAliasResult createAlias(CreateAliasRequest request)
```
    Description copied from interface: AWSKMS
    
    Creates a display name for a customer master key (CMK). You can use an alias to identify a CMK in selected operations, such as Encrypt and GenerateDataKey.
    
    Each CMK can have multiple aliases, but each alias points to only one CMK. The alias name must be unique in the AWS account and region. To simplify code that runs in multiple regions, use the same alias name, but point it to a different CMK in each region.
    
    Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation.
    
    An alias must start with the word alias followed by a forward slash (alias/). The alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names cannot begin with aws; that alias name prefix is reserved by Amazon Web Services (AWS).
    
    The alias and the CMK it is mapped to must be in the same AWS account and the same region. You cannot perform this operation on an alias in a different AWS account.
    
    To map an existing alias to a different CMK, call UpdateAlias.
    
    Specified by:
    
    createAlias in interface AWSKMS
    
    Returns:
    
    Result of the CreateAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createGrant
```
public CreateGrantResult createGrant(CreateGrantRequest request)
```
    Description copied from interface: AWSKMS
    
    Adds a grant to a customer master key (CMK). The grant specifies who can use the CMK and under what conditions. When setting permissions, grants are an alternative to key policies.
    
    To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter. 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.
    
    See Also:
    
    AWS API Documentation
  - createKey
```
public CreateKeyResult createKey(CreateKeyRequest request)
```
    Description copied from interface: AWSKMS
    Creates a customer master key (CMK) in the caller's AWS account.
    
    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
    You cannot use this operation to create a CMK in a different AWS account.
    Specified by:
    
    createKey in interface AWSKMS
    
    Returns:
    
    Result of the CreateKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createKey
```
public CreateKeyResult createKey()
```
    Description copied from interface: AWSKMS
    
    Simplified method form for invoking the CreateKey operation.
    
    Specified by:
    
    createKey in interface AWSKMS
    
    See Also:
    
    AWSKMS.createKey(CreateKeyRequest)
  - decrypt
```
public DecryptResult decrypt(DecryptRequest request)
```
    Description copied from interface: AWSKMS
    Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following operations:
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteAlias
```
public DeleteAliasResult deleteAlias(DeleteAliasRequest request)
```
    Description copied from interface: AWSKMS
    
    Deletes the specified alias. You cannot perform this operation on an alias in a different AWS account.
    
    Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation.
    
    Each CMK can have multiple aliases. To change the alias of a CMK, use DeleteAlias to delete the current alias and CreateAlias to create a new alias. To associate an existing alias with a different customer master key (CMK), call UpdateAlias.
    
    Specified by:
    
    deleteAlias in interface AWSKMS
    
    Returns:
    
    Result of the DeleteAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteImportedKeyMaterial
```
public DeleteImportedKeyMaterialResult deleteImportedKeyMaterial(DeleteImportedKeyMaterialRequest request)
```
    Description copied from interface: AWSKMS
    
    Deletes key material that you previously imported. This operation 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. You cannot perform this operation on a CMK in a different AWS account.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - describeKey
```
public DescribeKeyResult describeKey(DescribeKeyRequest request)
```
    Description copied from interface: AWSKMS
    
    Provides detailed information about the specified customer master key (CMK).
    
    To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.
    
    Specified by:
    
    describeKey in interface AWSKMS
    
    Returns:
    
    Result of the DescribeKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - 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. You cannot perform this operation on a CMK in a different AWS account.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - disableKeyRotation
```
public DisableKeyRotationResult disableKeyRotation(DisableKeyRotationRequest request)
```
    Description copied from interface: AWSKMS
    
    Disables automatic rotation of the key material for the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
    
    Specified by:
    
    disableKeyRotation in interface AWSKMS
    
    Returns:
    
    Result of the DisableKeyRotation operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - enableKey
```
public EnableKeyResult enableKey(EnableKeyRequest request)
```
    Description copied from interface: AWSKMS
    
    Sets the state of a customer master key (CMK) to enabled, thereby permitting its use for cryptographic operations. You cannot perform this operation on a CMK in a different AWS account.
    
    Specified by:
    
    enableKey in interface AWSKMS
    
    Returns:
    
    Result of the EnableKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - enableKeyRotation
```
public EnableKeyRotationResult enableKeyRotation(EnableKeyRotationRequest request)
```
    Description copied from interface: AWSKMS
    
    Enables automatic rotation of the key material for the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
    
    Specified by:
    
    enableKeyRotation in interface AWSKMS
    
    Returns:
    
    Result of the EnableKeyRotation operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - encrypt
```
public EncryptResult encrypt(EncryptRequest request)
```
    Description copied from interface: AWSKMS
    Encrypts plaintext into ciphertext by using a customer master key (CMK). The Encrypt operation has two primary use cases:
    - You can encrypt up to 4 kilobytes (4096 bytes) of arbitrary data such as an RSA key, a database password, or other sensitive information.
    - To move encrypted data from one AWS region to another, you can use this operation 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.
    To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.
    
    Unless you are moving encrypted data from one region to another, you don't use this operation to encrypt a generated data key within a region. To get data keys that are already encrypted, call the GenerateDataKey or GenerateDataKeyWithoutPlaintext operation. Data keys don't need to be encrypted again by calling Encrypt.
    
    To encrypt data locally in your application, use the GenerateDataKey operation to return a plaintext data encryption key and a copy of the key encrypted under the CMK of your choosing.
    Specified by:
    
    encrypt in interface AWSKMS
    
    Returns:
    
    Result of the Encrypt operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - 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. To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.
    
    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 get a data encryption key.
    2. Use the plaintext data encryption key (returned in the Plaintext field of the response) to encrypt data locally, then erase the plaintext data key from memory.
    3. Store the encrypted data key (returned in the CiphertextBlob field of the response) alongside the locally encrypted data.
    To decrypt data locally:
    1. Use the Decrypt operation to decrypt the encrypted data key into a plaintext copy of the data key.
    2. Use the plaintext data key to decrypt data locally, then erase the plaintext data key from memory.
    To return only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To return a random byte string that is cryptographically secure, use GenerateRandom.
    
    If you use the optional EncryptionContext field, you must store at least enough information to be able to reconstruct the full encryption context when you later send the ciphertext to the Decrypt operation. It is a good practice to choose an encryption context that you can reconstruct on the fly to better secure the ciphertext. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
    Specified by:
    
    generateDataKey in interface AWSKMS
    
    Returns:
    
    Result of the GenerateDataKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - 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.
    
    To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - generateRandom
```
public GenerateRandomResult generateRandom(GenerateRandomRequest request)
```
    Description copied from interface: AWSKMS
    
    Returns a random byte string that is cryptographically secure.
    
    For more information about entropy and random number generation, see the AWS Key Management Service Cryptographic Details whitepaper.
    
    Specified by:
    
    generateRandom in interface AWSKMS
    
    Returns:
    
    Result of the GenerateRandom operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - generateRandom
```
public GenerateRandomResult generateRandom()
```
    Description copied from interface: AWSKMS
    
    Simplified method form for invoking the GenerateRandom operation.
    
    Specified by:
    
    generateRandom in interface AWSKMS
    
    See Also:
    
    AWSKMS.generateRandom(GenerateRandomRequest)
  - getKeyPolicy
```
public GetKeyPolicyResult getKeyPolicy(GetKeyPolicyRequest request)
```
    Description copied from interface: AWSKMS
    
    Gets a key policy attached to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
    
    Specified by:
    
    getKeyPolicy in interface AWSKMS
    
    Returns:
    
    Result of the GetKeyPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getKeyRotationStatus
```
public GetKeyRotationStatusResult getKeyRotationStatus(GetKeyRotationStatusRequest request)
```
    Description copied from interface: AWSKMS
    
    Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified customer master key (CMK).
    
    To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.
    
    Specified by:
    
    getKeyRotationStatus in interface AWSKMS
    
    Returns:
    
    Result of the GetKeyRotationStatus operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - 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. You cannot perform this operation on a CMK in a different AWS account.
    
    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. When they expire, they cannot be used for a subsequent ImportKeyMaterial request. To get new ones, send another GetParametersForImport request.
    
    Specified by:
    
    getParametersForImport in interface AWSKMS
    
    Returns:
    
    Result of the GetParametersForImport operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - importKeyMaterial
```
public ImportKeyMaterialResult importKeyMaterial(ImportKeyMaterialRequest request)
```
    Description copied from interface: AWSKMS
    Imports key material into an existing AWS KMS customer master key (CMK) that was created without key material. You cannot perform this operation on a CMK in a different AWS account. For more information about creating CMKs with no key material and then importing key material, see Importing Key Material in the AWS Key Management Service Developer Guide.
    
    Before using this operation, call GetParametersForImport. Its response includes a public key and an import token. Use the public key to encrypt the key material. Then, submit the import token from the same GetParametersForImport response.
    
    When calling this operation, you must specify the following values:
    - The key ID or key ARN of a CMK with no key material. Its Origin must be EXTERNAL.
      
      To create a CMK with no key material, call CreateKey and set the value of its Origin parameter to EXTERNAL. To get the Origin of a CMK, call DescribeKey.)
    - The encrypted key material. To get the public key to encrypt the key material, call GetParametersForImport.
    - The import token that GetParametersForImport returned. This token and the public key used to encrypt the key material must have come from the same response.
    - Whether the key material expires and if so, when. If you set an expiration date, you can change it only by reimporting the same key material and specifying a new expiration date. If the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. To use the CMK again, you must reimport the same key material.
    When this operation is successful, the CMK's key state changes from PendingImport 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.
    
    See Also:
    
    AWS API Documentation
  - listAliases
```
public ListAliasesResult listAliases(ListAliasesRequest request)
```
    Description copied from interface: AWSKMS
    
    Gets a list of all aliases in the caller's AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see CreateAlias.
    
    The response might include several aliases that do not have a TargetKeyId field because they are not associated with a CMK. These are predefined aliases that are reserved for CMKs managed by AWS services. If an alias is not associated with a CMK, the alias does not count against the alias limit for your account.
    
    Specified by:
    
    listAliases in interface AWSKMS
    
    Returns:
    
    Result of the ListAliases operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAliases
```
public ListAliasesResult listAliases()
```
    Description copied from interface: AWSKMS
    
    Simplified method form for invoking the ListAliases operation.
    
    Specified by:
    
    listAliases in interface AWSKMS
    
    See Also:
    
    AWSKMS.listAliases(ListAliasesRequest)
  - listGrants
```
public ListGrantsResult listGrants(ListGrantsRequest request)
```
    Description copied from interface: AWSKMS
    
    Gets a list of all grants for the specified customer master key (CMK).
    
    To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.
    
    Specified by:
    
    listGrants in interface AWSKMS
    
    Returns:
    
    Result of the ListGrants operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listKeyPolicies
```
public ListKeyPoliciesResult listKeyPolicies(ListKeyPoliciesRequest request)
```
    Description copied from interface: AWSKMS
    
    Gets the names of the key policies that are attached to a customer master key (CMK). This operation is designed to get policy names that you can use in a GetKeyPolicy operation. However, the only valid policy name is default. You cannot perform this operation on a CMK in a different AWS account.
    
    Specified by:
    
    listKeyPolicies in interface AWSKMS
    
    Returns:
    
    Result of the ListKeyPolicies operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listKeys
```
public ListKeysResult listKeys(ListKeysRequest request)
```
    Description copied from interface: AWSKMS
    
    Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.
    
    Specified by:
    
    listKeys in interface AWSKMS
    
    Returns:
    
    Result of the ListKeys operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listKeys
```
public ListKeysResult listKeys()
```
    Description copied from interface: AWSKMS
    
    Simplified method form for invoking the ListKeys operation.
    
    Specified by:
    
    listKeys in interface AWSKMS
    
    See Also:
    
    AWSKMS.listKeys(ListKeysRequest)
  - listResourceTags
```
public ListResourceTagsResult listResourceTags(ListResourceTagsRequest request)
```
    Description copied from interface: AWSKMS
    
    Returns a list of all tags for the specified customer master key (CMK).
    
    You cannot perform this operation on a CMK in a different AWS account.
    
    Specified by:
    
    listResourceTags in interface AWSKMS
    
    Returns:
    
    Result of the ListResourceTags operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - 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.
    
    See Also:
    
    AWS API Documentation
  - putKeyPolicy
```
public PutKeyPolicyResult putKeyPolicy(PutKeyPolicyRequest request)
```
    Description copied from interface: AWSKMS
    
    Attaches a key policy to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - reEncrypt
```
public ReEncryptResult reEncrypt(ReEncryptRequest request)
```
    Description copied from interface: AWSKMS
    
    Encrypts data on the server side with a new customer master key (CMK) without exposing the plaintext of the data on the client side. The data is first decrypted and then reencrypted. You can also use this operation to change the encryption context of a ciphertext.
    
    You can reencrypt data using CMKs in different AWS accounts.
    
    Unlike other operations, ReEncrypt is authorized twice, once as ReEncryptFrom on the source CMK and once as ReEncryptTo on the destination CMK. We recommend that you include the "kms:ReEncrypt*" permission in your key policies to permit reencryption from or to the CMK. This permission is automatically included in the key policy when you create a CMK through the console, but you must include it manually when you create a CMK programmatically or when you set a key policy with the PutKeyPolicy operation.
    
    Specified by:
    
    reEncrypt in interface AWSKMS
    
    Returns:
    
    Result of the ReEncrypt operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - retireGrant
```
public RetireGrantResult retireGrant(RetireGrantRequest request)
```
    Description copied from interface: AWSKMS
    Retires a grant. To clean up, you can retire a grant when you're done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:
    - The AWS account (root user) under which the grant was created
    - The RetiringPrincipal, if present in the grant
    - The GranteePrincipal, if RetireGrant is an operation specified in the grant
    You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The CreateGrant operation returns both.
    Specified by:
    
    retireGrant in interface AWSKMS
    
    Returns:
    
    Result of the RetireGrant operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - retireGrant
```
public RetireGrantResult retireGrant()
```
    Description copied from interface: AWSKMS
    
    Simplified method form for invoking the RetireGrant operation.
    
    Specified by:
    
    retireGrant in interface AWSKMS
    
    See Also:
    
    AWSKMS.retireGrant(RetireGrantRequest)
  - revokeGrant
```
public RevokeGrantResult revokeGrant(RevokeGrantRequest request)
```
    Description copied from interface: AWSKMS
    
    Revokes the specified grant for the specified customer master key (CMK). You can revoke a grant to actively deny operations that depend on it.
    
    To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.
    
    Specified by:
    
    revokeGrant in interface AWSKMS
    
    Returns:
    
    Result of the RevokeGrant operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - 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 refer to it.
    
    You cannot perform this operation on a CMK in a different AWS account.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AWSKMS
    
    Adds or overwrites one or more tags for the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
    
    Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
    
    You cannot use the same tag key more than once per CMK. For example, consider a CMK with one tag whose tag key is Purpose and tag value is Test. If you send a TagResource request for this CMK with a tag key of Purpose and a tag value of Prod, it does not create a second tag. Instead, the original tag is overwritten with the new tag value.
    
    For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.
    
    Specified by:
    
    tagResource in interface AWSKMS
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AWSKMS
    
    Removes the specified tag or tags from the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
    
    To remove a tag, you specify the tag key for each tag to remove. You do not specify the tag value. To overwrite the tag value for an existing tag, use TagResource.
    
    Specified by:
    
    untagResource in interface AWSKMS
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateAlias
```
public UpdateAliasResult updateAlias(UpdateAliasRequest request)
```
    Description copied from interface: AWSKMS
    
    Associates an existing alias with a different customer master key (CMK). Each CMK can have multiple aliases, but the aliases must be unique within the account and region. You cannot perform this operation on an alias in a different AWS account.
    
    This operation works only on existing aliases. To change the alias of a CMK to a new value, use CreateAlias to create a new alias and DeleteAlias to delete the old alias.
    
    Because an alias is not a property of a CMK, you can create, update, and delete the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs in the account, use the ListAliases operation.
    
    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/). The alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names cannot begin with aws; that alias name prefix is reserved by Amazon Web Services (AWS).
    
    Specified by:
    
    updateAlias in interface AWSKMS
    
    Returns:
    
    Result of the UpdateAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateKeyDescription
```
public UpdateKeyDescriptionResult updateKeyDescription(UpdateKeyDescriptionRequest request)
```
    Description copied from interface: AWSKMS
    
    Updates the description of a customer master key (CMK). To see the decription of a CMK, use DescribeKey.
    
    You cannot perform this operation on a CMK in a different AWS account.
    
    Specified by:
    
    updateKeyDescription in interface AWSKMS
    
    Returns:
    
    Result of the UpdateKeyDescription operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - 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.

Did this page help you?

Class AbstractAWSKMS

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

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

listResourceTags

listRetirableGrants

putKeyPolicy

reEncrypt

retireGrant

retireGrant

revokeGrant

scheduleKeyDeletion

tagResource

untagResource

updateAlias

updateKeyDescription

shutdown

getCachedResponseMetadata