@Generated(value="software.amazon.awssdk:codegen") public interface KMSClient extends SdkClient, SdkAutoCloseable
builder()
method.
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, iOS, 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, or you can 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 APIs
Of the APIs discussed in this guide, the following will prove the most useful for most applications. You will likely perform actions other than these, such as creating keys and assigning policies, by using the console.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static KMSClientBuilder |
builder()
Create a builder that can be used to configure and create a
KMSClient . |
default CancelKeyDeletionResponse |
cancelKeyDeletion(CancelKeyDeletionRequest cancelKeyDeletionRequest)
Cancels the deletion of a customer master key (CMK).
|
default CancelKeyDeletionResponse |
cancelKeyDeletion(Consumer<CancelKeyDeletionRequest.Builder> cancelKeyDeletionRequest)
Cancels the deletion of a customer master key (CMK).
|
static KMSClient |
create()
Create a
KMSClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from
the DefaultCredentialsProvider . |
default CreateAliasResponse |
createAlias(Consumer<CreateAliasRequest.Builder> createAliasRequest)
Creates a display name for a customer master key (CMK).
|
default CreateAliasResponse |
createAlias(CreateAliasRequest createAliasRequest)
Creates a display name for a customer master key (CMK).
|
default CreateGrantResponse |
createGrant(Consumer<CreateGrantRequest.Builder> createGrantRequest)
Adds a grant to a customer master key (CMK).
|
default CreateGrantResponse |
createGrant(CreateGrantRequest createGrantRequest)
Adds a grant to a customer master key (CMK).
|
default CreateKeyResponse |
createKey()
Creates a customer master key (CMK) in the caller's AWS account.
|
default CreateKeyResponse |
createKey(Consumer<CreateKeyRequest.Builder> createKeyRequest)
Creates a customer master key (CMK) in the caller's AWS account.
|
default CreateKeyResponse |
createKey(CreateKeyRequest createKeyRequest)
Creates a customer master key (CMK) in the caller's AWS account.
|
default DecryptResponse |
decrypt(Consumer<DecryptRequest.Builder> decryptRequest)
Decrypts ciphertext.
|
default DecryptResponse |
decrypt(DecryptRequest decryptRequest)
Decrypts ciphertext.
|
default DeleteAliasResponse |
deleteAlias(Consumer<DeleteAliasRequest.Builder> deleteAliasRequest)
Deletes the specified alias.
|
default DeleteAliasResponse |
deleteAlias(DeleteAliasRequest deleteAliasRequest)
Deletes the specified alias.
|
default DeleteImportedKeyMaterialResponse |
deleteImportedKeyMaterial(Consumer<DeleteImportedKeyMaterialRequest.Builder> deleteImportedKeyMaterialRequest)
Deletes key material that you previously imported.
|
default DeleteImportedKeyMaterialResponse |
deleteImportedKeyMaterial(DeleteImportedKeyMaterialRequest deleteImportedKeyMaterialRequest)
Deletes key material that you previously imported.
|
default DescribeKeyResponse |
describeKey(Consumer<DescribeKeyRequest.Builder> describeKeyRequest)
Provides detailed information about the specified customer master key (CMK).
|
default DescribeKeyResponse |
describeKey(DescribeKeyRequest describeKeyRequest)
Provides detailed information about the specified customer master key (CMK).
|
default DisableKeyResponse |
disableKey(Consumer<DisableKeyRequest.Builder> disableKeyRequest)
Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic
operations.
|
default DisableKeyResponse |
disableKey(DisableKeyRequest disableKeyRequest)
Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic
operations.
|
default DisableKeyRotationResponse |
disableKeyRotation(Consumer<DisableKeyRotationRequest.Builder> disableKeyRotationRequest)
Disables automatic rotation of the key material for the specified customer master key (CMK).
|
default DisableKeyRotationResponse |
disableKeyRotation(DisableKeyRotationRequest disableKeyRotationRequest)
Disables automatic rotation of the key material for the specified customer master key (CMK).
|
default EnableKeyResponse |
enableKey(Consumer<EnableKeyRequest.Builder> enableKeyRequest)
Sets the state of a customer master key (CMK) to enabled, thereby permitting its use for cryptographic
operations.
|
default EnableKeyResponse |
enableKey(EnableKeyRequest enableKeyRequest)
Sets the state of a customer master key (CMK) to enabled, thereby permitting its use for cryptographic
operations.
|
default EnableKeyRotationResponse |
enableKeyRotation(Consumer<EnableKeyRotationRequest.Builder> enableKeyRotationRequest)
Enables automatic rotation of the key material for the specified customer master key (CMK).
|
default EnableKeyRotationResponse |
enableKeyRotation(EnableKeyRotationRequest enableKeyRotationRequest)
Enables automatic rotation of the key material for the specified customer master key (CMK).
|
default EncryptResponse |
encrypt(Consumer<EncryptRequest.Builder> encryptRequest)
Encrypts plaintext into ciphertext by using a customer master key (CMK).
|
default EncryptResponse |
encrypt(EncryptRequest encryptRequest)
Encrypts plaintext into ciphertext by using a customer master key (CMK).
|
default GenerateDataKeyResponse |
generateDataKey(Consumer<GenerateDataKeyRequest.Builder> generateDataKeyRequest)
Returns a data encryption key that you can use in your application to encrypt data locally.
|
default GenerateDataKeyResponse |
generateDataKey(GenerateDataKeyRequest generateDataKeyRequest)
Returns a data encryption key that you can use in your application to encrypt data locally.
|
default GenerateDataKeyWithoutPlaintextResponse |
generateDataKeyWithoutPlaintext(Consumer<GenerateDataKeyWithoutPlaintextRequest.Builder> generateDataKeyWithoutPlaintextRequest)
Returns a data encryption key encrypted under a customer master key (CMK).
|
default GenerateDataKeyWithoutPlaintextResponse |
generateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest generateDataKeyWithoutPlaintextRequest)
Returns a data encryption key encrypted under a customer master key (CMK).
|
default GenerateRandomResponse |
generateRandom()
Returns a random byte string that is cryptographically secure.
|
default GenerateRandomResponse |
generateRandom(Consumer<GenerateRandomRequest.Builder> generateRandomRequest)
Returns a random byte string that is cryptographically secure.
|
default GenerateRandomResponse |
generateRandom(GenerateRandomRequest generateRandomRequest)
Returns a random byte string that is cryptographically secure.
|
default GetKeyPolicyResponse |
getKeyPolicy(Consumer<GetKeyPolicyRequest.Builder> getKeyPolicyRequest)
Gets a key policy attached to the specified customer master key (CMK).
|
default GetKeyPolicyResponse |
getKeyPolicy(GetKeyPolicyRequest getKeyPolicyRequest)
Gets a key policy attached to the specified customer master key (CMK).
|
default GetKeyRotationStatusResponse |
getKeyRotationStatus(Consumer<GetKeyRotationStatusRequest.Builder> getKeyRotationStatusRequest)
Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified
customer master key (CMK).
|
default GetKeyRotationStatusResponse |
getKeyRotationStatus(GetKeyRotationStatusRequest getKeyRotationStatusRequest)
Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified
customer master key (CMK).
|
default GetParametersForImportResponse |
getParametersForImport(Consumer<GetParametersForImportRequest.Builder> getParametersForImportRequest)
Returns the items you need in order to import key material into AWS KMS from your existing key management
infrastructure.
|
default GetParametersForImportResponse |
getParametersForImport(GetParametersForImportRequest getParametersForImportRequest)
Returns the items you need in order to import key material into AWS KMS from your existing key management
infrastructure.
|
default ImportKeyMaterialResponse |
importKeyMaterial(Consumer<ImportKeyMaterialRequest.Builder> importKeyMaterialRequest)
Imports key material into an existing AWS KMS customer master key (CMK) that was created without key material.
|
default ImportKeyMaterialResponse |
importKeyMaterial(ImportKeyMaterialRequest importKeyMaterialRequest)
Imports key material into an existing AWS KMS customer master key (CMK) that was created without key material.
|
default ListAliasesResponse |
listAliases()
Gets a list of all aliases in the caller's AWS account and region.
|
default ListAliasesResponse |
listAliases(Consumer<ListAliasesRequest.Builder> listAliasesRequest)
Gets a list of all aliases in the caller's AWS account and region.
|
default ListAliasesResponse |
listAliases(ListAliasesRequest listAliasesRequest)
Gets a list of all aliases in the caller's AWS account and region.
|
default ListAliasesIterable |
listAliasesPaginator()
Gets a list of all aliases in the caller's AWS account and region.
|
default ListAliasesIterable |
listAliasesPaginator(ListAliasesRequest listAliasesRequest)
Gets a list of all aliases in the caller's AWS account and region.
|
default ListGrantsResponse |
listGrants(Consumer<ListGrantsRequest.Builder> listGrantsRequest)
Gets a list of all grants for the specified customer master key (CMK).
|
default ListGrantsResponse |
listGrants(ListGrantsRequest listGrantsRequest)
Gets a list of all grants for the specified customer master key (CMK).
|
default ListGrantsIterable |
listGrantsPaginator(ListGrantsRequest listGrantsRequest)
Gets a list of all grants for the specified customer master key (CMK).
|
default ListKeyPoliciesResponse |
listKeyPolicies(Consumer<ListKeyPoliciesRequest.Builder> listKeyPoliciesRequest)
Gets the names of the key policies that are attached to a customer master key (CMK).
|
default ListKeyPoliciesResponse |
listKeyPolicies(ListKeyPoliciesRequest listKeyPoliciesRequest)
Gets the names of the key policies that are attached to a customer master key (CMK).
|
default ListKeyPoliciesIterable |
listKeyPoliciesPaginator(ListKeyPoliciesRequest listKeyPoliciesRequest)
Gets the names of the key policies that are attached to a customer master key (CMK).
|
default ListKeysResponse |
listKeys()
Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.
|
default ListKeysResponse |
listKeys(Consumer<ListKeysRequest.Builder> listKeysRequest)
Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.
|
default ListKeysResponse |
listKeys(ListKeysRequest listKeysRequest)
Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.
|
default ListKeysIterable |
listKeysPaginator()
Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.
|
default ListKeysIterable |
listKeysPaginator(ListKeysRequest listKeysRequest)
Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.
|
default ListResourceTagsResponse |
listResourceTags(Consumer<ListResourceTagsRequest.Builder> listResourceTagsRequest)
Returns a list of all tags for the specified customer master key (CMK).
|
default ListResourceTagsResponse |
listResourceTags(ListResourceTagsRequest listResourceTagsRequest)
Returns a list of all tags for the specified customer master key (CMK).
|
default ListRetirableGrantsResponse |
listRetirableGrants(Consumer<ListRetirableGrantsRequest.Builder> listRetirableGrantsRequest)
Returns a list of all grants for which the grant's
RetiringPrincipal matches the one specified. |
default ListRetirableGrantsResponse |
listRetirableGrants(ListRetirableGrantsRequest listRetirableGrantsRequest)
Returns a list of all grants for which the grant's
RetiringPrincipal matches the one specified. |
default PutKeyPolicyResponse |
putKeyPolicy(Consumer<PutKeyPolicyRequest.Builder> putKeyPolicyRequest)
Attaches a key policy to the specified customer master key (CMK).
|
default PutKeyPolicyResponse |
putKeyPolicy(PutKeyPolicyRequest putKeyPolicyRequest)
Attaches a key policy to the specified customer master key (CMK).
|
default ReEncryptResponse |
reEncrypt(Consumer<ReEncryptRequest.Builder> reEncryptRequest)
Encrypts data on the server side with a new customer master key (CMK) without exposing the plaintext of the data
on the client side.
|
default ReEncryptResponse |
reEncrypt(ReEncryptRequest reEncryptRequest)
Encrypts data on the server side with a new customer master key (CMK) without exposing the plaintext of the data
on the client side.
|
default RetireGrantResponse |
retireGrant()
Retires a grant.
|
default RetireGrantResponse |
retireGrant(Consumer<RetireGrantRequest.Builder> retireGrantRequest)
Retires a grant.
|
default RetireGrantResponse |
retireGrant(RetireGrantRequest retireGrantRequest)
Retires a grant.
|
default RevokeGrantResponse |
revokeGrant(Consumer<RevokeGrantRequest.Builder> revokeGrantRequest)
Revokes the specified grant for the specified customer master key (CMK).
|
default RevokeGrantResponse |
revokeGrant(RevokeGrantRequest revokeGrantRequest)
Revokes the specified grant for the specified customer master key (CMK).
|
default ScheduleKeyDeletionResponse |
scheduleKeyDeletion(Consumer<ScheduleKeyDeletionRequest.Builder> scheduleKeyDeletionRequest)
Schedules the deletion of a customer master key (CMK).
|
default ScheduleKeyDeletionResponse |
scheduleKeyDeletion(ScheduleKeyDeletionRequest scheduleKeyDeletionRequest)
Schedules the deletion of a customer master key (CMK).
|
static ServiceMetadata |
serviceMetadata() |
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds or overwrites one or more tags for the specified customer master key (CMK).
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Adds or overwrites one or more tags for the specified customer master key (CMK).
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes the specified tag or tags from the specified customer master key (CMK).
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tag or tags from the specified customer master key (CMK).
|
default UpdateAliasResponse |
updateAlias(Consumer<UpdateAliasRequest.Builder> updateAliasRequest)
Associates an existing alias with a different customer master key (CMK).
|
default UpdateAliasResponse |
updateAlias(UpdateAliasRequest updateAliasRequest)
Associates an existing alias with a different customer master key (CMK).
|
default UpdateKeyDescriptionResponse |
updateKeyDescription(Consumer<UpdateKeyDescriptionRequest.Builder> updateKeyDescriptionRequest)
Updates the description of a customer master key (CMK).
|
default UpdateKeyDescriptionResponse |
updateKeyDescription(UpdateKeyDescriptionRequest updateKeyDescriptionRequest)
Updates the description of a customer master key (CMK).
|
serviceName
close
static final String SERVICE_NAME
static KMSClient create()
KMSClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from
the DefaultCredentialsProvider
.static KMSClientBuilder builder()
KMSClient
.default CancelKeyDeletionResponse cancelKeyDeletion(CancelKeyDeletionRequest cancelKeyDeletionRequest) throws NotFoundException, InvalidArnException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
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.
cancelKeyDeletionRequest
- NotFoundException
- The request was rejected because the specified entity or resource could not be found.InvalidArnException
- The request was rejected because a specified ARN was 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default CancelKeyDeletionResponse cancelKeyDeletion(Consumer<CancelKeyDeletionRequest.Builder> cancelKeyDeletionRequest) throws NotFoundException, InvalidArnException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
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.
cancelKeyDeletionRequest
- NotFoundException
- The request was rejected because the specified entity or resource could not be found.InvalidArnException
- The request was rejected because a specified ARN was 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default CreateAliasResponse createAlias(CreateAliasRequest createAliasRequest) throws DependencyTimeoutException, AlreadyExistsException, NotFoundException, InvalidAliasNameException, KMSInternalException, LimitExceededException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Creates a display name for a customer master key (CMK). You can use an alias to identify a CMK in selected operations, such as Encrypt and GenerateDataKey.
Each CMK can have multiple aliases, but each alias points to only one CMK. The alias name must be unique in the AWS account and region. To simplify code that runs in multiple regions, use the same alias name, but point it to a different CMK in each region.
Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation.
An alias must start with the word alias
followed by a forward slash (alias/
). The alias
name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names
cannot begin with aws
; that alias name prefix is reserved by Amazon Web Services (AWS).
The alias and the CMK it is mapped to must be in the same AWS account and the same region. You cannot perform this operation on an alias in a different AWS account.
To map an existing alias to a different CMK, call UpdateAlias.
createAliasRequest
- 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default CreateAliasResponse createAlias(Consumer<CreateAliasRequest.Builder> createAliasRequest) throws DependencyTimeoutException, AlreadyExistsException, NotFoundException, InvalidAliasNameException, KMSInternalException, LimitExceededException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Creates a display name for a customer master key (CMK). You can use an alias to identify a CMK in selected operations, such as Encrypt and GenerateDataKey.
Each CMK can have multiple aliases, but each alias points to only one CMK. The alias name must be unique in the AWS account and region. To simplify code that runs in multiple regions, use the same alias name, but point it to a different CMK in each region.
Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation.
An alias must start with the word alias
followed by a forward slash (alias/
). The alias
name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names
cannot begin with aws
; that alias name prefix is reserved by Amazon Web Services (AWS).
The alias and the CMK it is mapped to must be in the same AWS account and the same region. You cannot perform this operation on an alias in a different AWS account.
To map an existing alias to a different CMK, call UpdateAlias.
createAliasRequest
- 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default CreateGrantResponse createGrant(CreateGrantRequest createGrantRequest) throws NotFoundException, DisabledException, DependencyTimeoutException, InvalidArnException, KMSInternalException, InvalidGrantTokenException, LimitExceededException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Adds a grant to a customer master key (CMK). The grant specifies who can use the CMK and under what conditions. When setting permissions, grants are an alternative to key policies.
To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter. For more information about grants, see Grants in the AWS Key Management Service Developer Guide.
createGrantRequest
- 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 was 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default CreateGrantResponse createGrant(Consumer<CreateGrantRequest.Builder> createGrantRequest) throws NotFoundException, DisabledException, DependencyTimeoutException, InvalidArnException, KMSInternalException, InvalidGrantTokenException, LimitExceededException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Adds a grant to a customer master key (CMK). The grant specifies who can use the CMK and under what conditions. When setting permissions, grants are an alternative to key policies.
To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter. For more information about grants, see Grants in the AWS Key Management Service Developer Guide.
createGrantRequest
- 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 was 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default CreateKeyResponse createKey() throws MalformedPolicyDocumentException, DependencyTimeoutException, InvalidArnException, UnsupportedOperationException, KMSInternalException, LimitExceededException, TagException, SdkServiceException, SdkClientException, KMSException
Creates a customer master key (CMK) in the caller's AWS account.
You can use a CMK to encrypt small amounts of data (4 KiB or less) directly, but CMKs are more commonly used to encrypt data encryption keys (DEKs), which are used to encrypt raw data. For more information about DEKs and the difference between CMKs and DEKs, see the following:
The GenerateDataKey operation
AWS Key Management Service Concepts in the AWS Key Management Service Developer Guide
You cannot use this operation to create a CMK in a different AWS account.
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 was 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
SdkServiceException
createKey(CreateKeyRequest)
,
AWS API
Documentationdefault CreateKeyResponse createKey(CreateKeyRequest createKeyRequest) throws MalformedPolicyDocumentException, DependencyTimeoutException, InvalidArnException, UnsupportedOperationException, KMSInternalException, LimitExceededException, TagException, SdkServiceException, SdkClientException, KMSException
Creates a customer master key (CMK) in the caller's AWS account.
You can use a CMK to encrypt small amounts of data (4 KiB or less) directly, but CMKs are more commonly used to encrypt data encryption keys (DEKs), which are used to encrypt raw data. For more information about DEKs and the difference between CMKs and DEKs, see the following:
The GenerateDataKey operation
AWS Key Management Service Concepts in the AWS Key Management Service Developer Guide
You cannot use this operation to create a CMK in a different AWS account.
createKeyRequest
- 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 was 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
SdkServiceException
default CreateKeyResponse createKey(Consumer<CreateKeyRequest.Builder> createKeyRequest) throws MalformedPolicyDocumentException, DependencyTimeoutException, InvalidArnException, UnsupportedOperationException, KMSInternalException, LimitExceededException, TagException, SdkServiceException, SdkClientException, KMSException
Creates a customer master key (CMK) in the caller's AWS account.
You can use a CMK to encrypt small amounts of data (4 KiB or less) directly, but CMKs are more commonly used to encrypt data encryption keys (DEKs), which are used to encrypt raw data. For more information about DEKs and the difference between CMKs and DEKs, see the following:
The GenerateDataKey operation
AWS Key Management Service Concepts in the AWS Key Management Service Developer Guide
You cannot use this operation to create a CMK in a different AWS account.
createKeyRequest
- 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 was 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
SdkServiceException
default DecryptResponse decrypt(DecryptRequest decryptRequest) throws NotFoundException, DisabledException, InvalidCiphertextException, KeyUnavailableException, DependencyTimeoutException, InvalidGrantTokenException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following operations:
Note that if a caller has been granted access permissions to all keys (through, for example, IAM user policies
that grant Decrypt
permission on all resources), then ciphertext encrypted by using keys in other
accounts where the key grants access to the caller can be decrypted. To remedy this, we recommend that you do not
grant Decrypt
access in an IAM user policy. Instead grant Decrypt
access only in key
policies. If you must grant Decrypt
access in an IAM user policy, you should scope the resource to
specific keys or to specific trusted accounts.
decryptRequest
- 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DecryptResponse decrypt(Consumer<DecryptRequest.Builder> decryptRequest) throws NotFoundException, DisabledException, InvalidCiphertextException, KeyUnavailableException, DependencyTimeoutException, InvalidGrantTokenException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following operations:
Note that if a caller has been granted access permissions to all keys (through, for example, IAM user policies
that grant Decrypt
permission on all resources), then ciphertext encrypted by using keys in other
accounts where the key grants access to the caller can be decrypted. To remedy this, we recommend that you do not
grant Decrypt
access in an IAM user policy. Instead grant Decrypt
access only in key
policies. If you must grant Decrypt
access in an IAM user policy, you should scope the resource to
specific keys or to specific trusted accounts.
decryptRequest
- 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DeleteAliasResponse deleteAlias(DeleteAliasRequest deleteAliasRequest) throws DependencyTimeoutException, NotFoundException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Deletes the specified alias. You cannot perform this operation on an alias in a different AWS account.
Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation.
Each CMK can have multiple aliases. To change the alias of a CMK, use DeleteAlias to delete the current alias and CreateAlias to create a new alias. To associate an existing alias with a different customer master key (CMK), call UpdateAlias.
deleteAliasRequest
- 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DeleteAliasResponse deleteAlias(Consumer<DeleteAliasRequest.Builder> deleteAliasRequest) throws DependencyTimeoutException, NotFoundException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Deletes the specified alias. You cannot perform this operation on an alias in a different AWS account.
Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation.
Each CMK can have multiple aliases. To change the alias of a CMK, use DeleteAlias to delete the current alias and CreateAlias to create a new alias. To associate an existing alias with a different customer master key (CMK), call UpdateAlias.
deleteAliasRequest
- 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DeleteImportedKeyMaterialResponse deleteImportedKeyMaterial(DeleteImportedKeyMaterialRequest deleteImportedKeyMaterialRequest) throws InvalidArnException, UnsupportedOperationException, DependencyTimeoutException, NotFoundException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
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.
deleteImportedKeyMaterialRequest
- InvalidArnException
- The request was rejected because a specified ARN was 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
SdkServiceException
default DeleteImportedKeyMaterialResponse deleteImportedKeyMaterial(Consumer<DeleteImportedKeyMaterialRequest.Builder> deleteImportedKeyMaterialRequest) throws InvalidArnException, UnsupportedOperationException, DependencyTimeoutException, NotFoundException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
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.
deleteImportedKeyMaterialRequest
- InvalidArnException
- The request was rejected because a specified ARN was 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
SdkServiceException
default DescribeKeyResponse describeKey(DescribeKeyRequest describeKeyRequest) throws NotFoundException, InvalidArnException, DependencyTimeoutException, KMSInternalException, SdkServiceException, SdkClientException, KMSException
Provides detailed information about the specified customer master key (CMK).
To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.
describeKeyRequest
- NotFoundException
- The request was rejected because the specified entity or resource could not be found.InvalidArnException
- The request was rejected because a specified ARN was 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeKeyResponse describeKey(Consumer<DescribeKeyRequest.Builder> describeKeyRequest) throws NotFoundException, InvalidArnException, DependencyTimeoutException, KMSInternalException, SdkServiceException, SdkClientException, KMSException
Provides detailed information about the specified customer master key (CMK).
To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.
describeKeyRequest
- NotFoundException
- The request was rejected because the specified entity or resource could not be found.InvalidArnException
- The request was rejected because a specified ARN was 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DisableKeyResponse disableKey(DisableKeyRequest disableKeyRequest) throws NotFoundException, InvalidArnException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
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.
disableKeyRequest
- NotFoundException
- The request was rejected because the specified entity or resource could not be found.InvalidArnException
- The request was rejected because a specified ARN was 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DisableKeyResponse disableKey(Consumer<DisableKeyRequest.Builder> disableKeyRequest) throws NotFoundException, InvalidArnException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
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.
disableKeyRequest
- NotFoundException
- The request was rejected because the specified entity or resource could not be found.InvalidArnException
- The request was rejected because a specified ARN was 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DisableKeyRotationResponse disableKeyRotation(DisableKeyRotationRequest disableKeyRotationRequest) throws NotFoundException, DisabledException, InvalidArnException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, UnsupportedOperationException, SdkServiceException, SdkClientException, KMSException
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.
disableKeyRotationRequest
- 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 was 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
SdkServiceException
default DisableKeyRotationResponse disableKeyRotation(Consumer<DisableKeyRotationRequest.Builder> disableKeyRotationRequest) throws NotFoundException, DisabledException, InvalidArnException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, UnsupportedOperationException, SdkServiceException, SdkClientException, KMSException
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.
disableKeyRotationRequest
- 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 was 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
SdkServiceException
default EnableKeyResponse enableKey(EnableKeyRequest enableKeyRequest) throws NotFoundException, InvalidArnException, DependencyTimeoutException, KMSInternalException, LimitExceededException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Sets the state of a customer master key (CMK) to enabled, thereby permitting its use for cryptographic operations. You cannot perform this operation on a CMK in a different AWS account.
enableKeyRequest
- NotFoundException
- The request was rejected because the specified entity or resource could not be found.InvalidArnException
- The request was rejected because a specified ARN was 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default EnableKeyResponse enableKey(Consumer<EnableKeyRequest.Builder> enableKeyRequest) throws NotFoundException, InvalidArnException, DependencyTimeoutException, KMSInternalException, LimitExceededException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Sets the state of a customer master key (CMK) to enabled, thereby permitting its use for cryptographic operations. You cannot perform this operation on a CMK in a different AWS account.
enableKeyRequest
- NotFoundException
- The request was rejected because the specified entity or resource could not be found.InvalidArnException
- The request was rejected because a specified ARN was 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default EnableKeyRotationResponse enableKeyRotation(EnableKeyRotationRequest enableKeyRotationRequest) throws NotFoundException, DisabledException, InvalidArnException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, UnsupportedOperationException, SdkServiceException, SdkClientException, KMSException
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.
enableKeyRotationRequest
- 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 was 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
SdkServiceException
default EnableKeyRotationResponse enableKeyRotation(Consumer<EnableKeyRotationRequest.Builder> enableKeyRotationRequest) throws NotFoundException, DisabledException, InvalidArnException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, UnsupportedOperationException, SdkServiceException, SdkClientException, KMSException
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.
enableKeyRotationRequest
- 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 was 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
SdkServiceException
default EncryptResponse encrypt(EncryptRequest encryptRequest) throws NotFoundException, DisabledException, KeyUnavailableException, DependencyTimeoutException, InvalidKeyUsageException, InvalidGrantTokenException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Encrypts plaintext into ciphertext by using a customer master key (CMK). The Encrypt
operation has
two primary use cases:
You can encrypt up to 4 kilobytes (4096 bytes) of arbitrary data such as an RSA key, a database password, or other sensitive information.
To move encrypted data from one AWS region to another, you can use this operation to encrypt in the new region the plaintext data key that was used to encrypt the data in the original region. This provides you with an encrypted copy of the data key that can be decrypted in the new region and used there to decrypt the encrypted data.
To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.
Unless you are moving encrypted data from one region to another, you don't use this operation to encrypt a
generated data key within a region. To get data keys that are already encrypted, call the GenerateDataKey
or GenerateDataKeyWithoutPlaintext operation. Data keys don't need to be encrypted again by calling
Encrypt
.
To encrypt data locally in your application, use the GenerateDataKey operation to return a plaintext data encryption key and a copy of the key encrypted under the CMK of your choosing.
encryptRequest
- 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default EncryptResponse encrypt(Consumer<EncryptRequest.Builder> encryptRequest) throws NotFoundException, DisabledException, KeyUnavailableException, DependencyTimeoutException, InvalidKeyUsageException, InvalidGrantTokenException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Encrypts plaintext into ciphertext by using a customer master key (CMK). The Encrypt
operation has
two primary use cases:
You can encrypt up to 4 kilobytes (4096 bytes) of arbitrary data such as an RSA key, a database password, or other sensitive information.
To move encrypted data from one AWS region to another, you can use this operation to encrypt in the new region the plaintext data key that was used to encrypt the data in the original region. This provides you with an encrypted copy of the data key that can be decrypted in the new region and used there to decrypt the encrypted data.
To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.
Unless you are moving encrypted data from one region to another, you don't use this operation to encrypt a
generated data key within a region. To get data keys that are already encrypted, call the GenerateDataKey
or GenerateDataKeyWithoutPlaintext operation. Data keys don't need to be encrypted again by calling
Encrypt
.
To encrypt data locally in your application, use the GenerateDataKey operation to return a plaintext data encryption key and a copy of the key encrypted under the CMK of your choosing.
encryptRequest
- 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default GenerateDataKeyResponse generateDataKey(GenerateDataKeyRequest generateDataKeyRequest) throws NotFoundException, DisabledException, KeyUnavailableException, DependencyTimeoutException, InvalidKeyUsageException, InvalidGrantTokenException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Returns a data encryption key that you can use in your application to encrypt data locally.
You must specify the customer master key (CMK) under which to generate the data key. You must also specify the
length of the data key using either the KeySpec
or NumberOfBytes
field. You must
specify one field or the other, but not both. For common key lengths (128-bit and 256-bit symmetric keys), we
recommend that you use KeySpec
. To perform this operation on a CMK in a different AWS account,
specify the key ARN or alias ARN in the value of the KeyId parameter.
This operation returns a plaintext copy of the data key in the Plaintext
field of the response, and
an encrypted copy of the data key in the CiphertextBlob
field. The data key is encrypted under the
CMK specified in the KeyId
field of the request.
We recommend that you use the following pattern to encrypt data locally in your application:
Use this operation (GenerateDataKey
) to get a data encryption key.
Use the plaintext data encryption key (returned in the Plaintext
field of the response) to encrypt
data locally, then erase the plaintext data key from memory.
Store the encrypted data key (returned in the CiphertextBlob
field of the response) alongside the
locally encrypted data.
To decrypt data locally:
Use the Decrypt operation to decrypt the encrypted data key into a plaintext copy of the data key.
Use the plaintext data key to decrypt data locally, then erase the plaintext data key from memory.
To return only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To return a random byte string that is cryptographically secure, use GenerateRandom.
If you use the optional EncryptionContext
field, you must store at least enough information to be
able to reconstruct the full encryption context when you later send the ciphertext to the Decrypt
operation. It is a good practice to choose an encryption context that you can reconstruct on the fly to better
secure the ciphertext. For more information, see Encryption Context in the
AWS Key Management Service Developer Guide.
generateDataKeyRequest
- 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default GenerateDataKeyResponse generateDataKey(Consumer<GenerateDataKeyRequest.Builder> generateDataKeyRequest) throws NotFoundException, DisabledException, KeyUnavailableException, DependencyTimeoutException, InvalidKeyUsageException, InvalidGrantTokenException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Returns a data encryption key that you can use in your application to encrypt data locally.
You must specify the customer master key (CMK) under which to generate the data key. You must also specify the
length of the data key using either the KeySpec
or NumberOfBytes
field. You must
specify one field or the other, but not both. For common key lengths (128-bit and 256-bit symmetric keys), we
recommend that you use KeySpec
. To perform this operation on a CMK in a different AWS account,
specify the key ARN or alias ARN in the value of the KeyId parameter.
This operation returns a plaintext copy of the data key in the Plaintext
field of the response, and
an encrypted copy of the data key in the CiphertextBlob
field. The data key is encrypted under the
CMK specified in the KeyId
field of the request.
We recommend that you use the following pattern to encrypt data locally in your application:
Use this operation (GenerateDataKey
) to get a data encryption key.
Use the plaintext data encryption key (returned in the Plaintext
field of the response) to encrypt
data locally, then erase the plaintext data key from memory.
Store the encrypted data key (returned in the CiphertextBlob
field of the response) alongside the
locally encrypted data.
To decrypt data locally:
Use the Decrypt operation to decrypt the encrypted data key into a plaintext copy of the data key.
Use the plaintext data key to decrypt data locally, then erase the plaintext data key from memory.
To return only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To return a random byte string that is cryptographically secure, use GenerateRandom.
If you use the optional EncryptionContext
field, you must store at least enough information to be
able to reconstruct the full encryption context when you later send the ciphertext to the Decrypt
operation. It is a good practice to choose an encryption context that you can reconstruct on the fly to better
secure the ciphertext. For more information, see Encryption Context in the
AWS Key Management Service Developer Guide.
generateDataKeyRequest
- 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default GenerateDataKeyWithoutPlaintextResponse generateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest generateDataKeyWithoutPlaintextRequest) throws NotFoundException, DisabledException, KeyUnavailableException, DependencyTimeoutException, InvalidKeyUsageException, InvalidGrantTokenException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Returns a data encryption key encrypted under a customer master key (CMK). This operation is identical to GenerateDataKey but returns only the encrypted copy of the data key.
To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.
This operation is useful in a system that has multiple components with different degrees of trust. For example,
consider a system that stores encrypted data in containers. Each container stores the encrypted data and an
encrypted copy of the data key. One component of the system, called the control plane, creates new
containers. When it creates a new container, it uses this operation (GenerateDataKeyWithoutPlaintext
) to get an encrypted data key and then stores it in the container. Later, a different component of the system,
called the data plane, puts encrypted data into the containers. To do this, it passes the encrypted data
key to the Decrypt operation, then uses the returned plaintext data key to encrypt data, and finally
stores the encrypted data in the container. In this system, the control plane never sees the plaintext data key.
generateDataKeyWithoutPlaintextRequest
- 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default GenerateDataKeyWithoutPlaintextResponse generateDataKeyWithoutPlaintext(Consumer<GenerateDataKeyWithoutPlaintextRequest.Builder> generateDataKeyWithoutPlaintextRequest) throws NotFoundException, DisabledException, KeyUnavailableException, DependencyTimeoutException, InvalidKeyUsageException, InvalidGrantTokenException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Returns a data encryption key encrypted under a customer master key (CMK). This operation is identical to GenerateDataKey but returns only the encrypted copy of the data key.
To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.
This operation is useful in a system that has multiple components with different degrees of trust. For example,
consider a system that stores encrypted data in containers. Each container stores the encrypted data and an
encrypted copy of the data key. One component of the system, called the control plane, creates new
containers. When it creates a new container, it uses this operation (GenerateDataKeyWithoutPlaintext
) to get an encrypted data key and then stores it in the container. Later, a different component of the system,
called the data plane, puts encrypted data into the containers. To do this, it passes the encrypted data
key to the Decrypt operation, then uses the returned plaintext data key to encrypt data, and finally
stores the encrypted data in the container. In this system, the control plane never sees the plaintext data key.
generateDataKeyWithoutPlaintextRequest
- 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default GenerateRandomResponse generateRandom() throws DependencyTimeoutException, KMSInternalException, SdkServiceException, SdkClientException, KMSException
Returns a random byte string that is cryptographically secure.
For more information about entropy and random number generation, see the AWS Key Management Service Cryptographic Details whitepaper.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
generateRandom(GenerateRandomRequest)
,
AWS API
Documentationdefault GenerateRandomResponse generateRandom(GenerateRandomRequest generateRandomRequest) throws DependencyTimeoutException, KMSInternalException, SdkServiceException, SdkClientException, KMSException
Returns a random byte string that is cryptographically secure.
For more information about entropy and random number generation, see the AWS Key Management Service Cryptographic Details whitepaper.
generateRandomRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default GenerateRandomResponse generateRandom(Consumer<GenerateRandomRequest.Builder> generateRandomRequest) throws DependencyTimeoutException, KMSInternalException, SdkServiceException, SdkClientException, KMSException
Returns a random byte string that is cryptographically secure.
For more information about entropy and random number generation, see the AWS Key Management Service Cryptographic Details whitepaper.
generateRandomRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default GetKeyPolicyResponse getKeyPolicy(GetKeyPolicyRequest getKeyPolicyRequest) throws NotFoundException, InvalidArnException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Gets a key policy attached to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
getKeyPolicyRequest
- NotFoundException
- The request was rejected because the specified entity or resource could not be found.InvalidArnException
- The request was rejected because a specified ARN was 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default GetKeyPolicyResponse getKeyPolicy(Consumer<GetKeyPolicyRequest.Builder> getKeyPolicyRequest) throws NotFoundException, InvalidArnException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Gets a key policy attached to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
getKeyPolicyRequest
- NotFoundException
- The request was rejected because the specified entity or resource could not be found.InvalidArnException
- The request was rejected because a specified ARN was 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default GetKeyRotationStatusResponse getKeyRotationStatus(GetKeyRotationStatusRequest getKeyRotationStatusRequest) throws NotFoundException, InvalidArnException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, UnsupportedOperationException, SdkServiceException, SdkClientException, KMSException
Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified customer master key (CMK).
To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.
getKeyRotationStatusRequest
- NotFoundException
- The request was rejected because the specified entity or resource could not be found.InvalidArnException
- The request was rejected because a specified ARN was 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
SdkServiceException
default GetKeyRotationStatusResponse getKeyRotationStatus(Consumer<GetKeyRotationStatusRequest.Builder> getKeyRotationStatusRequest) throws NotFoundException, InvalidArnException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, UnsupportedOperationException, SdkServiceException, SdkClientException, KMSException
Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified customer master key (CMK).
To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.
getKeyRotationStatusRequest
- NotFoundException
- The request was rejected because the specified entity or resource could not be found.InvalidArnException
- The request was rejected because a specified ARN was 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
SdkServiceException
default GetParametersForImportResponse getParametersForImport(GetParametersForImportRequest getParametersForImportRequest) throws InvalidArnException, UnsupportedOperationException, DependencyTimeoutException, NotFoundException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
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.
getParametersForImportRequest
- InvalidArnException
- The request was rejected because a specified ARN was 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
SdkServiceException
default GetParametersForImportResponse getParametersForImport(Consumer<GetParametersForImportRequest.Builder> getParametersForImportRequest) throws InvalidArnException, UnsupportedOperationException, DependencyTimeoutException, NotFoundException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
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.
getParametersForImportRequest
- InvalidArnException
- The request was rejected because a specified ARN was 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
SdkServiceException
default ImportKeyMaterialResponse importKeyMaterial(ImportKeyMaterialRequest importKeyMaterialRequest) throws InvalidArnException, UnsupportedOperationException, DependencyTimeoutException, NotFoundException, KMSInternalException, KMSInvalidStateException, InvalidCiphertextException, IncorrectKeyMaterialException, ExpiredImportTokenException, InvalidImportTokenException, SdkServiceException, SdkClientException, KMSException
Imports key material into an existing AWS KMS customer master key (CMK) that was created without key material. You cannot perform this operation on a CMK in a different AWS account. For more information about creating CMKs with no key material and then importing key material, see Importing Key Material in the AWS Key Management Service Developer Guide.
Before using this operation, call GetParametersForImport. Its response includes a public key and an import
token. Use the public key to encrypt the key material. Then, submit the import token from the same
GetParametersForImport
response.
When calling this operation, you must specify the following values:
The key ID or key ARN of a CMK with no key material. Its Origin
must be EXTERNAL
.
To create a CMK with no key material, call CreateKey and set the value of its Origin
parameter to EXTERNAL
. To get the Origin
of a CMK, call DescribeKey.)
The encrypted key material. To get the public key to encrypt the key material, call GetParametersForImport.
The import token that GetParametersForImport returned. This token and the public key used to encrypt the key material must have come from the same response.
Whether the key material expires and if so, when. If you set an expiration date, you can change it only by reimporting the same key material and specifying a new expiration date. If the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. To use the CMK again, you must reimport the same key material.
When this operation is successful, the CMK's key state changes from PendingImport
to
Enabled
, and you can use the CMK. After you successfully import key material into a CMK, you can
reimport the same key material into that CMK, but you cannot import different key material.
importKeyMaterialRequest
- InvalidArnException
- The request was rejected because a specified ARN was 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).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
SdkServiceException
default ImportKeyMaterialResponse importKeyMaterial(Consumer<ImportKeyMaterialRequest.Builder> importKeyMaterialRequest) throws InvalidArnException, UnsupportedOperationException, DependencyTimeoutException, NotFoundException, KMSInternalException, KMSInvalidStateException, InvalidCiphertextException, IncorrectKeyMaterialException, ExpiredImportTokenException, InvalidImportTokenException, SdkServiceException, SdkClientException, KMSException
Imports key material into an existing AWS KMS customer master key (CMK) that was created without key material. You cannot perform this operation on a CMK in a different AWS account. For more information about creating CMKs with no key material and then importing key material, see Importing Key Material in the AWS Key Management Service Developer Guide.
Before using this operation, call GetParametersForImport. Its response includes a public key and an import
token. Use the public key to encrypt the key material. Then, submit the import token from the same
GetParametersForImport
response.
When calling this operation, you must specify the following values:
The key ID or key ARN of a CMK with no key material. Its Origin
must be EXTERNAL
.
To create a CMK with no key material, call CreateKey and set the value of its Origin
parameter to EXTERNAL
. To get the Origin
of a CMK, call DescribeKey.)
The encrypted key material. To get the public key to encrypt the key material, call GetParametersForImport.
The import token that GetParametersForImport returned. This token and the public key used to encrypt the key material must have come from the same response.
Whether the key material expires and if so, when. If you set an expiration date, you can change it only by reimporting the same key material and specifying a new expiration date. If the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. To use the CMK again, you must reimport the same key material.
When this operation is successful, the CMK's key state changes from PendingImport
to
Enabled
, and you can use the CMK. After you successfully import key material into a CMK, you can
reimport the same key material into that CMK, but you cannot import different key material.
importKeyMaterialRequest
- InvalidArnException
- The request was rejected because a specified ARN was 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).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
SdkServiceException
default ListAliasesResponse listAliases() throws DependencyTimeoutException, InvalidMarkerException, KMSInternalException, SdkServiceException, SdkClientException, KMSException
Gets a list of all aliases in the caller's AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see CreateAlias.
The response might include several aliases that do not have a TargetKeyId
field because they are not
associated with a CMK. These are predefined aliases that are reserved for CMKs managed by AWS services. If an
alias is not associated with a CMK, the alias does not count against the alias limit for your
account.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
listAliases(ListAliasesRequest)
,
AWS API
Documentationdefault ListAliasesResponse listAliases(ListAliasesRequest listAliasesRequest) throws DependencyTimeoutException, InvalidMarkerException, KMSInternalException, SdkServiceException, SdkClientException, KMSException
Gets a list of all aliases in the caller's AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see CreateAlias.
The response might include several aliases that do not have a TargetKeyId
field because they are not
associated with a CMK. These are predefined aliases that are reserved for CMKs managed by AWS services. If an
alias is not associated with a CMK, the alias does not count against the alias limit for your
account.
listAliasesRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListAliasesResponse listAliases(Consumer<ListAliasesRequest.Builder> listAliasesRequest) throws DependencyTimeoutException, InvalidMarkerException, KMSInternalException, SdkServiceException, SdkClientException, KMSException
Gets a list of all aliases in the caller's AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see CreateAlias.
The response might include several aliases that do not have a TargetKeyId
field because they are not
associated with a CMK. These are predefined aliases that are reserved for CMKs managed by AWS services. If an
alias is not associated with a CMK, the alias does not count against the alias limit for your
account.
listAliasesRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListAliasesIterable listAliasesPaginator() throws DependencyTimeoutException, InvalidMarkerException, KMSInternalException, SdkServiceException, SdkClientException, KMSException
Gets a list of all aliases in the caller's AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see CreateAlias.
The response might include several aliases that do not have a TargetKeyId
field because they are not
associated with a CMK. These are predefined aliases that are reserved for CMKs managed by AWS services. If an
alias is not associated with a CMK, the alias does not count against the alias limit for your
account.
This is a variant of listAliases(software.amazon.awssdk.services.kms.model.ListAliasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kms.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.kms.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request); for (software.amazon.awssdk.services.kms.model.ListAliasesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.kms.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listAliases(software.amazon.awssdk.services.kms.model.ListAliasesRequest)
operation.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
listAliasesPaginator(ListAliasesRequest)
,
AWS API
Documentationdefault ListAliasesIterable listAliasesPaginator(ListAliasesRequest listAliasesRequest) throws DependencyTimeoutException, InvalidMarkerException, KMSInternalException, SdkServiceException, SdkClientException, KMSException
Gets a list of all aliases in the caller's AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see CreateAlias.
The response might include several aliases that do not have a TargetKeyId
field because they are not
associated with a CMK. These are predefined aliases that are reserved for CMKs managed by AWS services. If an
alias is not associated with a CMK, the alias does not count against the alias limit for your
account.
This is a variant of listAliases(software.amazon.awssdk.services.kms.model.ListAliasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kms.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.kms.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request); for (software.amazon.awssdk.services.kms.model.ListAliasesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.kms.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listAliases(software.amazon.awssdk.services.kms.model.ListAliasesRequest)
operation.
listAliasesRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListGrantsResponse listGrants(ListGrantsRequest listGrantsRequest) throws NotFoundException, DependencyTimeoutException, InvalidMarkerException, InvalidArnException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Gets a list of all grants for the specified customer master key (CMK).
To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.
listGrantsRequest
- 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 was 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListGrantsResponse listGrants(Consumer<ListGrantsRequest.Builder> listGrantsRequest) throws NotFoundException, DependencyTimeoutException, InvalidMarkerException, InvalidArnException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Gets a list of all grants for the specified customer master key (CMK).
To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.
listGrantsRequest
- 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 was 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListGrantsIterable listGrantsPaginator(ListGrantsRequest listGrantsRequest) throws NotFoundException, DependencyTimeoutException, InvalidMarkerException, InvalidArnException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
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.
This is a variant of listGrants(software.amazon.awssdk.services.kms.model.ListGrantsRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kms.paginators.ListGrantsIterable responses = client.listGrantsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.kms.paginators.ListGrantsIterable responses = client.listGrantsPaginator(request); for (software.amazon.awssdk.services.kms.model.ListGrantsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.kms.paginators.ListGrantsIterable responses = client.listGrantsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listGrants(software.amazon.awssdk.services.kms.model.ListGrantsRequest)
operation.
listGrantsRequest
- 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 was 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListKeyPoliciesResponse listKeyPolicies(ListKeyPoliciesRequest listKeyPoliciesRequest) throws NotFoundException, InvalidArnException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Gets the names of the key policies that are attached to a customer master key (CMK). This operation is designed
to get policy names that you can use in a GetKeyPolicy operation. However, the only valid policy name is
default
. You cannot perform this operation on a CMK in a different AWS account.
listKeyPoliciesRequest
- NotFoundException
- The request was rejected because the specified entity or resource could not be found.InvalidArnException
- The request was rejected because a specified ARN was 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListKeyPoliciesResponse listKeyPolicies(Consumer<ListKeyPoliciesRequest.Builder> listKeyPoliciesRequest) throws NotFoundException, InvalidArnException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Gets the names of the key policies that are attached to a customer master key (CMK). This operation is designed
to get policy names that you can use in a GetKeyPolicy operation. However, the only valid policy name is
default
. You cannot perform this operation on a CMK in a different AWS account.
listKeyPoliciesRequest
- NotFoundException
- The request was rejected because the specified entity or resource could not be found.InvalidArnException
- The request was rejected because a specified ARN was 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListKeyPoliciesIterable listKeyPoliciesPaginator(ListKeyPoliciesRequest listKeyPoliciesRequest) throws NotFoundException, InvalidArnException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
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.
This is a variant of listKeyPolicies(software.amazon.awssdk.services.kms.model.ListKeyPoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kms.paginators.ListKeyPoliciesIterable responses = client.listKeyPoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.kms.paginators.ListKeyPoliciesIterable responses = client.listKeyPoliciesPaginator(request); for (software.amazon.awssdk.services.kms.model.ListKeyPoliciesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.kms.paginators.ListKeyPoliciesIterable responses = client.listKeyPoliciesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listKeyPolicies(software.amazon.awssdk.services.kms.model.ListKeyPoliciesRequest)
operation.
listKeyPoliciesRequest
- NotFoundException
- The request was rejected because the specified entity or resource could not be found.InvalidArnException
- The request was rejected because a specified ARN was 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListKeysResponse listKeys() throws DependencyTimeoutException, KMSInternalException, InvalidMarkerException, SdkServiceException, SdkClientException, KMSException
Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
listKeys(ListKeysRequest)
,
AWS API
Documentationdefault ListKeysResponse listKeys(ListKeysRequest listKeysRequest) throws DependencyTimeoutException, KMSInternalException, InvalidMarkerException, SdkServiceException, SdkClientException, KMSException
Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.
listKeysRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListKeysResponse listKeys(Consumer<ListKeysRequest.Builder> listKeysRequest) throws DependencyTimeoutException, KMSInternalException, InvalidMarkerException, SdkServiceException, SdkClientException, KMSException
Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.
listKeysRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListKeysIterable listKeysPaginator() throws DependencyTimeoutException, KMSInternalException, InvalidMarkerException, SdkServiceException, SdkClientException, KMSException
Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.
This is a variant of listKeys(software.amazon.awssdk.services.kms.model.ListKeysRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kms.paginators.ListKeysIterable responses = client.listKeysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.kms.paginators.ListKeysIterable responses = client.listKeysPaginator(request); for (software.amazon.awssdk.services.kms.model.ListKeysResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.kms.paginators.ListKeysIterable responses = client.listKeysPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listKeys(software.amazon.awssdk.services.kms.model.ListKeysRequest)
operation.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
listKeysPaginator(ListKeysRequest)
,
AWS API
Documentationdefault ListKeysIterable listKeysPaginator(ListKeysRequest listKeysRequest) throws DependencyTimeoutException, KMSInternalException, InvalidMarkerException, SdkServiceException, SdkClientException, KMSException
Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.
This is a variant of listKeys(software.amazon.awssdk.services.kms.model.ListKeysRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kms.paginators.ListKeysIterable responses = client.listKeysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.kms.paginators.ListKeysIterable responses = client.listKeysPaginator(request); for (software.amazon.awssdk.services.kms.model.ListKeysResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.kms.paginators.ListKeysIterable responses = client.listKeysPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listKeys(software.amazon.awssdk.services.kms.model.ListKeysRequest)
operation.
listKeysRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListResourceTagsResponse listResourceTags(ListResourceTagsRequest listResourceTagsRequest) throws KMSInternalException, NotFoundException, InvalidArnException, InvalidMarkerException, SdkServiceException, SdkClientException, KMSException
Returns a list of all tags for the specified customer master key (CMK).
You cannot perform this operation on a CMK in a different AWS account.
listResourceTagsRequest
- 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 was not valid.InvalidMarkerException
- The request was rejected because the marker that specifies where pagination should next begin is not
valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListResourceTagsResponse listResourceTags(Consumer<ListResourceTagsRequest.Builder> listResourceTagsRequest) throws KMSInternalException, NotFoundException, InvalidArnException, InvalidMarkerException, SdkServiceException, SdkClientException, KMSException
Returns a list of all tags for the specified customer master key (CMK).
You cannot perform this operation on a CMK in a different AWS account.
listResourceTagsRequest
- 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 was not valid.InvalidMarkerException
- The request was rejected because the marker that specifies where pagination should next begin is not
valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListRetirableGrantsResponse listRetirableGrants(ListRetirableGrantsRequest listRetirableGrantsRequest) throws DependencyTimeoutException, InvalidMarkerException, InvalidArnException, NotFoundException, KMSInternalException, SdkServiceException, SdkClientException, KMSException
Returns a list of all grants for which the grant's RetiringPrincipal
matches the one specified.
A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.
listRetirableGrantsRequest
- 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 was 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListRetirableGrantsResponse listRetirableGrants(Consumer<ListRetirableGrantsRequest.Builder> listRetirableGrantsRequest) throws DependencyTimeoutException, InvalidMarkerException, InvalidArnException, NotFoundException, KMSInternalException, SdkServiceException, SdkClientException, KMSException
Returns a list of all grants for which the grant's RetiringPrincipal
matches the one specified.
A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.
listRetirableGrantsRequest
- 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 was 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default PutKeyPolicyResponse putKeyPolicy(PutKeyPolicyRequest putKeyPolicyRequest) throws NotFoundException, InvalidArnException, MalformedPolicyDocumentException, DependencyTimeoutException, UnsupportedOperationException, KMSInternalException, LimitExceededException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Attaches a key policy to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.
putKeyPolicyRequest
- NotFoundException
- The request was rejected because the specified entity or resource could not be found.InvalidArnException
- The request was rejected because a specified ARN was 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
SdkServiceException
default PutKeyPolicyResponse putKeyPolicy(Consumer<PutKeyPolicyRequest.Builder> putKeyPolicyRequest) throws NotFoundException, InvalidArnException, MalformedPolicyDocumentException, DependencyTimeoutException, UnsupportedOperationException, KMSInternalException, LimitExceededException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Attaches a key policy to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.
putKeyPolicyRequest
- NotFoundException
- The request was rejected because the specified entity or resource could not be found.InvalidArnException
- The request was rejected because a specified ARN was 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
SdkServiceException
default ReEncryptResponse reEncrypt(ReEncryptRequest reEncryptRequest) throws NotFoundException, DisabledException, InvalidCiphertextException, KeyUnavailableException, DependencyTimeoutException, InvalidKeyUsageException, InvalidGrantTokenException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
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.
reEncryptRequest
- 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ReEncryptResponse reEncrypt(Consumer<ReEncryptRequest.Builder> reEncryptRequest) throws NotFoundException, DisabledException, InvalidCiphertextException, KeyUnavailableException, DependencyTimeoutException, InvalidKeyUsageException, InvalidGrantTokenException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
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.
reEncryptRequest
- 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default RetireGrantResponse retireGrant() throws InvalidGrantTokenException, InvalidGrantIdException, NotFoundException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
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.
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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
retireGrant(RetireGrantRequest)
,
AWS API
Documentationdefault RetireGrantResponse retireGrant(RetireGrantRequest retireGrantRequest) throws InvalidGrantTokenException, InvalidGrantIdException, NotFoundException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Retires a grant. To clean up, you can retire a grant when you're done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:
The AWS account (root user) under which the grant was created
The RetiringPrincipal
, if present in the grant
The GranteePrincipal
, if RetireGrant
is an operation specified in the grant
You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The CreateGrant operation returns both.
retireGrantRequest
- 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default RetireGrantResponse retireGrant(Consumer<RetireGrantRequest.Builder> retireGrantRequest) throws InvalidGrantTokenException, InvalidGrantIdException, NotFoundException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Retires a grant. To clean up, you can retire a grant when you're done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:
The AWS account (root user) under which the grant was created
The RetiringPrincipal
, if present in the grant
The GranteePrincipal
, if RetireGrant
is an operation specified in the grant
You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The CreateGrant operation returns both.
retireGrantRequest
- 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default RevokeGrantResponse revokeGrant(RevokeGrantRequest revokeGrantRequest) throws NotFoundException, DependencyTimeoutException, InvalidArnException, InvalidGrantIdException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Revokes the specified grant for the specified customer master key (CMK). You can revoke a grant to actively deny operations that depend on it.
To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.
revokeGrantRequest
- 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 was 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default RevokeGrantResponse revokeGrant(Consumer<RevokeGrantRequest.Builder> revokeGrantRequest) throws NotFoundException, DependencyTimeoutException, InvalidArnException, InvalidGrantIdException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Revokes the specified grant for the specified customer master key (CMK). You can revoke a grant to actively deny operations that depend on it.
To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.
revokeGrantRequest
- 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 was 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ScheduleKeyDeletionResponse scheduleKeyDeletion(ScheduleKeyDeletionRequest scheduleKeyDeletionRequest) throws NotFoundException, InvalidArnException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days,
before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this
operation is successful, the state of the CMK changes to PendingDeletion
. Before the waiting period
ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period ends, AWS
KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that refer to it.
You cannot perform this operation on a CMK in a different AWS account.
Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use DisableKey.
For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
scheduleKeyDeletionRequest
- NotFoundException
- The request was rejected because the specified entity or resource could not be found.InvalidArnException
- The request was rejected because a specified ARN was 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ScheduleKeyDeletionResponse scheduleKeyDeletion(Consumer<ScheduleKeyDeletionRequest.Builder> scheduleKeyDeletionRequest) throws NotFoundException, InvalidArnException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days,
before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this
operation is successful, the state of the CMK changes to PendingDeletion
. Before the waiting period
ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period ends, AWS
KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that refer to it.
You cannot perform this operation on a CMK in a different AWS account.
Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use DisableKey.
For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
scheduleKeyDeletionRequest
- NotFoundException
- The request was rejected because the specified entity or resource could not be found.InvalidArnException
- The request was rejected because a specified ARN was 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws KMSInternalException, NotFoundException, InvalidArnException, KMSInvalidStateException, LimitExceededException, TagException, SdkServiceException, SdkClientException, KMSException
Adds or overwrites one or more tags for the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
You cannot use the same tag key more than once per CMK. For example, consider a CMK with one tag whose tag key is
Purpose
and tag value is Test
. If you send a TagResource
request for this
CMK with a tag key of Purpose
and a tag value of Prod
, it does not create a second tag.
Instead, the original tag is overwritten with the new tag value.
For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.
tagResourceRequest
- 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 was 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws KMSInternalException, NotFoundException, InvalidArnException, KMSInvalidStateException, LimitExceededException, TagException, SdkServiceException, SdkClientException, KMSException
Adds or overwrites one or more tags for the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
You cannot use the same tag key more than once per CMK. For example, consider a CMK with one tag whose tag key is
Purpose
and tag value is Test
. If you send a TagResource
request for this
CMK with a tag key of Purpose
and a tag value of Prod
, it does not create a second tag.
Instead, the original tag is overwritten with the new tag value.
For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.
tagResourceRequest
- 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 was 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws KMSInternalException, NotFoundException, InvalidArnException, KMSInvalidStateException, TagException, SdkServiceException, SdkClientException, KMSException
Removes the specified tag or tags from the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
To remove a tag, you specify the tag key for each tag to remove. You do not specify the tag value. To overwrite the tag value for an existing tag, use TagResource.
untagResourceRequest
- 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 was 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws KMSInternalException, NotFoundException, InvalidArnException, KMSInvalidStateException, TagException, SdkServiceException, SdkClientException, KMSException
Removes the specified tag or tags from the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
To remove a tag, you specify the tag key for each tag to remove. You do not specify the tag value. To overwrite the tag value for an existing tag, use TagResource.
untagResourceRequest
- 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 was 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default UpdateAliasResponse updateAlias(UpdateAliasRequest updateAliasRequest) throws DependencyTimeoutException, NotFoundException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Associates an existing alias with a different customer master key (CMK). Each CMK can have multiple aliases, but the aliases must be unique within the account and region. You cannot perform this operation on an alias in a different AWS account.
This operation works only on existing aliases. To change the alias of a CMK to a new value, use CreateAlias to create a new alias and DeleteAlias to delete the old alias.
Because an alias is not a property of a CMK, you can create, update, and delete the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs in the account, use the ListAliases operation.
An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An
alias must start with the word alias
followed by a forward slash (alias/
). The alias
name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names
cannot begin with aws
; that alias name prefix is reserved by Amazon Web Services (AWS).
updateAliasRequest
- 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default UpdateAliasResponse updateAlias(Consumer<UpdateAliasRequest.Builder> updateAliasRequest) throws DependencyTimeoutException, NotFoundException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Associates an existing alias with a different customer master key (CMK). Each CMK can have multiple aliases, but the aliases must be unique within the account and region. You cannot perform this operation on an alias in a different AWS account.
This operation works only on existing aliases. To change the alias of a CMK to a new value, use CreateAlias to create a new alias and DeleteAlias to delete the old alias.
Because an alias is not a property of a CMK, you can create, update, and delete the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs in the account, use the ListAliases operation.
An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An
alias must start with the word alias
followed by a forward slash (alias/
). The alias
name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names
cannot begin with aws
; that alias name prefix is reserved by Amazon Web Services (AWS).
updateAliasRequest
- 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default UpdateKeyDescriptionResponse updateKeyDescription(UpdateKeyDescriptionRequest updateKeyDescriptionRequest) throws NotFoundException, InvalidArnException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Updates the description of a customer master key (CMK). To see the decription of a CMK, use DescribeKey.
You cannot perform this operation on a CMK in a different AWS account.
updateKeyDescriptionRequest
- NotFoundException
- The request was rejected because the specified entity or resource could not be found.InvalidArnException
- The request was rejected because a specified ARN was 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default UpdateKeyDescriptionResponse updateKeyDescription(Consumer<UpdateKeyDescriptionRequest.Builder> updateKeyDescriptionRequest) throws NotFoundException, InvalidArnException, DependencyTimeoutException, KMSInternalException, KMSInvalidStateException, SdkServiceException, SdkClientException, KMSException
Updates the description of a customer master key (CMK). To see the decription of a CMK, use DescribeKey.
You cannot perform this operation on a CMK in a different AWS account.
updateKeyDescriptionRequest
- NotFoundException
- The request was rejected because the specified entity or resource could not be found.InvalidArnException
- The request was rejected because a specified ARN was 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KMSException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.