public interface AWSKMS
AWS Key Management Service (KMS) is an encryption and key management web service. This guide describes the KMS actions that you can call programmatically. For general information about KMS, see the AWS Key Management Service Developer Guide
NOTE: AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to KMS and AWS. For example, the SDKs take care of tasks such as signing requests (see below), managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.
We recommend that you use the AWS SDKs to make programmatic API calls to KMS.
Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes.
Signing Requests
Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account access key ID and secret key for everyday work with KMS. Instead, use the access key ID and secret access key for an IAM user, or you can use the AWS Security Token Service to generate temporary security credentials that you can use to sign requests.
All KMS operations require Signature Version 4 .
Recording API Requests
KMS supports AWS CloudTrail, a service that records AWS API calls and related events for your AWS account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide
Additional Resources
For more information about credentials and request signing, see the following:
Commonly Used APIs
Of the APIs discussed in this guide, the following will prove the most useful for most applications. You will likely perform actions other than these, such as creating keys and assigning policies, by using the console.
| Modifier and Type | Method and Description |
|---|---|
void |
createAlias(CreateAliasRequest createAliasRequest)
Creates a display name for a customer master key.
|
CreateGrantResult |
createGrant(CreateGrantRequest createGrantRequest)
Adds a grant to a key to specify who can access the key and under
what conditions.
|
CreateKeyResult |
createKey()
Creates a customer master key.
|
CreateKeyResult |
createKey(CreateKeyRequest createKeyRequest)
Creates a customer master key.
|
DecryptResult |
decrypt(DecryptRequest decryptRequest)
Decrypts ciphertext.
|
void |
deleteAlias(DeleteAliasRequest deleteAliasRequest)
Deletes the specified alias.
|
DescribeKeyResult |
describeKey(DescribeKeyRequest describeKeyRequest)
Provides detailed information about the specified customer master
key.
|
void |
disableKey(DisableKeyRequest disableKeyRequest)
Marks a key as disabled, thereby preventing its use.
|
void |
disableKeyRotation(DisableKeyRotationRequest disableKeyRotationRequest)
Disables rotation of the specified key.
|
void |
enableKey(EnableKeyRequest enableKeyRequest)
Marks a key as enabled, thereby permitting its use.
|
void |
enableKeyRotation(EnableKeyRotationRequest enableKeyRotationRequest)
Enables rotation of the specified customer master key.
|
EncryptResult |
encrypt(EncryptRequest encryptRequest)
Encrypts plaintext into ciphertext by using a customer master key.
|
GenerateDataKeyResult |
generateDataKey(GenerateDataKeyRequest generateDataKeyRequest)
Generates a data key that you can use in your application to locally
encrypt data.
|
GenerateDataKeyWithoutPlaintextResult |
generateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest generateDataKeyWithoutPlaintextRequest)
Returns a data key encrypted by a customer master key without the
plaintext copy of that key.
|
GenerateRandomResult |
generateRandom()
Generates an unpredictable byte string.
|
GenerateRandomResult |
generateRandom(GenerateRandomRequest generateRandomRequest)
Generates an unpredictable byte string.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for
debugging issues where a service isn't acting as expected.
|
GetKeyPolicyResult |
getKeyPolicy(GetKeyPolicyRequest getKeyPolicyRequest)
Retrieves a policy attached to the specified key.
|
GetKeyRotationStatusResult |
getKeyRotationStatus(GetKeyRotationStatusRequest getKeyRotationStatusRequest)
Retrieves a Boolean value that indicates whether key rotation is
enabled for the specified key.
|
ListAliasesResult |
listAliases()
Lists all of the key aliases in the account.
|
ListAliasesResult |
listAliases(ListAliasesRequest listAliasesRequest)
Lists all of the key aliases in the account.
|
ListGrantsResult |
listGrants(ListGrantsRequest listGrantsRequest)
List the grants for a specified key.
|
ListKeyPoliciesResult |
listKeyPolicies(ListKeyPoliciesRequest listKeyPoliciesRequest)
Retrieves a list of policies attached to a key.
|
ListKeysResult |
listKeys()
Lists the customer master keys.
|
ListKeysResult |
listKeys(ListKeysRequest listKeysRequest)
Lists the customer master keys.
|
void |
putKeyPolicy(PutKeyPolicyRequest putKeyPolicyRequest)
Attaches a policy to the specified key.
|
ReEncryptResult |
reEncrypt(ReEncryptRequest reEncryptRequest)
Encrypts data on the server side with a new customer master key
without exposing the plaintext of the data on the client side.
|
void |
retireGrant()
Retires a grant.
|
void |
retireGrant(RetireGrantRequest retireGrantRequest)
Retires a grant.
|
void |
revokeGrant(RevokeGrantRequest revokeGrantRequest)
Revokes a grant.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://kms.us-east-1.amazonaws.com/").
|
void |
setRegion(Region region)
An alternative to
setEndpoint(String), sets the
regional endpoint for this client's service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
void |
updateAlias(UpdateAliasRequest updateAliasRequest)
Updates an alias to associate it with a different key.
|
void |
updateKeyDescription(UpdateKeyDescriptionRequest updateKeyDescriptionRequest)
Updates the description of a key.
|
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)CreateKeyResult createKey(CreateKeyRequest createKeyRequest) throws AmazonServiceException, AmazonClientException
Creates a customer master key. Customer master keys can be used to encrypt small amounts of data (less than 4K) directly, but they are most commonly used to encrypt or envelope data keys that are then used to encrypt customer data. For more information about data keys, see GenerateDataKey and GenerateDataKeyWithoutPlaintext.
createKeyRequest - Container for the necessary parameters to
execute the CreateKey service method on AWSKMS.DependencyTimeoutExceptionMalformedPolicyDocumentExceptionInvalidArnExceptionUnsupportedOperationExceptionKMSInternalExceptionLimitExceededExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSKMS indicating
either a problem with the data in the request, or a server side issue.EncryptResult encrypt(EncryptRequest encryptRequest) throws AmazonServiceException, AmazonClientException
Encrypts plaintext into ciphertext by using a customer master key.
The Encrypt function has two primary use cases:
Unless you are moving encrypted data from one region to another, you
don't use this function to encrypt a generated data key within a
region. You retrieve data keys already encrypted by calling the
GenerateDataKey or GenerateDataKeyWithoutPlaintext function. Data keys
don't need to be encrypted again by calling Encrypt .
If you want to encrypt data locally in your application, you can use
the GenerateDataKey function to return a plaintext data
encryption key and a copy of the key encrypted under the customer
master key (CMK) of your choosing.
encryptRequest - Container for the necessary parameters to
execute the Encrypt service method on AWSKMS.DependencyTimeoutExceptionInvalidGrantTokenExceptionKeyUnavailableExceptionNotFoundExceptionDisabledExceptionInvalidKeyUsageExceptionKMSInternalExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSKMS indicating
either a problem with the data in the request, or a server side issue.GetKeyPolicyResult getKeyPolicy(GetKeyPolicyRequest getKeyPolicyRequest) throws AmazonServiceException, AmazonClientException
Retrieves a policy attached to the specified key.
getKeyPolicyRequest - Container for the necessary parameters to
execute the GetKeyPolicy service method on AWSKMS.DependencyTimeoutExceptionInvalidArnExceptionNotFoundExceptionKMSInternalExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSKMS indicating
either a problem with the data in the request, or a server side issue.void updateKeyDescription(UpdateKeyDescriptionRequest updateKeyDescriptionRequest) throws AmazonServiceException, AmazonClientException
Updates the description of a key.
updateKeyDescriptionRequest - Container for the necessary
parameters to execute the UpdateKeyDescription service method on
AWSKMS.DependencyTimeoutExceptionInvalidArnExceptionNotFoundExceptionKMSInternalExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSKMS indicating
either a problem with the data in the request, or a server side issue.ListKeysResult listKeys(ListKeysRequest listKeysRequest) throws AmazonServiceException, AmazonClientException
Lists the customer master keys.
listKeysRequest - Container for the necessary parameters to
execute the ListKeys service method on AWSKMS.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 AWSKMS indicating
either a problem with the data in the request, or a server side issue.GenerateDataKeyResult generateDataKey(GenerateDataKeyRequest generateDataKeyRequest) throws AmazonServiceException, AmazonClientException
Generates a data key that you can use in your application to locally
encrypt data. This call returns a plaintext version of the key in the
Plaintext field of the response object and an encrypted
copy of the key in the CiphertextBlob field. The key is
encrypted by using the master key specified by the KeyId
field. To decrypt the encrypted key, pass it to the
Decrypt API.
We recommend that you use the following pattern to locally encrypt
data: call the GenerateDataKey API, use the key returned
in the Plaintext response field to locally encrypt data,
and then erase the plaintext data key from memory. Store the encrypted
data key (contained in the CiphertextBlob field)
alongside of the locally encrypted data.
NOTE:You should not call the Encrypt function to re-encrypt your data keys within a region. GenerateDataKey always returns the data key encrypted and tied to the customer master key that will be used to decrypt it. There is no need to decrypt it twice.
If you decide to use the optional EncryptionContext
parameter, you must also store the context in full or at least store
enough information along with the encrypted data to be able to
reconstruct the context when submitting the ciphertext to the
Decrypt API. It is a good practice to choose a context
that you can reconstruct on the fly to better secure the ciphertext.
For more information about how this parameter is used, see
Encryption Context
.
To decrypt data, pass the encrypted data key to the
Decrypt API. Decrypt uses the associated
master key to decrypt the encrypted data key and returns it as
plaintext. Use the plaintext data key to locally decrypt your data and
then erase the key from memory. You must specify the encryption
context, if any, that you specified when you generated the key. The
encryption context is logged by CloudTrail, and you can use this log
to help track the use of particular data.
generateDataKeyRequest - Container for the necessary parameters
to execute the GenerateDataKey service method on AWSKMS.DependencyTimeoutExceptionInvalidGrantTokenExceptionKeyUnavailableExceptionNotFoundExceptionDisabledExceptionInvalidKeyUsageExceptionKMSInternalExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSKMS indicating
either a problem with the data in the request, or a server side issue.CreateGrantResult createGrant(CreateGrantRequest createGrantRequest) throws AmazonServiceException, AmazonClientException
Adds a grant to a key to specify who can access the key and under what conditions. Grants are alternate permission mechanisms to key policies. For more information about grants, see Grants in the developer guide. If a grant is absent, access to the key is evaluated based on IAM policies attached to the user.
createGrantRequest - Container for the necessary parameters to
execute the CreateGrant service method on AWSKMS.DependencyTimeoutExceptionInvalidGrantTokenExceptionInvalidArnExceptionNotFoundExceptionDisabledExceptionKMSInternalExceptionLimitExceededExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSKMS indicating
either a problem with the data in the request, or a server side issue.ListAliasesResult listAliases(ListAliasesRequest listAliasesRequest) throws AmazonServiceException, AmazonClientException
Lists all of the key aliases in the account.
listAliasesRequest - Container for the necessary parameters to
execute the ListAliases service method on AWSKMS.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 AWSKMS indicating
either a problem with the data in the request, or a server side issue.GenerateDataKeyWithoutPlaintextResult generateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest generateDataKeyWithoutPlaintextRequest) throws AmazonServiceException, AmazonClientException
Returns a data key encrypted by a customer master key without the plaintext copy of that key. Otherwise, this API functions exactly like GenerateDataKey. You can use this API to, for example, satisfy an audit requirement that an encrypted key be made available without exposing the plaintext copy of that key.
generateDataKeyWithoutPlaintextRequest - Container for the
necessary parameters to execute the GenerateDataKeyWithoutPlaintext
service method on AWSKMS.DependencyTimeoutExceptionInvalidGrantTokenExceptionKeyUnavailableExceptionNotFoundExceptionDisabledExceptionInvalidKeyUsageExceptionKMSInternalExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSKMS indicating
either a problem with the data in the request, or a server side issue.void deleteAlias(DeleteAliasRequest deleteAliasRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified alias. To associate an alias with a different key, call UpdateAlias.
deleteAliasRequest - Container for the necessary parameters to
execute the DeleteAlias service method on AWSKMS.DependencyTimeoutExceptionNotFoundExceptionKMSInternalExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSKMS indicating
either a problem with the data in the request, or a server side issue.void updateAlias(UpdateAliasRequest updateAliasRequest) throws AmazonServiceException, AmazonClientException
Updates an alias to associate it with a different key.
An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).
An alias is not a property of a key. Therefore, an alias can be associated with and disassociated from an existing key without changing the properties of the key.
Note that you cannot create or update an alias that represents a key in another account.
updateAliasRequest - Container for the necessary parameters to
execute the UpdateAlias service method on AWSKMS.DependencyTimeoutExceptionNotFoundExceptionKMSInternalExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSKMS indicating
either a problem with the data in the request, or a server side issue.void enableKeyRotation(EnableKeyRotationRequest enableKeyRotationRequest) throws AmazonServiceException, AmazonClientException
Enables rotation of the specified customer master key.
enableKeyRotationRequest - Container for the necessary parameters
to execute the EnableKeyRotation service method on AWSKMS.DependencyTimeoutExceptionInvalidArnExceptionNotFoundExceptionDisabledExceptionKMSInternalExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSKMS indicating
either a problem with the data in the request, or a server side issue.void retireGrant(RetireGrantRequest retireGrantRequest) throws AmazonServiceException, AmazonClientException
Retires a grant. You can retire a grant when you're done using it to clean up. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:
RetiringPrincipal , if presentGranteePrincipal , if RetireGrant
is a grantee operationCreateGrant function.
retireGrantRequest - Container for the necessary parameters to
execute the RetireGrant service method on AWSKMS.DependencyTimeoutExceptionInvalidGrantTokenExceptionNotFoundExceptionKMSInternalExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSKMS indicating
either a problem with the data in the request, or a server side issue.DescribeKeyResult describeKey(DescribeKeyRequest describeKeyRequest) throws AmazonServiceException, AmazonClientException
Provides detailed information about the specified customer master key.
describeKeyRequest - Container for the necessary parameters to
execute the DescribeKey service method on AWSKMS.DependencyTimeoutExceptionInvalidArnExceptionNotFoundExceptionKMSInternalExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSKMS indicating
either a problem with the data in the request, or a server side issue.ListGrantsResult listGrants(ListGrantsRequest listGrantsRequest) throws AmazonServiceException, AmazonClientException
List the grants for a specified key.
listGrantsRequest - Container for the necessary parameters to
execute the ListGrants service method on AWSKMS.DependencyTimeoutExceptionInvalidMarkerExceptionInvalidArnExceptionKMSInternalExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSKMS indicating
either a problem with the data in the request, or a server side issue.DecryptResult decrypt(DecryptRequest decryptRequest) throws AmazonServiceException, AmazonClientException
Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following functions:
Note that if a caller has been granted access permissions to all keys
(through, for example, IAM user policies that grant
Decrypt permission on all resources), then ciphertext
encrypted by using keys in other accounts where the key grants access
to the caller can be decrypted. To remedy this, we recommend that you
do not grant Decrypt access in an IAM user policy.
Instead grant Decrypt access only in key policies. If you
must grant Decrypt access in an IAM user policy, you
should scope the resource to specific keys or to specific trusted
accounts.
decryptRequest - Container for the necessary parameters to
execute the Decrypt service method on AWSKMS.DependencyTimeoutExceptionInvalidGrantTokenExceptionKeyUnavailableExceptionNotFoundExceptionDisabledExceptionInvalidCiphertextExceptionKMSInternalExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSKMS indicating
either a problem with the data in the request, or a server side issue.GenerateRandomResult generateRandom(GenerateRandomRequest generateRandomRequest) throws AmazonServiceException, AmazonClientException
Generates an unpredictable byte string.
generateRandomRequest - Container for the necessary parameters to
execute the GenerateRandom service method on AWSKMS.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 AWSKMS indicating
either a problem with the data in the request, or a server side issue.GetKeyRotationStatusResult getKeyRotationStatus(GetKeyRotationStatusRequest getKeyRotationStatusRequest) throws AmazonServiceException, AmazonClientException
Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.
getKeyRotationStatusRequest - Container for the necessary
parameters to execute the GetKeyRotationStatus service method on
AWSKMS.DependencyTimeoutExceptionInvalidArnExceptionNotFoundExceptionKMSInternalExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSKMS indicating
either a problem with the data in the request, or a server side issue.void disableKeyRotation(DisableKeyRotationRequest disableKeyRotationRequest) throws AmazonServiceException, AmazonClientException
Disables rotation of the specified key.
disableKeyRotationRequest - Container for the necessary
parameters to execute the DisableKeyRotation service method on AWSKMS.DependencyTimeoutExceptionInvalidArnExceptionNotFoundExceptionDisabledExceptionKMSInternalExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSKMS indicating
either a problem with the data in the request, or a server side issue.ListKeyPoliciesResult listKeyPolicies(ListKeyPoliciesRequest listKeyPoliciesRequest) throws AmazonServiceException, AmazonClientException
Retrieves a list of policies attached to a key.
listKeyPoliciesRequest - Container for the necessary parameters
to execute the ListKeyPolicies service method on AWSKMS.DependencyTimeoutExceptionInvalidArnExceptionNotFoundExceptionKMSInternalExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSKMS indicating
either a problem with the data in the request, or a server side issue.void createAlias(CreateAliasRequest createAliasRequest) throws AmazonServiceException, AmazonClientException
Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).
To associate an alias with a different key, call UpdateAlias.
Note that you cannot create or update an alias that represents a key in another account.
createAliasRequest - Container for the necessary parameters to
execute the CreateAlias service method on AWSKMS.DependencyTimeoutExceptionAlreadyExistsExceptionInvalidAliasNameExceptionNotFoundExceptionKMSInternalExceptionLimitExceededExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSKMS indicating
either a problem with the data in the request, or a server side issue.void putKeyPolicy(PutKeyPolicyRequest putKeyPolicyRequest) throws AmazonServiceException, AmazonClientException
Attaches a policy to the specified key.
putKeyPolicyRequest - Container for the necessary parameters to
execute the PutKeyPolicy service method on AWSKMS.DependencyTimeoutExceptionMalformedPolicyDocumentExceptionInvalidArnExceptionNotFoundExceptionUnsupportedOperationExceptionKMSInternalExceptionLimitExceededExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSKMS indicating
either a problem with the data in the request, or a server side issue.void disableKey(DisableKeyRequest disableKeyRequest) throws AmazonServiceException, AmazonClientException
Marks a key as disabled, thereby preventing its use.
disableKeyRequest - Container for the necessary parameters to
execute the DisableKey service method on AWSKMS.DependencyTimeoutExceptionInvalidArnExceptionNotFoundExceptionKMSInternalExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSKMS indicating
either a problem with the data in the request, or a server side issue.ReEncryptResult reEncrypt(ReEncryptRequest reEncryptRequest) throws AmazonServiceException, AmazonClientException
Encrypts data on the server side with a new customer master key without exposing the plaintext of the data on the client side. The data is first decrypted and then encrypted. This operation can also be used to change the encryption context of a ciphertext.
Unlike other actions, ReEncrypt is authorized twice -
once as ReEncryptFrom on the source key and once as
ReEncryptTo on the destination key. We therefore
recommend that you include the "action":"kms:ReEncrypt*"
statement in your key policies to permit re-encryption from or to the
key. The statement is included automatically when you authorize use of
the key through the console but must be included manually when you set
a policy by using the PutKeyPolicy function.
reEncryptRequest - Container for the necessary parameters to
execute the ReEncrypt service method on AWSKMS.DependencyTimeoutExceptionInvalidGrantTokenExceptionKeyUnavailableExceptionNotFoundExceptionDisabledExceptionInvalidCiphertextExceptionInvalidKeyUsageExceptionKMSInternalExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSKMS indicating
either a problem with the data in the request, or a server side issue.void revokeGrant(RevokeGrantRequest revokeGrantRequest) throws AmazonServiceException, AmazonClientException
Revokes a grant. You can revoke a grant to actively deny operations that depend on it.
revokeGrantRequest - Container for the necessary parameters to
execute the RevokeGrant service method on AWSKMS.DependencyTimeoutExceptionInvalidArnExceptionNotFoundExceptionKMSInternalExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSKMS indicating
either a problem with the data in the request, or a server side issue.void enableKey(EnableKeyRequest enableKeyRequest) throws AmazonServiceException, AmazonClientException
Marks a key as enabled, thereby permitting its use. You can have up to 25 enabled keys at one time.
enableKeyRequest - Container for the necessary parameters to
execute the EnableKey service method on AWSKMS.DependencyTimeoutExceptionInvalidArnExceptionNotFoundExceptionKMSInternalExceptionLimitExceededExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSKMS indicating
either a problem with the data in the request, or a server side issue.CreateKeyResult createKey() throws AmazonServiceException, AmazonClientException
Creates a customer master key. Customer master keys can be used to encrypt small amounts of data (less than 4K) directly, but they are most commonly used to encrypt or envelope data keys that are then used to encrypt customer data. For more information about data keys, see GenerateDataKey and GenerateDataKeyWithoutPlaintext.
DependencyTimeoutExceptionMalformedPolicyDocumentExceptionInvalidArnExceptionUnsupportedOperationExceptionKMSInternalExceptionLimitExceededExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSKMS indicating
either a problem with the data in the request, or a server side issue.ListKeysResult listKeys() throws AmazonServiceException, AmazonClientException
Lists the customer master keys.
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 AWSKMS indicating
either a problem with the data in the request, or a server side issue.ListAliasesResult listAliases() throws AmazonServiceException, AmazonClientException
Lists all of the key aliases in the account.
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 AWSKMS indicating
either a problem with the data in the request, or a server side issue.void retireGrant()
throws AmazonServiceException,
AmazonClientException
Retires a grant. You can retire a grant when you're done using it to clean up. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:
RetiringPrincipal , if presentGranteePrincipal , if RetireGrant
is a grantee operationCreateGrant function.
DependencyTimeoutExceptionInvalidGrantTokenExceptionNotFoundExceptionKMSInternalExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSKMS indicating
either a problem with the data in the request, or a server side issue.GenerateRandomResult generateRandom() throws AmazonServiceException, AmazonClientException
Generates an unpredictable byte string.
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 AWSKMS 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 © 2015. All rights reserved.