@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSKMSClient extends AmazonWebServiceClient implements 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 | Field and Description |
|---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to this client
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffsetENDPOINT_PREFIX| Constructor and Description |
|---|
AWSKMSClient()
Deprecated.
|
AWSKMSClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSKMSClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AWSKMSClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AWSKMSClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSKMSClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSKMSClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AWSKMSClient(ClientConfiguration clientConfiguration)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static AWSKMSClientBuilder |
builder() |
CancelKeyDeletionResult |
cancelKeyDeletion(CancelKeyDeletionRequest request)
Cancels the deletion of a customer master key (CMK).
|
ConnectCustomKeyStoreResult |
connectCustomKeyStore(ConnectCustomKeyStoreRequest request)
Connects or reconnects a custom key store
to its associated AWS CloudHSM cluster.
|
CreateAliasResult |
createAlias(CreateAliasRequest request)
Creates a display name for a customer managed customer master key (CMK).
|
CreateCustomKeyStoreResult |
createCustomKeyStore(CreateCustomKeyStoreRequest request)
Creates a custom
key store that is associated with an AWS CloudHSM cluster that you own
and manage.
|
CreateGrantResult |
createGrant(CreateGrantRequest request)
Adds a grant to a customer master key (CMK).
|
CreateKeyResult |
createKey()
Simplified method form for invoking the CreateKey operation.
|
CreateKeyResult |
createKey(CreateKeyRequest request)
Creates a customer managed customer master key
(CMK) in your AWS account.
|
DecryptResult |
decrypt(DecryptRequest request)
Decrypts ciphertext.
|
DeleteAliasResult |
deleteAlias(DeleteAliasRequest request)
Deletes the specified alias.
|
DeleteCustomKeyStoreResult |
deleteCustomKeyStore(DeleteCustomKeyStoreRequest request)
Deletes a custom
key store.
|
DeleteImportedKeyMaterialResult |
deleteImportedKeyMaterial(DeleteImportedKeyMaterialRequest request)
Deletes key material that you previously imported.
|
DescribeCustomKeyStoresResult |
describeCustomKeyStores(DescribeCustomKeyStoresRequest request)
Gets information about custom key stores
in the account and region.
|
DescribeKeyResult |
describeKey(DescribeKeyRequest request)
Provides detailed information about the specified customer master key (CMK).
|
DisableKeyResult |
disableKey(DisableKeyRequest request)
Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic
operations.
|
DisableKeyRotationResult |
disableKeyRotation(DisableKeyRotationRequest request)
Disables automatic rotation of
the key material for the specified customer master key (CMK).
|
DisconnectCustomKeyStoreResult |
disconnectCustomKeyStore(DisconnectCustomKeyStoreRequest request)
Disconnects the custom key store
from its associated AWS CloudHSM cluster.
|
EnableKeyResult |
enableKey(EnableKeyRequest request)
Sets the key state of a customer master key (CMK) to enabled.
|
EnableKeyRotationResult |
enableKeyRotation(EnableKeyRotationRequest request)
Enables automatic rotation of
the key material for the specified customer master key (CMK).
|
EncryptResult |
encrypt(EncryptRequest request)
Encrypts plaintext into ciphertext by using a customer master key (CMK).
|
GenerateDataKeyResult |
generateDataKey(GenerateDataKeyRequest request)
Generates a unique data key.
|
GenerateDataKeyWithoutPlaintextResult |
generateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest request)
Generates a unique data key.
|
GenerateRandomResult |
generateRandom()
Simplified method form for invoking the GenerateRandom operation.
|
GenerateRandomResult |
generateRandom(GenerateRandomRequest request)
Returns a random byte string that is cryptographically secure.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetKeyPolicyResult |
getKeyPolicy(GetKeyPolicyRequest request)
Gets a key policy attached to the specified customer master key (CMK).
|
GetKeyRotationStatusResult |
getKeyRotationStatus(GetKeyRotationStatusRequest request)
Gets a Boolean value that indicates whether automatic rotation of the key
material is enabled for the specified customer master key (CMK).
|
GetParametersForImportResult |
getParametersForImport(GetParametersForImportRequest request)
Returns the items you need in order to import key material into AWS KMS from your existing key management
infrastructure.
|
ImportKeyMaterialResult |
importKeyMaterial(ImportKeyMaterialRequest request)
Imports key material into an existing AWS KMS customer master key (CMK) that was created without key material.
|
ListAliasesResult |
listAliases()
Simplified method form for invoking the ListAliases operation.
|
ListAliasesResult |
listAliases(ListAliasesRequest request)
Gets a list of aliases in the caller's AWS account and region.
|
ListGrantsResult |
listGrants(ListGrantsRequest request)
Gets a list of all grants for the specified customer master key (CMK).
|
ListKeyPoliciesResult |
listKeyPolicies(ListKeyPoliciesRequest request)
Gets the names of the key policies that are attached to a customer master key (CMK).
|
ListKeysResult |
listKeys()
Simplified method form for invoking the ListKeys operation.
|
ListKeysResult |
listKeys(ListKeysRequest request)
Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.
|
ListResourceTagsResult |
listResourceTags(ListResourceTagsRequest request)
Returns a list of all tags for the specified customer master key (CMK).
|
ListRetirableGrantsResult |
listRetirableGrants(ListRetirableGrantsRequest request)
Returns a list of all grants for which the grant's
RetiringPrincipal matches the one specified. |
PutKeyPolicyResult |
putKeyPolicy(PutKeyPolicyRequest request)
Attaches a key policy to the specified customer master key (CMK).
|
ReEncryptResult |
reEncrypt(ReEncryptRequest request)
Encrypts data on the server side with a new customer master key (CMK) without exposing the plaintext of the data
on the client side.
|
RetireGrantResult |
retireGrant()
Simplified method form for invoking the RetireGrant operation.
|
RetireGrantResult |
retireGrant(RetireGrantRequest request)
Retires a grant.
|
RevokeGrantResult |
revokeGrant(RevokeGrantRequest request)
Revokes the specified grant for the specified customer master key (CMK).
|
ScheduleKeyDeletionResult |
scheduleKeyDeletion(ScheduleKeyDeletionRequest request)
Schedules the deletion of a customer master key (CMK).
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds or edits tags for a customer master key (CMK).
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes the specified tags from the specified customer master key (CMK).
|
UpdateAliasResult |
updateAlias(UpdateAliasRequest request)
Associates an existing alias with a different customer master key (CMK).
|
UpdateCustomKeyStoreResult |
updateCustomKeyStore(UpdateCustomKeyStoreRequest request)
Changes the properties of a custom key store.
|
UpdateKeyDescriptionResult |
updateKeyDescription(UpdateKeyDescriptionRequest request)
Updates the description of a customer master key (CMK).
|
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdownprotected static final ClientConfigurationFactory configFactory
@Deprecated public AWSKMSClient()
AWSKMSClientBuilder.defaultClient()All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AWSKMSClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client connects to KMS (ex: proxy settings, retry
counts, etc.).DefaultAWSCredentialsProviderChain@Deprecated public AWSKMSClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSKMSClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AWSKMSClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - The client configuration options controlling how this client connects to KMS (ex: proxy settings, retry
counts, etc.).@Deprecated public AWSKMSClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AWSKMSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to KMS (ex: proxy settings, retry
counts, etc.).@Deprecated public AWSKMSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to KMS (ex: proxy settings, retry
counts, etc.).requestMetricCollector - optional request metric collectorpublic static AWSKMSClientBuilder builder()
public CancelKeyDeletionResult cancelKeyDeletion(CancelKeyDeletionRequest request)
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.
cancelKeyDeletion in interface AWSKMScancelKeyDeletionRequest - NotFoundException - The request was rejected because the specified entity or resource could not be found.InvalidArnException - The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public ConnectCustomKeyStoreResult connectCustomKeyStore(ConnectCustomKeyStoreRequest request)
Connects or reconnects a custom key store to its associated AWS CloudHSM cluster.
The custom key store must be connected before you can create customer master keys (CMKs) in the key store or use the CMKs it contains. You can disconnect and reconnect a custom key store at any time.
To connect a custom key store, its associated AWS CloudHSM cluster must have at least one active HSM. To get the number of active HSMs in a cluster, use the DescribeClusters operation. To add HSMs to the cluster, use the CreateHsm operation.
The connection process can take an extended amount of time to complete; up to 20 minutes. This operation starts the connection process, but it does not wait for it to complete. When it succeeds, this operation quickly returns an HTTP 200 response and a JSON object with no properties. However, this response does not indicate that the custom key store is connected. To get the connection state of the custom key store, use the DescribeCustomKeyStores operation.
During the connection process, AWS KMS finds the AWS CloudHSM cluster that is associated with the custom key
store, creates the connection infrastructure, connects to the cluster, logs into the AWS CloudHSM client as the
kmsuser crypto user (CU), and rotates its password.
The ConnectCustomKeyStore operation might fail for various reasons. To find the reason, use the
DescribeCustomKeyStores operation and see the ConnectionErrorCode in the response. For help
interpreting the ConnectionErrorCode, see CustomKeyStoresListEntry.
To fix the failure, use the DisconnectCustomKeyStore operation to disconnect the custom key store, correct
the error, use the UpdateCustomKeyStore operation if necessary, and then use
ConnectCustomKeyStore again.
If you are having trouble connecting or disconnecting a custom key store, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
connectCustomKeyStore in interface AWSKMSconnectCustomKeyStoreRequest - CloudHsmClusterNotActiveException - The request was rejected because the AWS CloudHSM cluster that is associated with the custom key store is
not active. Initialize and activate the cluster and try the command again. For detailed instructions, see
Getting Started
in the AWS CloudHSM User Guide.CustomKeyStoreInvalidStateException - The request was rejected because of the ConnectionState of the custom key store. To get the
ConnectionState of a custom key store, use the DescribeCustomKeyStores operation.
This exception is thrown under the following conditions:
You requested the CreateKey or GenerateRandom operation in a custom key store that is not
connected. These operations are valid only when the custom key store ConnectionState is
CONNECTED.
You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on a custom key
store that is not disconnected. This operation is valid only when the custom key store
ConnectionState is DISCONNECTED.
You requested the ConnectCustomKeyStore operation on a custom key store with a
ConnectionState of DISCONNECTING or FAILED. This operation is
valid for all other ConnectionState values.
CustomKeyStoreNotFoundException - The request was rejected because AWS KMS cannot find a custom key store with the specified key store name
or ID.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.CloudHsmClusterInvalidConfigurationException - The request was rejected because the associated AWS CloudHSM cluster did not meet the configuration
requirements for a custom key store.
The cluster must be configured with private subnets in at least two different Availability Zones in the Region.
The security group for the cluster (cloudhsm-cluster-<cluster-id>-sg) must include inbound rules and outbound rules that allow TCP traffic on ports 2223-2225. The Source in the inbound rules and the Destination in the outbound rules must match the security group ID. These rules are set by default when you create the cluster. Do not delete or change them. To get information about a particular security group, use the DescribeSecurityGroups operation.
The cluster must contain at least as many HSMs as the operation requires. To add HSMs, use the AWS CloudHSM CreateHsm operation.
For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey operations, the AWS CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the ConnectCustomKeyStore operation, the AWS CloudHSM must contain at least one active HSM.
For information about the requirements for an AWS CloudHSM cluster that is associated with a custom key store, see Assemble the Prerequisites in the AWS Key Management Service Developer Guide. For information about creating a private subnet for an AWS CloudHSM cluster, see Create a Private Subnet in the AWS CloudHSM User Guide. For information about cluster security groups, see Configure a Default Security Group in the AWS CloudHSM User Guide .
public CreateAliasResult createAlias(CreateAliasRequest request)
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 must begin with alias/ followed by a name, such as alias/ExampleAlias.
It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name
cannot begin with alias/aws/. The alias/aws/ 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.
createAlias in interface AWSKMScreateAliasRequest - DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.AlreadyExistsException - The request was rejected because it attempted to create a resource that already exists.NotFoundException - The request was rejected because the specified entity or resource could not be found.InvalidAliasNameException - The request was rejected because the specified alias name is not valid.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.LimitExceededException - The request was rejected because a limit was exceeded. For more information, see Limits in the AWS Key
Management Service Developer Guide.KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public CreateCustomKeyStoreResult createCustomKeyStore(CreateCustomKeyStoreRequest request)
Creates a custom key store that is associated with an AWS CloudHSM cluster that you own and manage.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
Before you create the custom key store, you must assemble the required elements, including an AWS CloudHSM cluster that fulfills the requirements for a custom key store. For details about the required elements, see Assemble the Prerequisites in the AWS Key Management Service Developer Guide.
When the operation completes successfully, it returns the ID of the new custom key store. Before you can use your new custom key store, you need to use the ConnectCustomKeyStore operation to connect the new key store to its AWS CloudHSM cluster. Even if you are not going to use your custom key store immediately, you might want to connect it to verify that all settings are correct and then disconnect it until you are ready to use it.
For help with failures, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
createCustomKeyStore in interface AWSKMScreateCustomKeyStoreRequest - CloudHsmClusterInUseException - The request was rejected because the specified AWS CloudHSM cluster is already associated with a custom
key store or it shares a backup history with a cluster that is associated with a custom key store. Each
custom key store must be associated with a different AWS CloudHSM cluster.
Clusters that share a backup history have the same cluster certificate. To view the cluster certificate of a cluster, use the DescribeClusters operation.
CustomKeyStoreNameInUseException - The request was rejected because the specified custom key store name is already assigned to another
custom key store in the account. Try again with a custom key store name that is unique in the account.CloudHsmClusterNotFoundException - The request was rejected because AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster
ID. Retry the request with a different cluster ID.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.CloudHsmClusterNotActiveException - The request was rejected because the AWS CloudHSM cluster that is associated with the custom key store is
not active. Initialize and activate the cluster and try the command again. For detailed instructions, see
Getting Started
in the AWS CloudHSM User Guide.IncorrectTrustAnchorException - The request was rejected because the trust anchor certificate in the request is not the trust anchor
certificate for the specified AWS CloudHSM cluster.
When you initialize
the cluster, you create the trust anchor certificate and save it in the customerCA.crt
file.
CloudHsmClusterInvalidConfigurationException - The request was rejected because the associated AWS CloudHSM cluster did not meet the configuration
requirements for a custom key store.
The cluster must be configured with private subnets in at least two different Availability Zones in the Region.
The security group for the cluster (cloudhsm-cluster-<cluster-id>-sg) must include inbound rules and outbound rules that allow TCP traffic on ports 2223-2225. The Source in the inbound rules and the Destination in the outbound rules must match the security group ID. These rules are set by default when you create the cluster. Do not delete or change them. To get information about a particular security group, use the DescribeSecurityGroups operation.
The cluster must contain at least as many HSMs as the operation requires. To add HSMs, use the AWS CloudHSM CreateHsm operation.
For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey operations, the AWS CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the ConnectCustomKeyStore operation, the AWS CloudHSM must contain at least one active HSM.
For information about the requirements for an AWS CloudHSM cluster that is associated with a custom key store, see Assemble the Prerequisites in the AWS Key Management Service Developer Guide. For information about creating a private subnet for an AWS CloudHSM cluster, see Create a Private Subnet in the AWS CloudHSM User Guide. For information about cluster security groups, see Configure a Default Security Group in the AWS CloudHSM User Guide .
public CreateGrantResult createGrant(CreateGrantRequest request)
Adds a grant to a customer master key (CMK). The grant allows the grantee principal to use the CMK when the conditions specified in the grant are met. When setting permissions, grants are an alternative to key policies.
To create a grant that allows a cryptographic operation only when the encryption context in the operation request
matches or includes a specified encryption context, use the Constraints parameter. For details, see
GrantConstraints.
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.
createGrant in interface AWSKMScreateGrantRequest - NotFoundException - The request was rejected because the specified entity or resource could not be found.DisabledException - The request was rejected because the specified CMK is not enabled.DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.InvalidArnException - The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.InvalidGrantTokenException - The request was rejected because the specified grant token is not valid.LimitExceededException - The request was rejected because a limit was exceeded. For more information, see Limits in the AWS Key
Management Service Developer Guide.KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public CreateKeyResult createKey(CreateKeyRequest request)
Creates a customer managed customer master key (CMK) in your AWS account.
You can use a CMK to encrypt small amounts of data (up to 4096 bytes) directly. But CMKs are more commonly used to encrypt the data keys that are used to encrypt data.
To create a CMK for imported key material, use the Origin parameter with a value of
EXTERNAL.
To create a CMK in a custom key store,
use the CustomKeyStoreId parameter to specify the custom key store. You must also use the
Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is
associated with the custom key store must have at least two active HSMs in different Availability Zones in the
AWS Region.
You cannot use this operation to create a CMK in a different AWS account.
createKey in interface AWSKMScreateKeyRequest - MalformedPolicyDocumentException - The request was rejected because the specified policy is not syntactically or semantically correct.DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.InvalidArnException - The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.UnsupportedOperationException - The request was rejected because a specified parameter is not supported or a specified resource is not
valid for this operation.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.LimitExceededException - The request was rejected because a limit was exceeded. For more information, see Limits in the AWS Key
Management Service Developer Guide.TagException - The request was rejected because one or more tags are not valid.CustomKeyStoreNotFoundException - The request was rejected because AWS KMS cannot find a custom key store with the specified key store name
or ID.CustomKeyStoreInvalidStateException - The request was rejected because of the ConnectionState of the custom key store. To get the
ConnectionState of a custom key store, use the DescribeCustomKeyStores operation.
This exception is thrown under the following conditions:
You requested the CreateKey or GenerateRandom operation in a custom key store that is not
connected. These operations are valid only when the custom key store ConnectionState is
CONNECTED.
You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on a custom key
store that is not disconnected. This operation is valid only when the custom key store
ConnectionState is DISCONNECTED.
You requested the ConnectCustomKeyStore operation on a custom key store with a
ConnectionState of DISCONNECTING or FAILED. This operation is
valid for all other ConnectionState values.
CloudHsmClusterInvalidConfigurationException - The request was rejected because the associated AWS CloudHSM cluster did not meet the configuration
requirements for a custom key store.
The cluster must be configured with private subnets in at least two different Availability Zones in the Region.
The security group for the cluster (cloudhsm-cluster-<cluster-id>-sg) must include inbound rules and outbound rules that allow TCP traffic on ports 2223-2225. The Source in the inbound rules and the Destination in the outbound rules must match the security group ID. These rules are set by default when you create the cluster. Do not delete or change them. To get information about a particular security group, use the DescribeSecurityGroups operation.
The cluster must contain at least as many HSMs as the operation requires. To add HSMs, use the AWS CloudHSM CreateHsm operation.
For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey operations, the AWS CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the ConnectCustomKeyStore operation, the AWS CloudHSM must contain at least one active HSM.
For information about the requirements for an AWS CloudHSM cluster that is associated with a custom key store, see Assemble the Prerequisites in the AWS Key Management Service Developer Guide. For information about creating a private subnet for an AWS CloudHSM cluster, see Create a Private Subnet in the AWS CloudHSM User Guide. For information about cluster security groups, see Configure a Default Security Group in the AWS CloudHSM User Guide .
public CreateKeyResult createKey()
AWSKMScreateKey in interface AWSKMSAWSKMS.createKey(CreateKeyRequest)public DecryptResult decrypt(DecryptRequest request)
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.
decrypt in interface AWSKMSdecryptRequest - NotFoundException - The request was rejected because the specified entity or resource could not be found.DisabledException - The request was rejected because the specified CMK is not enabled.InvalidCiphertextException - The request was rejected because the specified ciphertext, or additional authenticated data incorporated
into the ciphertext, such as the encryption context, is corrupted, missing, or otherwise invalid.KeyUnavailableException - The request was rejected because the specified CMK was not available. The request can be retried.DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.InvalidGrantTokenException - The request was rejected because the specified grant token is not valid.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public DeleteAliasResult deleteAlias(DeleteAliasRequest request)
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.
deleteAlias in interface AWSKMSdeleteAliasRequest - DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.NotFoundException - The request was rejected because the specified entity or resource could not be found.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public DeleteCustomKeyStoreResult deleteCustomKeyStore(DeleteCustomKeyStoreRequest request)
Deletes a custom key store. This operation does not delete the AWS CloudHSM cluster that is associated with the custom key store, or affect any users or keys in the cluster.
The custom key store that you delete cannot contain any AWS KMS customer master keys
(CMKs). Before deleting the key store, verify that you will never need to use any of the CMKs in the key
store for any cryptographic operations. Then, use ScheduleKeyDeletion to delete the AWS KMS customer
master keys (CMKs) from the key store. When the scheduled waiting period expires, the
ScheduleKeyDeletion operation deletes the CMKs. Then it makes a best effort to delete the key
material from the associated cluster. However, you might need to manually delete
the orphaned key material from the cluster and its backups.
After all CMKs are deleted from AWS KMS, use DisconnectCustomKeyStore to disconnect the key store from AWS KMS. Then, you can delete the custom key store.
Instead of deleting the custom key store, consider using DisconnectCustomKeyStore to disconnect it from AWS KMS. While the key store is disconnected, you cannot create or use the CMKs in the key store. But, you do not need to delete CMKs and you can reconnect a disconnected custom key store at any time.
If the operation succeeds, it returns a JSON object with no properties.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
deleteCustomKeyStore in interface AWSKMSdeleteCustomKeyStoreRequest - CustomKeyStoreHasCMKsException - The request was rejected because the custom key store contains AWS KMS customer master keys (CMKs). After
verifying that you do not need to use the CMKs, use the ScheduleKeyDeletion operation to delete
the CMKs. After they are deleted, you can delete the custom key store.CustomKeyStoreInvalidStateException - The request was rejected because of the ConnectionState of the custom key store. To get the
ConnectionState of a custom key store, use the DescribeCustomKeyStores operation.
This exception is thrown under the following conditions:
You requested the CreateKey or GenerateRandom operation in a custom key store that is not
connected. These operations are valid only when the custom key store ConnectionState is
CONNECTED.
You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on a custom key
store that is not disconnected. This operation is valid only when the custom key store
ConnectionState is DISCONNECTED.
You requested the ConnectCustomKeyStore operation on a custom key store with a
ConnectionState of DISCONNECTING or FAILED. This operation is
valid for all other ConnectionState values.
CustomKeyStoreNotFoundException - The request was rejected because AWS KMS cannot find a custom key store with the specified key store name
or ID.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.public DeleteImportedKeyMaterialResult deleteImportedKeyMaterial(DeleteImportedKeyMaterialRequest request)
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.
deleteImportedKeyMaterial in interface AWSKMSdeleteImportedKeyMaterialRequest - InvalidArnException - The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.UnsupportedOperationException - The request was rejected because a specified parameter is not supported or a specified resource is not
valid for this operation.DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.NotFoundException - The request was rejected because the specified entity or resource could not be found.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public DescribeCustomKeyStoresResult describeCustomKeyStores(DescribeCustomKeyStoresRequest request)
Gets information about custom key stores in the account and region.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
By default, this operation returns information about all custom key stores in the account and region. To get only
information about a particular custom key store, use either the CustomKeyStoreName or
CustomKeyStoreId parameter (but not both).
To determine whether the custom key store is connected to its AWS CloudHSM cluster, use the
ConnectionState element in the response. If an attempt to connect the custom key store failed, the
ConnectionState value is FAILED and the ConnectionErrorCode element in the
response indicates the cause of the failure. For help interpreting the ConnectionErrorCode, see
CustomKeyStoresListEntry.
Custom key stores have a DISCONNECTED connection state if the key store has never been connected or
you use the DisconnectCustomKeyStore operation to disconnect it. If your custom key store state is
CONNECTED but you are having trouble using it, make sure that its associated AWS CloudHSM cluster is
active and contains the minimum number of HSMs required for the operation, if any.
For help repairing your custom key store, see the Troubleshooting Custom Key Stores topic in the AWS Key Management Service Developer Guide.
describeCustomKeyStores in interface AWSKMSdescribeCustomKeyStoresRequest - CustomKeyStoreNotFoundException - The request was rejected because AWS KMS cannot find a custom key store with the specified key store name
or ID.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.public DescribeKeyResult describeKey(DescribeKeyRequest request)
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.
describeKey in interface AWSKMSdescribeKeyRequest - NotFoundException - The request was rejected because the specified entity or resource could not be found.InvalidArnException - The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.public DisableKeyResult disableKey(DisableKeyRequest request)
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.
disableKey in interface AWSKMSdisableKeyRequest - NotFoundException - The request was rejected because the specified entity or resource could not be found.InvalidArnException - The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public DisableKeyRotationResult disableKeyRotation(DisableKeyRotationRequest request)
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.
disableKeyRotation in interface AWSKMSdisableKeyRotationRequest - NotFoundException - The request was rejected because the specified entity or resource could not be found.DisabledException - The request was rejected because the specified CMK is not enabled.InvalidArnException - The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
UnsupportedOperationException - The request was rejected because a specified parameter is not supported or a specified resource is not
valid for this operation.public DisconnectCustomKeyStoreResult disconnectCustomKeyStore(DisconnectCustomKeyStoreRequest request)
Disconnects the custom key store from its associated AWS CloudHSM cluster. While a custom key store is disconnected, you can manage the custom key store and its customer master keys (CMKs), but you cannot create or use CMKs in the custom key store. You can reconnect the custom key store at any time.
While a custom key store is disconnected, all attempts to create customer master keys (CMKs) in the custom key store or to use existing CMKs in cryptographic operations will fail. This action can prevent users from storing and accessing sensitive data.
To find the connection state of a custom key store, use the DescribeCustomKeyStores operation. To reconnect a custom key store, use the ConnectCustomKeyStore operation.
If the operation succeeds, it returns a JSON object with no properties.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
disconnectCustomKeyStore in interface AWSKMSdisconnectCustomKeyStoreRequest - CustomKeyStoreInvalidStateException - The request was rejected because of the ConnectionState of the custom key store. To get the
ConnectionState of a custom key store, use the DescribeCustomKeyStores operation.
This exception is thrown under the following conditions:
You requested the CreateKey or GenerateRandom operation in a custom key store that is not
connected. These operations are valid only when the custom key store ConnectionState is
CONNECTED.
You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on a custom key
store that is not disconnected. This operation is valid only when the custom key store
ConnectionState is DISCONNECTED.
You requested the ConnectCustomKeyStore operation on a custom key store with a
ConnectionState of DISCONNECTING or FAILED. This operation is
valid for all other ConnectionState values.
CustomKeyStoreNotFoundException - The request was rejected because AWS KMS cannot find a custom key store with the specified key store name
or ID.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.public EnableKeyResult enableKey(EnableKeyRequest request)
Sets the key state of a customer master key (CMK) to enabled. This allows you to use the CMK 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.
enableKey in interface AWSKMSenableKeyRequest - NotFoundException - The request was rejected because the specified entity or resource could not be found.InvalidArnException - The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.LimitExceededException - The request was rejected because a limit was exceeded. For more information, see Limits in the AWS Key
Management Service Developer Guide.KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public EnableKeyRotationResult enableKeyRotation(EnableKeyRotationRequest request)
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.
You cannot enable automatic rotation of CMKs with imported key material or CMKs in a custom key store.
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.
enableKeyRotation in interface AWSKMSenableKeyRotationRequest - NotFoundException - The request was rejected because the specified entity or resource could not be found.DisabledException - The request was rejected because the specified CMK is not enabled.InvalidArnException - The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
UnsupportedOperationException - The request was rejected because a specified parameter is not supported or a specified resource is not
valid for this operation.public EncryptResult encrypt(EncryptRequest request)
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.
encrypt in interface AWSKMSencryptRequest - NotFoundException - The request was rejected because the specified entity or resource could not be found.DisabledException - The request was rejected because the specified CMK is not enabled.KeyUnavailableException - The request was rejected because the specified CMK was not available. The request can be retried.DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.InvalidKeyUsageException - The request was rejected because the specified KeySpec value is not valid.InvalidGrantTokenException - The request was rejected because the specified grant token is not valid.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public GenerateDataKeyResult generateDataKey(GenerateDataKeyRequest request)
Generates a unique data key. This operation returns a plaintext copy of the data key and a copy that is encrypted under a customer master key (CMK) that you specify. You can use the plaintext key to encrypt your data outside of KMS and store the encrypted data key with the encrypted data.
GenerateDataKey returns a unique data key for each request. The bytes in the key are not related to
the caller or CMK that is used to encrypt the data key.
To generate a data key, you need to specify the customer master key (CMK) that will be used to encrypt the data
key. You must also specify the length of the data key using either the KeySpec or
NumberOfBytes field (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.
You will find the plaintext copy of the data key in the Plaintext field of the response, and the
encrypted copy of the data key in the CiphertextBlob field.
We recommend that you use the following pattern to encrypt data locally in your application:
Use the GenerateDataKey operation to get a data encryption key.
Use the plaintext data 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. The operation returns 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 get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To get a cryptographically secure random byte string, use GenerateRandom.
You can use the optional encryption context to add additional security to your encryption operation. When you
specify an EncryptionContext in the GenerateDataKey operation, you must specify the
same encryption context (a case-sensitive exact match) in your request to Decrypt the data key. Otherwise,
the request to decrypt fails with an InvalidCiphertextException. 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.
generateDataKey in interface AWSKMSgenerateDataKeyRequest - NotFoundException - The request was rejected because the specified entity or resource could not be found.DisabledException - The request was rejected because the specified CMK is not enabled.KeyUnavailableException - The request was rejected because the specified CMK was not available. The request can be retried.DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.InvalidKeyUsageException - The request was rejected because the specified KeySpec value is not valid.InvalidGrantTokenException - The request was rejected because the specified grant token is not valid.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public GenerateDataKeyWithoutPlaintextResult generateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest request)
Generates a unique data key. This operation returns a data key that is encrypted under a customer master key
(CMK) that you specify. GenerateDataKeyWithoutPlaintext is identical to GenerateDataKey
except that returns only the encrypted copy of the data key.
Like GenerateDataKey, GenerateDataKeyWithoutPlaintext returns a unique data key for
each request. The bytes in the key are not related to the caller or CMK that is used to encrypt the data key.
This operation is useful for systems that need to encrypt data at some point, but not immediately. When you need to encrypt the data, you call the Decrypt operation on the encrypted copy of the key.
It's also useful in distributed systems with different levels of trust. For example, you might store encrypted data in containers. One component of your system creates new containers and stores an encrypted data key with each container. Then, a different component puts the data into the containers. That component first decrypts the data key, uses the plaintext data key to encrypt data, puts the encrypted data into the container, and then destroys the plaintext data key. In this system, the component that creates the containers 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.
generateDataKeyWithoutPlaintext in interface AWSKMSgenerateDataKeyWithoutPlaintextRequest - NotFoundException - The request was rejected because the specified entity or resource could not be found.DisabledException - The request was rejected because the specified CMK is not enabled.KeyUnavailableException - The request was rejected because the specified CMK was not available. The request can be retried.DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.InvalidKeyUsageException - The request was rejected because the specified KeySpec value is not valid.InvalidGrantTokenException - The request was rejected because the specified grant token is not valid.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public GenerateRandomResult generateRandom(GenerateRandomRequest request)
Returns a random byte string that is cryptographically secure.
By default, the random byte string is generated in AWS KMS. To generate the byte string in the AWS CloudHSM cluster that is associated with a custom key store, specify the custom key store ID.
For more information about entropy and random number generation, see the AWS Key Management Service Cryptographic Details whitepaper.
generateRandom in interface AWSKMSgenerateRandomRequest - DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.CustomKeyStoreNotFoundException - The request was rejected because AWS KMS cannot find a custom key store with the specified key store name
or ID.CustomKeyStoreInvalidStateException - The request was rejected because of the ConnectionState of the custom key store. To get the
ConnectionState of a custom key store, use the DescribeCustomKeyStores operation.
This exception is thrown under the following conditions:
You requested the CreateKey or GenerateRandom operation in a custom key store that is not
connected. These operations are valid only when the custom key store ConnectionState is
CONNECTED.
You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on a custom key
store that is not disconnected. This operation is valid only when the custom key store
ConnectionState is DISCONNECTED.
You requested the ConnectCustomKeyStore operation on a custom key store with a
ConnectionState of DISCONNECTING or FAILED. This operation is
valid for all other ConnectionState values.
public GenerateRandomResult generateRandom()
AWSKMSgenerateRandom in interface AWSKMSAWSKMS.generateRandom(GenerateRandomRequest)public GetKeyPolicyResult getKeyPolicy(GetKeyPolicyRequest request)
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.
getKeyPolicy in interface AWSKMSgetKeyPolicyRequest - NotFoundException - The request was rejected because the specified entity or resource could not be found.InvalidArnException - The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public GetKeyRotationStatusResult getKeyRotationStatus(GetKeyRotationStatusRequest request)
Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified customer master key (CMK).
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.
getKeyRotationStatus in interface AWSKMSgetKeyRotationStatusRequest - NotFoundException - The request was rejected because the specified entity or resource could not be found.InvalidArnException - The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
UnsupportedOperationException - The request was rejected because a specified parameter is not supported or a specified resource is not
valid for this operation.public GetParametersForImportResult getParametersForImport(GetParametersForImportRequest request)
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.
getParametersForImport in interface AWSKMSgetParametersForImportRequest - InvalidArnException - The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.UnsupportedOperationException - The request was rejected because a specified parameter is not supported or a specified resource is not
valid for this operation.DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.NotFoundException - The request was rejected because the specified entity or resource could not be found.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public ImportKeyMaterialResult importKeyMaterial(ImportKeyMaterialRequest request)
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 key state of the CMK 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.
importKeyMaterial in interface AWSKMSimportKeyMaterialRequest - InvalidArnException - The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.UnsupportedOperationException - The request was rejected because a specified parameter is not supported or a specified resource is not
valid for this operation.DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.NotFoundException - The request was rejected because the specified entity or resource could not be found.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
InvalidCiphertextException - The request was rejected because the specified ciphertext, or additional authenticated data incorporated
into the ciphertext, such as the encryption context, is corrupted, missing, or otherwise invalid.IncorrectKeyMaterialException - The request was rejected because the provided key material is invalid or is not the same key material
that was previously imported into this customer master key (CMK).ExpiredImportTokenException - The request was rejected because the provided import token is expired. Use GetParametersForImport
to get a new import token and public key, use the new public key to encrypt the key material, and then
try the request again.InvalidImportTokenException - The request was rejected because the provided import token is invalid or is associated with a different
customer master key (CMK).public ListAliasesResult listAliases(ListAliasesRequest request)
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.
listAliases in interface AWSKMSlistAliasesRequest - DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.InvalidMarkerException - The request was rejected because the marker that specifies where pagination should next begin is not
valid.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.InvalidArnException - The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.NotFoundException - The request was rejected because the specified entity or resource could not be found.public ListAliasesResult listAliases()
AWSKMSlistAliases in interface AWSKMSAWSKMS.listAliases(ListAliasesRequest)public ListGrantsResult listGrants(ListGrantsRequest request)
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.
listGrants in interface AWSKMSlistGrantsRequest - NotFoundException - The request was rejected because the specified entity or resource could not be found.DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.InvalidMarkerException - The request was rejected because the marker that specifies where pagination should next begin is not
valid.InvalidArnException - The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public ListKeyPoliciesResult listKeyPolicies(ListKeyPoliciesRequest request)
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.
listKeyPolicies in interface AWSKMSlistKeyPoliciesRequest - NotFoundException - The request was rejected because the specified entity or resource could not be found.InvalidArnException - The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public ListKeysResult listKeys(ListKeysRequest request)
Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.
listKeys in interface AWSKMSlistKeysRequest - DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.InvalidMarkerException - The request was rejected because the marker that specifies where pagination should next begin is not
valid.public ListKeysResult listKeys()
AWSKMSlistKeys in interface AWSKMSAWSKMS.listKeys(ListKeysRequest)public ListResourceTagsResult listResourceTags(ListResourceTagsRequest request)
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.
listResourceTags in interface AWSKMSlistResourceTagsRequest - KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.NotFoundException - The request was rejected because the specified entity or resource could not be found.InvalidArnException - The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.InvalidMarkerException - The request was rejected because the marker that specifies where pagination should next begin is not
valid.public ListRetirableGrantsResult listRetirableGrants(ListRetirableGrantsRequest request)
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.
listRetirableGrants in interface AWSKMSlistRetirableGrantsRequest - DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.InvalidMarkerException - The request was rejected because the marker that specifies where pagination should next begin is not
valid.InvalidArnException - The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.NotFoundException - The request was rejected because the specified entity or resource could not be found.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.public PutKeyPolicyResult putKeyPolicy(PutKeyPolicyRequest request)
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.
putKeyPolicy in interface AWSKMSputKeyPolicyRequest - NotFoundException - The request was rejected because the specified entity or resource could not be found.InvalidArnException - The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.MalformedPolicyDocumentException - The request was rejected because the specified policy is not syntactically or semantically correct.DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.UnsupportedOperationException - The request was rejected because a specified parameter is not supported or a specified resource is not
valid for this operation.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.LimitExceededException - The request was rejected because a limit was exceeded. For more information, see Limits in the AWS Key
Management Service Developer Guide.KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public ReEncryptResult reEncrypt(ReEncryptRequest request)
Encrypts data on the server side with a new customer master key (CMK) without exposing the plaintext of the data on the client side. 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.
reEncrypt in interface AWSKMSreEncryptRequest - NotFoundException - The request was rejected because the specified entity or resource could not be found.DisabledException - The request was rejected because the specified CMK is not enabled.InvalidCiphertextException - The request was rejected because the specified ciphertext, or additional authenticated data incorporated
into the ciphertext, such as the encryption context, is corrupted, missing, or otherwise invalid.KeyUnavailableException - The request was rejected because the specified CMK was not available. The request can be retried.DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.InvalidKeyUsageException - The request was rejected because the specified KeySpec value is not valid.InvalidGrantTokenException - The request was rejected because the specified grant token is not valid.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public RetireGrantResult retireGrant(RetireGrantRequest request)
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.
retireGrant in interface AWSKMSretireGrantRequest - InvalidArnException - The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.InvalidGrantTokenException - The request was rejected because the specified grant token is not valid.InvalidGrantIdException - The request was rejected because the specified GrantId is not valid.NotFoundException - The request was rejected because the specified entity or resource could not be found.DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public RetireGrantResult retireGrant()
AWSKMSretireGrant in interface AWSKMSAWSKMS.retireGrant(RetireGrantRequest)public RevokeGrantResult revokeGrant(RevokeGrantRequest request)
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.
revokeGrant in interface AWSKMSrevokeGrantRequest - NotFoundException - The request was rejected because the specified entity or resource could not be found.DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.InvalidArnException - The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.InvalidGrantIdException - The request was rejected because the specified GrantId is not valid.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public ScheduleKeyDeletionResult scheduleKeyDeletion(ScheduleKeyDeletionRequest request)
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 key 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.
Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is unrecoverable. To prevent the use of a CMK without deleting it, use DisableKey.
If you schedule deletion of a CMK from a custom key store,
when the waiting period expires, ScheduleKeyDeletion deletes the CMK from AWS KMS. Then AWS KMS
makes a best effort to delete the key material from the associated AWS CloudHSM cluster. However, you might need
to manually delete
the orphaned key material from the cluster and its backups.
You cannot perform this operation on a CMK in a different AWS account.
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.
scheduleKeyDeletion in interface AWSKMSscheduleKeyDeletionRequest - NotFoundException - The request was rejected because the specified entity or resource could not be found.InvalidArnException - The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public TagResourceResult tagResource(TagResourceRequest request)
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.
tagResource in interface AWSKMStagResourceRequest - KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.NotFoundException - The request was rejected because the specified entity or resource could not be found.InvalidArnException - The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
LimitExceededException - The request was rejected because a limit was exceeded. For more information, see Limits in the AWS Key
Management Service Developer Guide.TagException - The request was rejected because one or more tags are not valid.public UntagResourceResult untagResource(UntagResourceRequest request)
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.
untagResource in interface AWSKMSuntagResourceRequest - KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.NotFoundException - The request was rejected because the specified entity or resource could not be found.InvalidArnException - The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
TagException - The request was rejected because one or more tags are not valid.public UpdateAliasResult updateAlias(UpdateAliasRequest request)
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.
The alias name must begin with alias/ followed by a name, such as alias/ExampleAlias.
It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name
cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.
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.
updateAlias in interface AWSKMSupdateAliasRequest - DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.NotFoundException - The request was rejected because the specified entity or resource could not be found.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public UpdateCustomKeyStoreResult updateCustomKeyStore(UpdateCustomKeyStoreRequest request)
Changes the properties of a custom key store. Use the CustomKeyStoreId parameter to identify the
custom key store you want to edit. Use the remaining parameters to change the properties of the custom key store.
You can only update a custom key store that is disconnected. To disconnect the custom key store, use DisconnectCustomKeyStore. To reconnect the custom key store after the update completes, use ConnectCustomKeyStore. To find the connection state of a custom key store, use the DescribeCustomKeyStores operation.
Use the parameters of UpdateCustomKeyStore to edit your keystore settings.
Use the NewCustomKeyStoreName parameter to change the friendly name of the custom key store to the value that you specify.
Use the KeyStorePassword parameter tell AWS KMS the current password of the
kmsuser crypto user (CU) in the associated AWS CloudHSM cluster. You can use this parameter to
fix
connection failures that occur when AWS KMS cannot log into the associated cluster because the
kmsuser password has changed. This value does not change the password in the AWS CloudHSM cluster.
Use the CloudHsmClusterId parameter to associate the custom key store with a different, but related, AWS CloudHSM cluster. You can use this parameter to repair a custom key store if its AWS CloudHSM cluster becomes corrupted or is deleted, or when you need to create or restore a cluster from a backup.
If the operation succeeds, it returns a JSON object with no properties.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
updateCustomKeyStore in interface AWSKMSupdateCustomKeyStoreRequest - CustomKeyStoreNotFoundException - The request was rejected because AWS KMS cannot find a custom key store with the specified key store name
or ID.CloudHsmClusterNotFoundException - The request was rejected because AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster
ID. Retry the request with a different cluster ID.CloudHsmClusterNotRelatedException - The request was rejected because the specified AWS CloudHSM cluster has a different cluster certificate
than the original cluster. You cannot use the operation to specify an unrelated cluster.
Specify a cluster that shares a backup history with the original cluster. This includes clusters that were created from a backup of the current cluster, and clusters that were created from the same backup that produced the current cluster.
Clusters that share a backup history have the same cluster certificate. To view the cluster certificate of a cluster, use the DescribeClusters operation.
CustomKeyStoreInvalidStateException - The request was rejected because of the ConnectionState of the custom key store. To get the
ConnectionState of a custom key store, use the DescribeCustomKeyStores operation.
This exception is thrown under the following conditions:
You requested the CreateKey or GenerateRandom operation in a custom key store that is not
connected. These operations are valid only when the custom key store ConnectionState is
CONNECTED.
You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on a custom key
store that is not disconnected. This operation is valid only when the custom key store
ConnectionState is DISCONNECTED.
You requested the ConnectCustomKeyStore operation on a custom key store with a
ConnectionState of DISCONNECTING or FAILED. This operation is
valid for all other ConnectionState values.
KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.CloudHsmClusterNotActiveException - The request was rejected because the AWS CloudHSM cluster that is associated with the custom key store is
not active. Initialize and activate the cluster and try the command again. For detailed instructions, see
Getting Started
in the AWS CloudHSM User Guide.CloudHsmClusterInvalidConfigurationException - The request was rejected because the associated AWS CloudHSM cluster did not meet the configuration
requirements for a custom key store.
The cluster must be configured with private subnets in at least two different Availability Zones in the Region.
The security group for the cluster (cloudhsm-cluster-<cluster-id>-sg) must include inbound rules and outbound rules that allow TCP traffic on ports 2223-2225. The Source in the inbound rules and the Destination in the outbound rules must match the security group ID. These rules are set by default when you create the cluster. Do not delete or change them. To get information about a particular security group, use the DescribeSecurityGroups operation.
The cluster must contain at least as many HSMs as the operation requires. To add HSMs, use the AWS CloudHSM CreateHsm operation.
For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey operations, the AWS CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the ConnectCustomKeyStore operation, the AWS CloudHSM must contain at least one active HSM.
For information about the requirements for an AWS CloudHSM cluster that is associated with a custom key store, see Assemble the Prerequisites in the AWS Key Management Service Developer Guide. For information about creating a private subnet for an AWS CloudHSM cluster, see Create a Private Subnet in the AWS CloudHSM User Guide. For information about cluster security groups, see Configure a Default Security Group in the AWS CloudHSM User Guide .
public UpdateKeyDescriptionResult updateKeyDescription(UpdateKeyDescriptionRequest request)
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.
updateKeyDescription in interface AWSKMSupdateKeyDescriptionRequest - NotFoundException - The request was rejected because the specified entity or resource could not be found.InvalidArnException - The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.DependencyTimeoutException - The system timed out while trying to fulfill the request. The request can be retried.KMSInternalException - The request was rejected because an internal exception occurred. The request can be retried.KMSInvalidStateException - The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
public 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 the request.
getCachedResponseMetadata in interface AWSKMSrequest - The originally executed requestCopyright © 2019. All rights reserved.