AWS.KMS

Clients

• IKMSOptions — Interface for TKMSManagerClient options.
• TKMSOptions — TKMSClient options class.
• IKMSClient — Interface for KMS service client.
• TKMSClient — AWS Key Management Service (KMS) client.

Types

• TKMSEndpointProvider — Endpoint provider for Amazon's Key Management Service (KMS).
• IKMSAliasListEntry — Interface for AliasListEntry.
• TKMSAliasListEntry — AliasListEntry class.
• IKMSCustomKeyStoresListEntry — Interface for CustomKeyStoresListEntry.
• TKMSCustomKeyStoresListEntry — CustomKeyStoresListEntry class.
• IKMSGrantConstraints — Interface for GrantConstraints.
• TKMSGrantConstraints — GrantConstraints class.
• IKMSGrantListEntry — Interface for GrantListEntry.
• TKMSGrantListEntry — GrantListEntry class.
• IKMSKeyListEntry — Interface for KeyListEntry.
• TKMSKeyListEntry — KeyListEntry class.
• IKMSMultiRegionKey — Interface for MultiRegionKey.
• TKMSMultiRegionKey — MultiRegionKey class.
• IKMSMultiRegionConfiguration — Interface for MultiRegionConfiguration.
• TKMSMultiRegionConfiguration — MultiRegionConfiguration class.
• IKMSKeyMetadata — Interface for KeyMetadata.
• TKMSKeyMetadata — KeyMetadata class.
• IKMSTag — Interface for Tag.
• TKMSTag — Tag class.
• TKMSResponseInspector — Inspector for KMS responses.

Requests

• IKMSRequest — Base interface for Key Management Service (KMS) requests.
• TKMSRequest — Base implementation for Key Management Service (KMS) requests.
• IKMSCancelKeyDeletionRequest — Interface for CancelKeyDeletion requests.
• TKMSCancelKeyDeletionRequest — CancelKeyDeletion request class.
• IKMSConnectCustomKeyStoreRequest — Interface for ConnectCustomKeyStore requests.
• TKMSConnectCustomKeyStoreRequest — ConnectCustomKeyStore request class.
• IKMSCreateAliasRequest — Interface for CreateAlias requests.
• TKMSCreateAliasRequest — CreateAlias request class.
• IKMSCreateCustomKeyStoreRequest — Interface for CreateCustomKeyStore requests.
• TKMSCreateCustomKeyStoreRequest — CreateCustomKeyStore request class.
• IKMSCreateGrantRequest — Interface for CreateGrant requests.
• TKMSCreateGrantRequest — CreateGrant request class.
• IKMSCreateKeyRequest — Interface for CreateKey requests.
• TKMSCreateKeyRequest — CreateKey request class.
• IKMSDecryptRequest — Interface for Decrypt requests.
• TKMSDecryptRequest — Decrypt request class.
• IKMSDeleteAliasRequest — Interface for DeleteAlias requests.
• TKMSDeleteAliasRequest — DeleteAlias request class.
• IKMSDeleteCustomKeyStoreRequest — Interface for DeleteCustomKeyStore requests.
• TKMSDeleteCustomKeyStoreRequest — DeleteCustomKeyStore request class.
• IKMSDeleteImportedKeyMaterialRequest — Interface for DeleteImportedKeyMaterial requests.
• TKMSDeleteImportedKeyMaterialRequest — DeleteImportedKeyMaterial request class.
• IKMSDescribeCustomKeyStoresRequest — Interface for DescribeCustomKeyStores requests.
• TKMSDescribeCustomKeyStoresRequest — DescribeCustomKeyStores request class.
• IKMSDescribeKeyRequest — Interface for DescribeKey requests.
• TKMSDescribeKeyRequest — DescribeKey request class.
• IKMSDisableKeyRequest — Interface for DisableKey requests.
• TKMSDisableKeyRequest — DisableKey request class.
• IKMSDisableKeyRotationRequest — Interface for DisableKeyRotation requests.
• TKMSDisableKeyRotationRequest — DisableKeyRotation request class.
• IKMSDisconnectCustomKeyStoreRequest — Interface for DisconnectCustomKeyStore requests.
• TKMSDisconnectCustomKeyStoreRequest — DisconnectCustomKeyStore request class.
• IKMSEnableKeyRequest — Interface for EnableKey requests.
• TKMSEnableKeyRequest — EnableKey request class.
• IKMSEnableKeyRotationRequest — Interface for EnableKeyRotation requests.
• TKMSEnableKeyRotationRequest — EnableKeyRotation request class.
• IKMSEncryptRequest — Interface for Encrypt requests.
• TKMSEncryptRequest — Encrypt request class.
• IKMSGenerateDataKeyRequest — Interface for GenerateDataKey requests.
• TKMSGenerateDataKeyRequest — GenerateDataKey request class.
• IKMSGenerateDataKeyPairRequest — Interface for GenerateDataKeyPair requests.
• TKMSGenerateDataKeyPairRequest — GenerateDataKeyPair request class.
• IKMSGenerateDataKeyPairWithoutPlaintextRequest — Interface for GenerateDataKeyPairWithoutPlaintext requests.
• TKMSGenerateDataKeyPairWithoutPlaintextRequest — GenerateDataKeyPairWithoutPlaintext request class.
• IKMSGenerateDataKeyWithoutPlaintextRequest — Interface for GenerateDataKeyWithoutPlaintext requests.
• TKMSGenerateDataKeyWithoutPlaintextRequest — GenerateDataKeyWithoutPlaintext request class.
• IKMSGenerateMacRequest — Interface for GenerateMac requests.
• TKMSGenerateMacRequest — GenerateMac request class.
• IKMSGenerateRandomRequest — Interface for GenerateRandom requests.
• TKMSGenerateRandomRequest — GenerateRandom request class.
• IKMSGetKeyPolicyRequest — Interface for GetKeyPolicy requests.
• TKMSGetKeyPolicyRequest — GetKeyPolicy request class.
• IKMSGetKeyRotationStatusRequest — Interface for GetKeyRotationStatus requests.
• TKMSGetKeyRotationStatusRequest — GetKeyRotationStatus request class.
• IKMSGetParametersForImportRequest — Interface for GetParametersForImport requests.
• TKMSGetParametersForImportRequest — GetParametersForImport request class.
• IKMSGetPublicKeyRequest — Interface for GetPublicKey requests.
• TKMSGetPublicKeyRequest — GetPublicKey request class.
• IKMSImportKeyMaterialRequest — Interface for ImportKeyMaterial requests.
• TKMSImportKeyMaterialRequest — ImportKeyMaterial request class.
• IKMSListAliasesRequest — Interface for ListAliases requests.
• TKMSListAliasesRequest — ListAliases request class.
• IKMSListGrantsRequest — Interface for ListGrants requests.
• TKMSListGrantsRequest — ListGrants request class.
• IKMSListKeyPoliciesRequest — Interface for ListKeyPolicies requests.
• TKMSListKeyPoliciesRequest — ListKeyPolicies request class.
• IKMSListKeysRequest — Interface for ListKeys requests.
• TKMSListKeysRequest — ListKeys request class.
• IKMSListResourceTagsRequest — Interface for ListResourceTags requests.
• TKMSListResourceTagsRequest — ListResourceTags request class.
• IKMSListRetirableGrantsRequest — Interface for ListRetirableGrants requests.
• TKMSListRetirableGrantsRequest — ListRetirableGrants request class.
• IKMSPutKeyPolicyRequest — Interface for PutKeyPolicy requests.
• TKMSPutKeyPolicyRequest — PutKeyPolicy request class.
• IKMSReEncryptRequest — Interface for ReEncrypt requests.
• TKMSReEncryptRequest — ReEncrypt request class.
• IKMSReplicateKeyRequest — Interface for ReplicateKey requests.
• TKMSReplicateKeyRequest — ReplicateKey request class.
• IKMSRetireGrantRequest — Interface for RetireGrant requests.
• TKMSRetireGrantRequest — RetireGrant request class.
• IKMSRevokeGrantRequest — Interface for RevokeGrant requests.
• TKMSRevokeGrantRequest — RevokeGrant request class.
• IKMSScheduleKeyDeletionRequest — Interface for ScheduleKeyDeletion requests.
• TKMSScheduleKeyDeletionRequest — ScheduleKeyDeletion request class.
• IKMSSignRequest — Interface for Sign requests.
• TKMSSignRequest — Sign request class.
• IKMSTagResourceRequest — Interface for TagResource requests.
• TKMSTagResourceRequest — TagResource request class.
• IKMSUntagResourceRequest — Interface for UntagResource requests.
• TKMSUntagResourceRequest — UntagResource request class.
• IKMSUpdateAliasRequest — Interface for UpdateAlias requests.
• TKMSUpdateAliasRequest — UpdateAlias request class.
• IKMSUpdateCustomKeyStoreRequest — Interface for UpdateCustomKeyStore requests.
• TKMSUpdateCustomKeyStoreRequest — UpdateCustomKeyStore request class.
• IKMSUpdateKeyDescriptionRequest — Interface for UpdateKeyDescription requests.
• TKMSUpdateKeyDescriptionRequest — UpdateKeyDescription request class.
• IKMSUpdatePrimaryRegionRequest — Interface for UpdatePrimaryRegion requests.
• TKMSUpdatePrimaryRegionRequest — UpdatePrimaryRegion request class.
• IKMSVerifyRequest — Interface for Verify requests.
• TKMSVerifyRequest — Verify request class.
• IKMSVerifyMacRequest — Interface for VerifyMac requests.
• TKMSVerifyMacRequest — VerifyMac request class.

Responses

• IKMSResponse — Base interface for Key Management Service (KMS) responses.
• TKMSResponse — Base implementation for Key Management Service (KMS) responses.
• IKMSCancelKeyDeletionResponse — Interface for CancelKeyDeletion responses.
• TKMSCancelKeyDeletionResponse — CancelKeyDeletion response class.
• IKMSConnectCustomKeyStoreResponse — Interface for ConnectCustomKeyStore responses.
• TKMSConnectCustomKeyStoreResponse — ConnectCustomKeyStore response class.
• IKMSCreateAliasResponse — Interface for CreateAlias responses.
• TKMSCreateAliasResponse — CreateAlias response class.
• IKMSCreateCustomKeyStoreResponse — Interface for CreateCustomKeyStore responses.
• TKMSCreateCustomKeyStoreResponse — CreateCustomKeyStore response class.
• IKMSCreateGrantResponse — Interface for CreateGrant responses.
• TKMSCreateGrantResponse — CreateGrant response class.
• IKMSCreateKeyResponse — Interface for CreateKey responses.
• TKMSCreateKeyResponse — CreateKey response class.
• IKMSDecryptResponse — Interface for Decrypt responses.
• TKMSDecryptResponse — Decrypt response class.
• IKMSDeleteAliasResponse — Interface for DeleteAlias responses.
• TKMSDeleteAliasResponse — DeleteAlias response class.
• IKMSDeleteCustomKeyStoreResponse — Interface for DeleteCustomKeyStore responses.
• TKMSDeleteCustomKeyStoreResponse — DeleteCustomKeyStore response class.
• IKMSDeleteImportedKeyMaterialResponse — Interface for DeleteImportedKeyMaterial responses.
• TKMSDeleteImportedKeyMaterialResponse — DeleteImportedKeyMaterial response class.
• IKMSDescribeCustomKeyStoresResponse — Interface for DescribeCustomKeyStores responses.
• TKMSDescribeCustomKeyStoresResponse — DescribeCustomKeyStores response class.
• IKMSDescribeKeyResponse — Interface for DescribeKey responses.
• TKMSDescribeKeyResponse — DescribeKey response class.
• IKMSDisableKeyResponse — Interface for DisableKey responses.
• TKMSDisableKeyResponse — DisableKey response class.
• IKMSDisableKeyRotationResponse — Interface for DisableKeyRotation responses.
• TKMSDisableKeyRotationResponse — DisableKeyRotation response class.
• IKMSDisconnectCustomKeyStoreResponse — Interface for DisconnectCustomKeyStore responses.
• TKMSDisconnectCustomKeyStoreResponse — DisconnectCustomKeyStore response class.
• IKMSEnableKeyResponse — Interface for EnableKey responses.
• TKMSEnableKeyResponse — EnableKey response class.
• IKMSEnableKeyRotationResponse — Interface for EnableKeyRotation responses.
• TKMSEnableKeyRotationResponse — EnableKeyRotation response class.
• IKMSEncryptResponse — Interface for Encrypt responses.
• TKMSEncryptResponse — Encrypt response class.
• IKMSGenerateDataKeyResponse — Interface for GenerateDataKey responses.
• TKMSGenerateDataKeyResponse — GenerateDataKey response class.
• IKMSGenerateDataKeyPairResponse — Interface for GenerateDataKeyPair responses.
• TKMSGenerateDataKeyPairResponse — GenerateDataKeyPair response class.
• IKMSGenerateDataKeyPairWithoutPlaintextResponse — Interface for GenerateDataKeyPairWithoutPlaintext responses.
• TKMSGenerateDataKeyPairWithoutPlaintextResponse — GenerateDataKeyPairWithoutPlaintext response class.
• IKMSGenerateDataKeyWithoutPlaintextResponse — Interface for GenerateDataKeyWithoutPlaintext responses.
• TKMSGenerateDataKeyWithoutPlaintextResponse — GenerateDataKeyWithoutPlaintext response class.
• IKMSGenerateMacResponse — Interface for GenerateMac responses.
• TKMSGenerateMacResponse — GenerateMac response class.
• IKMSGenerateRandomResponse — Interface for GenerateRandom responses.
• TKMSGenerateRandomResponse — GenerateRandom response class.
• IKMSGetKeyPolicyResponse — Interface for GetKeyPolicy responses.
• TKMSGetKeyPolicyResponse — GetKeyPolicy response class.
• IKMSGetKeyRotationStatusResponse — Interface for GetKeyRotationStatus responses.
• TKMSGetKeyRotationStatusResponse — GetKeyRotationStatus response class.
• IKMSGetParametersForImportResponse — Interface for GetParametersForImport responses.
• TKMSGetParametersForImportResponse — GetParametersForImport response class.
• IKMSGetPublicKeyResponse — Interface for GetPublicKey responses.
• TKMSGetPublicKeyResponse — GetPublicKey response class.
• IKMSImportKeyMaterialResponse — Interface for ImportKeyMaterial responses.
• TKMSImportKeyMaterialResponse — ImportKeyMaterial response class.
• IKMSListAliasesResponse — Interface for ListAliases responses.
• TKMSListAliasesResponse — ListAliases response class.
• IKMSListGrantsResponse — Interface for ListGrants responses.
• TKMSListGrantsResponse — ListGrants response class.
• IKMSListKeyPoliciesResponse — Interface for ListKeyPolicies responses.
• TKMSListKeyPoliciesResponse — ListKeyPolicies response class.
• IKMSListKeysResponse — Interface for ListKeys responses.
• TKMSListKeysResponse — ListKeys response class.
• IKMSListResourceTagsResponse — Interface for ListResourceTags responses.
• TKMSListResourceTagsResponse — ListResourceTags response class.
• IKMSListRetirableGrantsResponse — Interface for ListRetirableGrants responses.
• TKMSListRetirableGrantsResponse — ListRetirableGrants response class.
• IKMSPutKeyPolicyResponse — Interface for PutKeyPolicy responses.
• TKMSPutKeyPolicyResponse — PutKeyPolicy response class.
• IKMSReEncryptResponse — Interface for ReEncrypt responses.
• TKMSReEncryptResponse — ReEncrypt response class.
• IKMSReplicateKeyResponse — Interface for ReplicateKey responses.
• TKMSReplicateKeyResponse — ReplicateKey response class.
• IKMSRetireGrantResponse — Interface for RetireGrant responses.
• TKMSRetireGrantResponse — RetireGrant response class.
• IKMSRevokeGrantResponse — Interface for RevokeGrant responses.
• TKMSRevokeGrantResponse — RevokeGrant response class.
• IKMSScheduleKeyDeletionResponse — Interface for ScheduleKeyDeletion responses.
• TKMSScheduleKeyDeletionResponse — ScheduleKeyDeletion response class.
• IKMSSignResponse — Interface for Sign responses.
• TKMSSignResponse — Sign response class.
• IKMSTagResourceResponse — Interface for TagResource responses.
• TKMSTagResourceResponse — TagResource response class.
• IKMSUntagResourceResponse — Interface for UntagResource responses.
• TKMSUntagResourceResponse — UntagResource response class.
• IKMSUpdateAliasResponse — Interface for UpdateAlias responses.
• TKMSUpdateAliasResponse — UpdateAlias response class.
• IKMSUpdateCustomKeyStoreResponse — Interface for UpdateCustomKeyStore responses.
• TKMSUpdateCustomKeyStoreResponse — UpdateCustomKeyStore response class.
• IKMSUpdateKeyDescriptionResponse — Interface for UpdateKeyDescription responses.
• TKMSUpdateKeyDescriptionResponse — UpdateKeyDescription response class.
• IKMSUpdatePrimaryRegionResponse — Interface for UpdatePrimaryRegion responses.
• TKMSUpdatePrimaryRegionResponse — UpdatePrimaryRegion response class.
• IKMSVerifyResponse — Interface for Verify responses.
• TKMSVerifyResponse — Verify response class.
• IKMSVerifyMacResponse — Interface for VerifyMac responses.
• TKMSVerifyMacResponse — VerifyMac response class.

Exceptions

• EKMSException — Base exception class for KMS operations.
• EKMSAlreadyExistsException — The request was rejected because it attempted to create a resource that already exists.
• EKMSCloudHsmClusterInUseException — The request was rejected because the specified AWS CloudHSM cluster is already associated with a custom keystore or it shares a backup history with a cluster that is associated with a custom key store.
• EKMSCloudHsmClusterInvalidConfigurationException — The request was rejected because the associated AWS CloudHSM cluster did not meet the configuration requirements for a custom key store.
• EKMSCloudHsmClusterNotActiveException — The request was rejected because the AWS CloudHSM cluster that is associated with the custom key store is not active.
• EKMSCloudHsmClusterNotFoundException — The request was rejected because the AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
• EKMSCloudHsmClusterNotRelatedException — The request was rejected because the specified AWS CloudHSM cluster has a different cluster certificate than the original cluster.
• EKMSCustomKeyStoreHasCMKsException — The request was rejected because the cistom key store contains KMS keys.
• EKMSCustomKeyStoreInvalidStateException — The request was rejected because of the ConnectionState of the custom key store.
• EKMSCustomKeyStoreNameInUseException — The request was rejected because the specified custom key store name is already assigned to another custom key store in the account.
• EKMSCustomKeyStoreNotFoundException — The request was rejected because AWS KMS cannot find a custom key store with the specified key store name or ID.
• EKMSDependencyTimeoutException — The system timed out while trying to fulfill the request.
• EKMSDisabledException — The request was rejected because the specified KMS key is not enabled.
• EKMSExpiredImportTokenException — The request was rejected because the specified import token is expired.
• EKMSIncorrectKeyException — The request was rejected because the specified KMS key cannot decrypt the data.
• EKMSIncorrectKeyMaterialException — The request was rejected because the key material in the request is, expired, invalid, or is not the same key material that was previously imported into this KMS key.
• EKMSIncorrectTrustAnchorException — The request was rejected because the trust anchor certificate in the request is not the trust anchor certificate for the specified AWS CloudHSM cluster.
• EKMSInternalException — The request was rejected because an internal exception occurred.
• EKMSInvalidMacException — The request was rejected because the HMAC verification failed.
• EKMSInvalidAliasNameException — The request was rejected because the specified alias name is not valid.
• EKMSInvalidArnException — The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
• EKMSInvalidCiphertextException — 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.
• EKMSInvalidGrantIdException — The request was rejected because the specified GrantId is not valid.
• EKMSInvalidGrantTokenException — The request was rejected because the specified grant token is not valid.
• EKMSInvalidImportTokenException — The request was rejected because the provided import token is invalid or is associated with a different KMS key.
• EKMSInvalidKeyUsageException — The request was rejected either because the KeyUsage value of the KMS key is incompatible, or the encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material.
• EKMSInvalidMarkerException — The request was rejected because the marker that specifies where pagination should begin is not valid.
• EKMSKMSInvalidSignatureException — The request was rejected because the signature verification failed.
• EKMSInvalidStateException — The request was rejected because the state of the specified resources is not valid for this request.
• EKMSKeyUnavailableException — The request was rejected because the specified KMS key was not available.
• EKMSLimitExceededException — The request was rejected because a quota was exceeded.
• EKMSMalformedPolicyDocumentException — The request was rejected because the specified policy is not syntactically or semantically correct.
• EKMSNotFoundException — The request was rejected because the specified entity or resource was not found.
• EKMSTagException — The request was rejected because one or more tags are not valid.
• EKMSUnsupportedOperationException — The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
• EKMSXksKeyAlreadyInUseException — The request was rejected because the XksKeyId is already associated with a KMS key in this external key store.
• EKMSXksKeyInvalidConfigurationException — The request was rejected because the external key specified by the XksKeyId parameter did not meet the configuration requirements for an external key store.
• EKMSXksKeyNotFoundException — The request was rejected because the external key store proxy could not find the external key.
• EKMSXksProxyIncorrectAuthenticationCredentialException — The request was rejected because the proxy credentials failed to authenticate to the specified external key store proxy.
• EKMSXksProxyInvalidConfigurationException — The request was rejected because the Amazon VPC endpoint service configuration does not fulfill the requirements for an external key store proxy.
• EKMSXksProxyInvalidResponseException — AWS KMS cannot interpret the response it received from the external key store proxy.
• EKMSXksProxyUriEndpointInUseException — The request was rejected because the concatenation of the XksProxyUriEndpoint is already associated with an external key store in the AWS account and region.
• EKMSXksProxyUriInUseException — The request was rejected because the concatenation of the XksProxyUriEndpoint and XksProxyUriPath is already associated with an external key store in the AWS account and region.
• EKMSXksProxyUriUnreachableException — AWS KMS was unable to reach the specified XksProxyUriPath.
• EKMSXksProxyVpcEndpointServiceInUseException — The request was rejected becase the specified Amazon VPC endpoint service is already associated with an external key store in the AWS account and region.
• EKMSXksProxyVpcEndpointServiceInvalidConfigurationException — The request was rejected because AWS KMS could not find the specified VPC endpoint service configuration does not fulfill the requirements for an external key store proxy.
• EKMSXksProxyVpcEndpointServiceNotFoundException — The request was rejected because AWS KMS could not find the specified VPC endpoint service.

Type Aliases

• TKMSResponseClass = class of TKMSResponse; — Meta-class for Key Management Service (KMS) responses.