public interface AWSKMS
AWS Key Management Service (AWS KMS) is an encryption and key management web service. This guide describes the AWS KMS operations that you can call programmatically. For general information about AWS KMS, see the AWS Key Management Service Developer Guide.
AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS KMS and other AWS services. 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 AWS 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 (root) access key ID and secret key for everyday work with AWS KMS. Instead, use the access key ID and secret access key for an IAM user. You can also use the AWS Security Token Service to generate temporary security credentials that you can use to sign requests.
All AWS KMS operations require Signature Version 4.
Logging API Requests
AWS KMS supports AWS CloudTrail, a service that logs 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 AWS 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.
Temporary Security Credentials - This section of the IAM User Guide describes how to create and use temporary security credentials.
Signature Version 4 Signing Process - 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 API Operations
Of the API operations discussed in this guide, the following will prove the most useful for most applications. You will likely perform operations other than these, such as creating keys and assigning policies, by using the console.
| Modifier and Type | Method and Description |
|---|---|
CancelKeyDeletionResult |
cancelKeyDeletion(CancelKeyDeletionRequest cancelKeyDeletionRequest)
Cancels the deletion of a customer master key (CMK).
|
void |
createAlias(CreateAliasRequest createAliasRequest)
Creates a display name for a customer-managed customer master key (CMK).
|
CreateGrantResult |
createGrant(CreateGrantRequest createGrantRequest)
Adds a grant to a customer master key (CMK).
|
CreateKeyResult |
createKey()
Creates a customer master key (CMK) in the caller's AWS account.
|
CreateKeyResult |
createKey(CreateKeyRequest createKeyRequest)
Creates a customer master key (CMK) in the caller's AWS account.
|
DecryptResult |
decrypt(DecryptRequest decryptRequest)
Decrypts ciphertext.
|
void |
deleteAlias(DeleteAliasRequest deleteAliasRequest)
Deletes the specified alias.
|
void |
deleteImportedKeyMaterial(DeleteImportedKeyMaterialRequest deleteImportedKeyMaterialRequest)
Deletes key material that you previously imported.
|
DescribeKeyResult |
describeKey(DescribeKeyRequest describeKeyRequest)
Provides detailed information about the specified customer master key
(CMK).
|
void |
disableKey(DisableKeyRequest disableKeyRequest)
Sets the state of a customer master key (CMK) to disabled, thereby
preventing its use for cryptographic operations.
|
void |
disableKeyRotation(DisableKeyRotationRequest disableKeyRotationRequest)
Disables automatic rotation of the key material for the specified customer
master key (CMK).
|
void |
enableKey(EnableKeyRequest enableKeyRequest)
Sets the state of a customer master key (CMK) to enabled, thereby
permitting its use for cryptographic operations.
|
void |
enableKeyRotation(EnableKeyRotationRequest enableKeyRotationRequest)
Enables automatic rotation of the key material for the specified customer
master key (CMK).
|
EncryptResult |
encrypt(EncryptRequest encryptRequest)
Encrypts plaintext into ciphertext by using a customer master key (CMK).
|
GenerateDataKeyResult |
generateDataKey(GenerateDataKeyRequest generateDataKeyRequest)
Returns a data encryption key that you can use in your application to
encrypt data locally.
|
GenerateDataKeyWithoutPlaintextResult |
generateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest generateDataKeyWithoutPlaintextRequest)
Returns a data encryption key encrypted under a customer master key
(CMK).
|
GenerateRandomResult |
generateRandom()
Returns a random byte string that is cryptographically secure.
|
GenerateRandomResult |
generateRandom(GenerateRandomRequest generateRandomRequest)
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 getKeyPolicyRequest)
Gets a key policy attached to the specified customer master key (CMK).
|
GetKeyRotationStatusResult |
getKeyRotationStatus(GetKeyRotationStatusRequest getKeyRotationStatusRequest)
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 getParametersForImportRequest)
Returns the items you need in order to import key material into AWS KMS
from your existing key management infrastructure.
|
ImportKeyMaterialResult |
importKeyMaterial(ImportKeyMaterialRequest importKeyMaterialRequest)
Imports key material into an existing AWS KMS customer master key (CMK)
that was created without key material.
|
ListAliasesResult |
listAliases()
Gets a list of aliases in the caller's AWS account and region.
|
ListAliasesResult |
listAliases(ListAliasesRequest listAliasesRequest)
Gets a list of aliases in the caller's AWS account and region.
|
ListGrantsResult |
listGrants(ListGrantsRequest listGrantsRequest)
Gets a list of all grants for the specified customer master key (CMK).
|
ListKeyPoliciesResult |
listKeyPolicies(ListKeyPoliciesRequest listKeyPoliciesRequest)
Gets the names of the key policies that are attached to a customer master
key (CMK).
|
ListKeysResult |
listKeys()
Gets a list of all customer master keys (CMKs) in the caller's AWS
account and region.
|
ListKeysResult |
listKeys(ListKeysRequest listKeysRequest)
Gets a list of all customer master keys (CMKs) in the caller's AWS
account and region.
|
ListResourceTagsResult |
listResourceTags(ListResourceTagsRequest listResourceTagsRequest)
Returns a list of all tags for the specified customer master key (CMK).
|
ListRetirableGrantsResult |
listRetirableGrants(ListRetirableGrantsRequest listRetirableGrantsRequest)
Returns a list of all grants for which the grant's
RetiringPrincipal matches the one specified. |
void |
putKeyPolicy(PutKeyPolicyRequest putKeyPolicyRequest)
Attaches a key policy to the specified customer master key (CMK).
|
ReEncryptResult |
reEncrypt(ReEncryptRequest reEncryptRequest)
Encrypts data on the server side with a new customer master key (CMK)
without exposing the plaintext of the data on the client side.
|
void |
retireGrant()
Retires a grant.
|
void |
retireGrant(RetireGrantRequest retireGrantRequest)
Retires a grant.
|
void |
revokeGrant(RevokeGrantRequest revokeGrantRequest)
Revokes the specified grant for the specified customer master key (CMK).
|
ScheduleKeyDeletionResult |
scheduleKeyDeletion(ScheduleKeyDeletionRequest scheduleKeyDeletionRequest)
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
setEndpoint(String), sets the regional
endpoint for this client's service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
void |
tagResource(TagResourceRequest tagResourceRequest)
Adds or edits tags for a customer master key (CMK).
|
void |
untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tags from the specified customer master key (CMK).
|
void |
updateAlias(UpdateAliasRequest updateAliasRequest)
Associates an existing alias with a different customer master key (CMK).
|
void |
updateKeyDescription(UpdateKeyDescriptionRequest updateKeyDescriptionRequest)
Updates the description of a customer master key (CMK).
|
void setEndpoint(String endpoint) throws IllegalArgumentException
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.
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.IllegalArgumentException - If any problems are detected with the
specified endpoint.void setRegion(Region region) throws IllegalArgumentException
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.
region - The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions) for
accessing a given region.IllegalArgumentException - If the given region is null,
or if this service isn't available in the given region. See
Region.isServiceSupported(String)Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class,
com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)CancelKeyDeletionResult cancelKeyDeletion(CancelKeyDeletionRequest cancelKeyDeletionRequest) throws AmazonClientException, AmazonServiceException
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.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
cancelKeyDeletionRequest - NotFoundExceptionInvalidArnExceptionDependencyTimeoutExceptionKMSInternalExceptionKMSInvalidStateExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.void createAlias(CreateAliasRequest createAliasRequest) throws AmazonClientException, AmazonServiceException
Creates a display name for a customer-managed 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.
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 for AWS managed CMKs.
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.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
createAliasRequest - DependencyTimeoutExceptionAlreadyExistsExceptionNotFoundExceptionInvalidAliasNameExceptionKMSInternalExceptionLimitExceededExceptionKMSInvalidStateExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.CreateGrantResult createGrant(CreateGrantRequest createGrantRequest) throws AmazonClientException, AmazonServiceException
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.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
createGrantRequest - NotFoundExceptionDisabledExceptionDependencyTimeoutExceptionInvalidArnExceptionKMSInternalExceptionInvalidGrantTokenExceptionLimitExceededExceptionKMSInvalidStateExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.CreateKeyResult createKey(CreateKeyRequest createKeyRequest) throws AmazonClientException, AmazonServiceException
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.
createKeyRequest - MalformedPolicyDocumentExceptionDependencyTimeoutExceptionInvalidArnExceptionUnsupportedOperationExceptionKMSInternalExceptionLimitExceededExceptionTagExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.DecryptResult decrypt(DecryptRequest decryptRequest) throws AmazonClientException, AmazonServiceException
Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following operations:
Whenever possible, use key policies to give users permission to call the
Decrypt operation on the CMK, instead of IAM policies. Otherwise, you
might create an IAM user policy that gives the user Decrypt permission on
all CMKs. This user could decrypt ciphertext that was encrypted by CMKs
in other accounts if the key policy for the cross-account CMK permits it.
If you must use an IAM policy for Decrypt permissions, limit
the user to particular CMKs or particular trusted accounts.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
decryptRequest - NotFoundExceptionDisabledExceptionInvalidCiphertextExceptionKeyUnavailableExceptionDependencyTimeoutExceptionInvalidGrantTokenExceptionKMSInternalExceptionKMSInvalidStateExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.void deleteAlias(DeleteAliasRequest deleteAliasRequest) throws AmazonClientException, AmazonServiceException
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.
deleteAliasRequest - DependencyTimeoutExceptionNotFoundExceptionKMSInternalExceptionKMSInvalidStateExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.void deleteImportedKeyMaterial(DeleteImportedKeyMaterialRequest deleteImportedKeyMaterialRequest) throws AmazonClientException, AmazonServiceException
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.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
deleteImportedKeyMaterialRequest - InvalidArnExceptionUnsupportedOperationExceptionDependencyTimeoutExceptionNotFoundExceptionKMSInternalExceptionKMSInvalidStateExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.DescribeKeyResult describeKey(DescribeKeyRequest describeKeyRequest) throws AmazonClientException, AmazonServiceException
Provides detailed information about the specified customer master key (CMK).
You can use DescribeKey on a predefined AWS alias, that is,
an AWS alias with no key ID. When you do, AWS KMS associates the alias
with an AWS managed CMK and returns its KeyId and
Arn in the response.
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.
describeKeyRequest - NotFoundExceptionInvalidArnExceptionDependencyTimeoutExceptionKMSInternalExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.void disableKey(DisableKeyRequest disableKeyRequest) throws AmazonClientException, AmazonServiceException
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.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
disableKeyRequest - NotFoundExceptionInvalidArnExceptionDependencyTimeoutExceptionKMSInternalExceptionKMSInvalidStateExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.void disableKeyRotation(DisableKeyRotationRequest disableKeyRotationRequest) throws AmazonClientException, AmazonServiceException
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.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
disableKeyRotationRequest - NotFoundExceptionDisabledExceptionInvalidArnExceptionDependencyTimeoutExceptionKMSInternalExceptionKMSInvalidStateExceptionUnsupportedOperationExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.void enableKey(EnableKeyRequest enableKeyRequest) throws AmazonClientException, AmazonServiceException
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.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
enableKeyRequest - NotFoundExceptionInvalidArnExceptionDependencyTimeoutExceptionKMSInternalExceptionLimitExceededExceptionKMSInvalidStateExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.void enableKeyRotation(EnableKeyRotationRequest enableKeyRotationRequest) throws AmazonClientException, AmazonServiceException
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.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
enableKeyRotationRequest - NotFoundExceptionDisabledExceptionInvalidArnExceptionDependencyTimeoutExceptionKMSInternalExceptionKMSInvalidStateExceptionUnsupportedOperationExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.EncryptResult encrypt(EncryptRequest encryptRequest) throws AmazonClientException, AmazonServiceException
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.
You can use the Encrypt operation to move encrypted data
from one AWS region to another. In the first region, generate a data key
and use the plaintext key to encrypt the data. Then, in the new region,
call the Encrypt method on same plaintext data key. Now, you
can safely move the encrypted data and encrypted data key to the new
region, and decrypt in the new region when necessary.
You don't need use this operation to encrypt a data key within a region. The GenerateDataKey and GenerateDataKeyWithoutPlaintext operations return an encrypted data key.
Also, you don't need to use this operation to encrypt data in your
application. You can use the plaintext and encrypted data keys that the
GenerateDataKey operation returns.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
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.
encryptRequest - NotFoundExceptionDisabledExceptionKeyUnavailableExceptionDependencyTimeoutExceptionInvalidKeyUsageExceptionInvalidGrantTokenExceptionKMSInternalExceptionKMSInvalidStateExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.GenerateDataKeyResult generateDataKey(GenerateDataKeyRequest generateDataKeyRequest) throws AmazonClientException, AmazonServiceException
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:
Use this operation (GenerateDataKey) to get a data
encryption key.
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.
Store the encrypted data key (returned in the CiphertextBlob
field of the response) alongside the locally encrypted data.
To decrypt data locally:
Use the Decrypt operation to decrypt the encrypted data key into a plaintext copy of the data key.
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.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
generateDataKeyRequest - NotFoundExceptionDisabledExceptionKeyUnavailableExceptionDependencyTimeoutExceptionInvalidKeyUsageExceptionInvalidGrantTokenExceptionKMSInternalExceptionKMSInvalidStateExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.GenerateDataKeyWithoutPlaintextResult generateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest generateDataKeyWithoutPlaintextRequest) throws AmazonClientException, AmazonServiceException
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. It 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.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
generateDataKeyWithoutPlaintextRequest - NotFoundExceptionDisabledExceptionKeyUnavailableExceptionDependencyTimeoutExceptionInvalidKeyUsageExceptionInvalidGrantTokenExceptionKMSInternalExceptionKMSInvalidStateExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.GenerateRandomResult generateRandom(GenerateRandomRequest generateRandomRequest) throws AmazonClientException, AmazonServiceException
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.
generateRandomRequest - DependencyTimeoutExceptionKMSInternalExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.GetKeyPolicyResult getKeyPolicy(GetKeyPolicyRequest getKeyPolicyRequest) throws AmazonClientException, AmazonServiceException
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.
getKeyPolicyRequest - NotFoundExceptionInvalidArnExceptionDependencyTimeoutExceptionKMSInternalExceptionKMSInvalidStateExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.GetKeyRotationStatusResult getKeyRotationStatus(GetKeyRotationStatusRequest getKeyRotationStatusRequest) throws AmazonClientException, AmazonServiceException
Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified customer master key (CMK).
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Disabled: The key rotation status does not change when you disable a CMK. However, while the CMK is disabled, AWS KMS does not rotate the backing key.
Pending deletion: While a CMK is pending deletion, its key rotation
status is false and AWS KMS does not rotate the backing key.
If you cancel the deletion, the original key rotation status is restored.
To perform this operation on a CMK in a different AWS account, specify
the key ARN in the value of the KeyId parameter.
getKeyRotationStatusRequest - NotFoundExceptionInvalidArnExceptionDependencyTimeoutExceptionKMSInternalExceptionKMSInvalidStateExceptionUnsupportedOperationExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.GetParametersForImportResult getParametersForImport(GetParametersForImportRequest getParametersForImportRequest) throws AmazonClientException, AmazonServiceException
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.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
getParametersForImportRequest - InvalidArnExceptionUnsupportedOperationExceptionDependencyTimeoutExceptionNotFoundExceptionKMSInternalExceptionKMSInvalidStateExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.ImportKeyMaterialResult importKeyMaterial(ImportKeyMaterialRequest importKeyMaterialRequest) throws AmazonClientException, AmazonServiceException
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.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
importKeyMaterialRequest - InvalidArnExceptionUnsupportedOperationExceptionDependencyTimeoutExceptionNotFoundExceptionKMSInternalExceptionKMSInvalidStateExceptionInvalidCiphertextExceptionIncorrectKeyMaterialExceptionExpiredImportTokenExceptionInvalidImportTokenExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.ListAliasesResult listAliases(ListAliasesRequest listAliasesRequest) throws AmazonClientException, AmazonServiceException
Gets a list of aliases in the caller's AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see CreateAlias.
By default, the ListAliases command returns all aliases in the account
and region. To get only the aliases that point to a particular customer
master key (CMK), use the KeyId parameter.
The ListAliases response can include aliases that you
created and associated with your customer managed CMKs, and aliases that
AWS created and associated with AWS managed CMKs in your account. You can
recognize AWS aliases because their names have the format
aws/<service-name>, such as aws/dynamodb.
The response might also include aliases that have no
TargetKeyId field. These are predefined aliases that AWS has
created but has not yet associated with a CMK. Aliases that AWS creates
in your account, including predefined aliases, do not count against your
AWS KMS aliases limit.
listAliasesRequest - DependencyTimeoutExceptionInvalidMarkerExceptionKMSInternalExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.ListGrantsResult listGrants(ListGrantsRequest listGrantsRequest) throws AmazonClientException, AmazonServiceException
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.
listGrantsRequest - NotFoundExceptionDependencyTimeoutExceptionInvalidMarkerExceptionInvalidArnExceptionKMSInternalExceptionKMSInvalidStateExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.ListKeyPoliciesResult listKeyPolicies(ListKeyPoliciesRequest listKeyPoliciesRequest) throws AmazonClientException, AmazonServiceException
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.
listKeyPoliciesRequest - NotFoundExceptionInvalidArnExceptionDependencyTimeoutExceptionKMSInternalExceptionKMSInvalidStateExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.ListKeysResult listKeys(ListKeysRequest listKeysRequest) throws AmazonClientException, AmazonServiceException
Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.
listKeysRequest - DependencyTimeoutExceptionKMSInternalExceptionInvalidMarkerExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.ListResourceTagsResult listResourceTags(ListResourceTagsRequest listResourceTagsRequest) throws AmazonClientException, AmazonServiceException
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.
listResourceTagsRequest - KMSInternalExceptionNotFoundExceptionInvalidArnExceptionInvalidMarkerExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.ListRetirableGrantsResult listRetirableGrants(ListRetirableGrantsRequest listRetirableGrantsRequest) throws AmazonClientException, AmazonServiceException
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.
listRetirableGrantsRequest - DependencyTimeoutExceptionInvalidMarkerExceptionInvalidArnExceptionNotFoundExceptionKMSInternalExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.void putKeyPolicy(PutKeyPolicyRequest putKeyPolicyRequest) throws AmazonClientException, AmazonServiceException
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.
putKeyPolicyRequest - NotFoundExceptionInvalidArnExceptionMalformedPolicyDocumentExceptionDependencyTimeoutExceptionUnsupportedOperationExceptionKMSInternalExceptionLimitExceededExceptionKMSInvalidStateExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.ReEncryptResult reEncrypt(ReEncryptRequest reEncryptRequest) throws AmazonClientException, AmazonServiceException
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.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
reEncryptRequest - NotFoundExceptionDisabledExceptionInvalidCiphertextExceptionKeyUnavailableExceptionDependencyTimeoutExceptionInvalidKeyUsageExceptionInvalidGrantTokenExceptionKMSInternalExceptionKMSInvalidStateExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.void retireGrant(RetireGrantRequest retireGrantRequest) throws AmazonClientException, AmazonServiceException
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.
retireGrantRequest - InvalidArnExceptionInvalidGrantTokenExceptionInvalidGrantIdExceptionNotFoundExceptionDependencyTimeoutExceptionKMSInternalExceptionKMSInvalidStateExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.void revokeGrant(RevokeGrantRequest revokeGrantRequest) throws AmazonClientException, AmazonServiceException
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.
revokeGrantRequest - NotFoundExceptionDependencyTimeoutExceptionInvalidArnExceptionInvalidGrantIdExceptionKMSInternalExceptionKMSInvalidStateExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.ScheduleKeyDeletionResult scheduleKeyDeletion(ScheduleKeyDeletionRequest scheduleKeyDeletionRequest) throws AmazonClientException, AmazonServiceException
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.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
scheduleKeyDeletionRequest - NotFoundExceptionInvalidArnExceptionDependencyTimeoutExceptionKMSInternalExceptionKMSInvalidStateExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.void tagResource(TagResourceRequest tagResourceRequest) throws AmazonClientException, AmazonServiceException
Adds or edits tags for a 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 can only use a tag key once for each CMK. If you use the tag key again, AWS KMS replaces the current tag value with the specified 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.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
tagResourceRequest - KMSInternalExceptionNotFoundExceptionInvalidArnExceptionKMSInvalidStateExceptionLimitExceededExceptionTagExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.void untagResource(UntagResourceRequest untagResourceRequest) throws AmazonClientException, AmazonServiceException
Removes the specified 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, specify the tag key. To change the tag value of an existing tag key, use TagResource.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
untagResourceRequest - KMSInternalExceptionNotFoundExceptionInvalidArnExceptionKMSInvalidStateExceptionTagExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.void updateAlias(UpdateAliasRequest updateAliasRequest) throws AmazonClientException, AmazonServiceException
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).
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
updateAliasRequest - DependencyTimeoutExceptionNotFoundExceptionKMSInternalExceptionKMSInvalidStateExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.void updateKeyDescription(UpdateKeyDescriptionRequest updateKeyDescriptionRequest) throws AmazonClientException, AmazonServiceException
Updates the description of a customer master key (CMK). To see the description of a CMK, use DescribeKey.
You cannot perform this operation on a CMK in a different AWS account.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
updateKeyDescriptionRequest - NotFoundExceptionInvalidArnExceptionDependencyTimeoutExceptionKMSInternalExceptionKMSInvalidStateExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.CreateKeyResult createKey() throws AmazonClientException, AmazonServiceException
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.
MalformedPolicyDocumentExceptionDependencyTimeoutExceptionInvalidArnExceptionUnsupportedOperationExceptionKMSInternalExceptionLimitExceededExceptionTagExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.ListKeysResult listKeys() throws AmazonClientException, AmazonServiceException
Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.
DependencyTimeoutExceptionKMSInternalExceptionInvalidMarkerExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.ListAliasesResult listAliases() throws AmazonClientException, AmazonServiceException
Gets a list of aliases in the caller's AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see CreateAlias.
By default, the ListAliases command returns all aliases in the account
and region. To get only the aliases that point to a particular customer
master key (CMK), use the KeyId parameter.
The ListAliases response can include aliases that you
created and associated with your customer managed CMKs, and aliases that
AWS created and associated with AWS managed CMKs in your account. You can
recognize AWS aliases because their names have the format
aws/<service-name>, such as aws/dynamodb.
The response might also include aliases that have no
TargetKeyId field. These are predefined aliases that AWS has
created but has not yet associated with a CMK. Aliases that AWS creates
in your account, including predefined aliases, do not count against your
AWS KMS aliases limit.
DependencyTimeoutExceptionInvalidMarkerExceptionKMSInternalExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.void retireGrant()
throws AmazonClientException,
AmazonServiceException
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.
InvalidArnExceptionInvalidGrantTokenExceptionInvalidGrantIdExceptionNotFoundExceptionDependencyTimeoutExceptionKMSInternalExceptionKMSInvalidStateExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.GenerateRandomResult generateRandom() throws AmazonClientException, AmazonServiceException
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.
DependencyTimeoutExceptionKMSInternalExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
Key Management Service indicating either a problem with the
data in the request, or a server side issue.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request - The originally executed request.Copyright © 2018. All rights reserved.