# Packages
Package kmsiface provides an interface to enable mocking the AWS Key Management Service service client for testing your code.
# Functions
AlgorithmSpec_Values returns all elements of the AlgorithmSpec enum.
ConnectionErrorCodeType_Values returns all elements of the ConnectionErrorCodeType enum.
ConnectionStateType_Values returns all elements of the ConnectionStateType enum.
CustomerMasterKeySpec_Values returns all elements of the CustomerMasterKeySpec enum.
CustomKeyStoreType_Values returns all elements of the CustomKeyStoreType enum.
DataKeyPairSpec_Values returns all elements of the DataKeyPairSpec enum.
DataKeySpec_Values returns all elements of the DataKeySpec enum.
EncryptionAlgorithmSpec_Values returns all elements of the EncryptionAlgorithmSpec enum.
ExpirationModelType_Values returns all elements of the ExpirationModelType enum.
GrantOperation_Values returns all elements of the GrantOperation enum.
KeyAgreementAlgorithmSpec_Values returns all elements of the KeyAgreementAlgorithmSpec enum.
KeyEncryptionMechanism_Values returns all elements of the KeyEncryptionMechanism enum.
KeyManagerType_Values returns all elements of the KeyManagerType enum.
KeySpec_Values returns all elements of the KeySpec enum.
KeyState_Values returns all elements of the KeyState enum.
KeyUsageType_Values returns all elements of the KeyUsageType enum.
MacAlgorithmSpec_Values returns all elements of the MacAlgorithmSpec enum.
MessageType_Values returns all elements of the MessageType enum.
MultiRegionKeyType_Values returns all elements of the MultiRegionKeyType enum.
New creates a new instance of the KMS client with a session.
OriginType_Values returns all elements of the OriginType enum.
RotationType_Values returns all elements of the RotationType enum.
SigningAlgorithmSpec_Values returns all elements of the SigningAlgorithmSpec enum.
WrappingKeySpec_Values returns all elements of the WrappingKeySpec enum.
XksProxyConnectivityType_Values returns all elements of the XksProxyConnectivityType enum.
# Constants
AlgorithmSpecRsaAesKeyWrapSha1 is a AlgorithmSpec enum value.
AlgorithmSpecRsaAesKeyWrapSha256 is a AlgorithmSpec enum value.
AlgorithmSpecRsaesOaepSha1 is a AlgorithmSpec enum value.
AlgorithmSpecRsaesOaepSha256 is a AlgorithmSpec enum value.
AlgorithmSpecRsaesPkcs1V15 is a AlgorithmSpec enum value.
AlgorithmSpecSm2pke is a AlgorithmSpec enum value.
ConnectionErrorCodeTypeClusterNotFound is a ConnectionErrorCodeType enum value.
ConnectionErrorCodeTypeInsufficientCloudhsmHsms is a ConnectionErrorCodeType enum value.
ConnectionErrorCodeTypeInsufficientFreeAddressesInSubnet is a ConnectionErrorCodeType enum value.
ConnectionErrorCodeTypeInternalError is a ConnectionErrorCodeType enum value.
ConnectionErrorCodeTypeInvalidCredentials is a ConnectionErrorCodeType enum value.
ConnectionErrorCodeTypeNetworkErrors is a ConnectionErrorCodeType enum value.
ConnectionErrorCodeTypeSubnetNotFound is a ConnectionErrorCodeType enum value.
ConnectionErrorCodeTypeUserLockedOut is a ConnectionErrorCodeType enum value.
ConnectionErrorCodeTypeUserLoggedIn is a ConnectionErrorCodeType enum value.
ConnectionErrorCodeTypeUserNotFound is a ConnectionErrorCodeType enum value.
ConnectionErrorCodeTypeXksProxyAccessDenied is a ConnectionErrorCodeType enum value.
ConnectionErrorCodeTypeXksProxyInvalidConfiguration is a ConnectionErrorCodeType enum value.
ConnectionErrorCodeTypeXksProxyInvalidResponse is a ConnectionErrorCodeType enum value.
ConnectionErrorCodeTypeXksProxyInvalidTlsConfiguration is a ConnectionErrorCodeType enum value.
ConnectionErrorCodeTypeXksProxyNotReachable is a ConnectionErrorCodeType enum value.
ConnectionErrorCodeTypeXksProxyTimedOut is a ConnectionErrorCodeType enum value.
ConnectionErrorCodeTypeXksVpcEndpointServiceInvalidConfiguration is a ConnectionErrorCodeType enum value.
ConnectionErrorCodeTypeXksVpcEndpointServiceNotFound is a ConnectionErrorCodeType enum value.
ConnectionStateTypeConnected is a ConnectionStateType enum value.
ConnectionStateTypeConnecting is a ConnectionStateType enum value.
ConnectionStateTypeDisconnected is a ConnectionStateType enum value.
ConnectionStateTypeDisconnecting is a ConnectionStateType enum value.
ConnectionStateTypeFailed is a ConnectionStateType enum value.
CustomerMasterKeySpecEccNistP256 is a CustomerMasterKeySpec enum value.
CustomerMasterKeySpecEccNistP384 is a CustomerMasterKeySpec enum value.
CustomerMasterKeySpecEccNistP521 is a CustomerMasterKeySpec enum value.
CustomerMasterKeySpecEccSecgP256k1 is a CustomerMasterKeySpec enum value.
CustomerMasterKeySpecHmac224 is a CustomerMasterKeySpec enum value.
CustomerMasterKeySpecHmac256 is a CustomerMasterKeySpec enum value.
CustomerMasterKeySpecHmac384 is a CustomerMasterKeySpec enum value.
CustomerMasterKeySpecHmac512 is a CustomerMasterKeySpec enum value.
CustomerMasterKeySpecRsa2048 is a CustomerMasterKeySpec enum value.
CustomerMasterKeySpecRsa3072 is a CustomerMasterKeySpec enum value.
CustomerMasterKeySpecRsa4096 is a CustomerMasterKeySpec enum value.
CustomerMasterKeySpecSm2 is a CustomerMasterKeySpec enum value.
CustomerMasterKeySpecSymmetricDefault is a CustomerMasterKeySpec enum value.
CustomKeyStoreTypeAwsCloudhsm is a CustomKeyStoreType enum value.
CustomKeyStoreTypeExternalKeyStore is a CustomKeyStoreType enum value.
DataKeyPairSpecEccNistP256 is a DataKeyPairSpec enum value.
DataKeyPairSpecEccNistP384 is a DataKeyPairSpec enum value.
DataKeyPairSpecEccNistP521 is a DataKeyPairSpec enum value.
DataKeyPairSpecEccSecgP256k1 is a DataKeyPairSpec enum value.
DataKeyPairSpecRsa2048 is a DataKeyPairSpec enum value.
DataKeyPairSpecRsa3072 is a DataKeyPairSpec enum value.
DataKeyPairSpecRsa4096 is a DataKeyPairSpec enum value.
DataKeyPairSpecSm2 is a DataKeyPairSpec enum value.
DataKeySpecAes128 is a DataKeySpec enum value.
DataKeySpecAes256 is a DataKeySpec enum value.
EncryptionAlgorithmSpecRsaesOaepSha1 is a EncryptionAlgorithmSpec enum value.
EncryptionAlgorithmSpecRsaesOaepSha256 is a EncryptionAlgorithmSpec enum value.
EncryptionAlgorithmSpecSm2pke is a EncryptionAlgorithmSpec enum value.
EncryptionAlgorithmSpecSymmetricDefault is a EncryptionAlgorithmSpec enum value.
ID to lookup a service endpoint with.
ErrCodeAlreadyExistsException for service response error code "AlreadyExistsException".
ErrCodeCloudHsmClusterInUseException for service response error code "CloudHsmClusterInUseException".
ErrCodeCloudHsmClusterInvalidConfigurationException for service response error code "CloudHsmClusterInvalidConfigurationException".
ErrCodeCloudHsmClusterNotActiveException for service response error code "CloudHsmClusterNotActiveException".
ErrCodeCloudHsmClusterNotFoundException for service response error code "CloudHsmClusterNotFoundException".
ErrCodeCloudHsmClusterNotRelatedException for service response error code "CloudHsmClusterNotRelatedException".
ErrCodeConflictException for service response error code "ConflictException".
ErrCodeCustomKeyStoreHasCMKsException for service response error code "CustomKeyStoreHasCMKsException".
ErrCodeCustomKeyStoreInvalidStateException for service response error code "CustomKeyStoreInvalidStateException".
ErrCodeCustomKeyStoreNameInUseException for service response error code "CustomKeyStoreNameInUseException".
ErrCodeCustomKeyStoreNotFoundException for service response error code "CustomKeyStoreNotFoundException".
ErrCodeDependencyTimeoutException for service response error code "DependencyTimeoutException".
ErrCodeDisabledException for service response error code "DisabledException".
ErrCodeDryRunOperationException for service response error code "DryRunOperationException".
ErrCodeExpiredImportTokenException for service response error code "ExpiredImportTokenException".
ErrCodeIncorrectKeyException for service response error code "IncorrectKeyException".
ErrCodeIncorrectKeyMaterialException for service response error code "IncorrectKeyMaterialException".
ErrCodeIncorrectTrustAnchorException for service response error code "IncorrectTrustAnchorException".
ErrCodeInternalException for service response error code "KMSInternalException".
ErrCodeInvalidAliasNameException for service response error code "InvalidAliasNameException".
ErrCodeInvalidArnException for service response error code "InvalidArnException".
ErrCodeInvalidCiphertextException for service response error code "InvalidCiphertextException".
ErrCodeInvalidGrantIdException for service response error code "InvalidGrantIdException".
ErrCodeInvalidGrantTokenException for service response error code "InvalidGrantTokenException".
ErrCodeInvalidImportTokenException for service response error code "InvalidImportTokenException".
ErrCodeInvalidKeyUsageException for service response error code "InvalidKeyUsageException".
ErrCodeInvalidMarkerException for service response error code "InvalidMarkerException".
ErrCodeInvalidStateException for service response error code "KMSInvalidStateException".
ErrCodeKeyUnavailableException for service response error code "KeyUnavailableException".
ErrCodeKMSInvalidMacException for service response error code "KMSInvalidMacException".
ErrCodeKMSInvalidSignatureException for service response error code "KMSInvalidSignatureException".
ErrCodeLimitExceededException for service response error code "LimitExceededException".
ErrCodeMalformedPolicyDocumentException for service response error code "MalformedPolicyDocumentException".
ErrCodeNotFoundException for service response error code "NotFoundException".
ErrCodeTagException for service response error code "TagException".
ErrCodeUnsupportedOperationException for service response error code "UnsupportedOperationException".
ErrCodeXksKeyAlreadyInUseException for service response error code "XksKeyAlreadyInUseException".
ErrCodeXksKeyInvalidConfigurationException for service response error code "XksKeyInvalidConfigurationException".
ErrCodeXksKeyNotFoundException for service response error code "XksKeyNotFoundException".
ErrCodeXksProxyIncorrectAuthenticationCredentialException for service response error code "XksProxyIncorrectAuthenticationCredentialException".
ErrCodeXksProxyInvalidConfigurationException for service response error code "XksProxyInvalidConfigurationException".
ErrCodeXksProxyInvalidResponseException for service response error code "XksProxyInvalidResponseException".
ErrCodeXksProxyUriEndpointInUseException for service response error code "XksProxyUriEndpointInUseException".
ErrCodeXksProxyUriInUseException for service response error code "XksProxyUriInUseException".
ErrCodeXksProxyUriUnreachableException for service response error code "XksProxyUriUnreachableException".
ErrCodeXksProxyVpcEndpointServiceInUseException for service response error code "XksProxyVpcEndpointServiceInUseException".
ErrCodeXksProxyVpcEndpointServiceInvalidConfigurationException for service response error code "XksProxyVpcEndpointServiceInvalidConfigurationException".
ErrCodeXksProxyVpcEndpointServiceNotFoundException for service response error code "XksProxyVpcEndpointServiceNotFoundException".
ExpirationModelTypeKeyMaterialDoesNotExpire is a ExpirationModelType enum value.
ExpirationModelTypeKeyMaterialExpires is a ExpirationModelType enum value.
GrantOperationCreateGrant is a GrantOperation enum value.
GrantOperationDecrypt is a GrantOperation enum value.
GrantOperationDeriveSharedSecret is a GrantOperation enum value.
GrantOperationDescribeKey is a GrantOperation enum value.
GrantOperationEncrypt is a GrantOperation enum value.
GrantOperationGenerateDataKey is a GrantOperation enum value.
GrantOperationGenerateDataKeyPair is a GrantOperation enum value.
GrantOperationGenerateDataKeyPairWithoutPlaintext is a GrantOperation enum value.
GrantOperationGenerateDataKeyWithoutPlaintext is a GrantOperation enum value.
GrantOperationGenerateMac is a GrantOperation enum value.
GrantOperationGetPublicKey is a GrantOperation enum value.
GrantOperationReEncryptFrom is a GrantOperation enum value.
GrantOperationReEncryptTo is a GrantOperation enum value.
GrantOperationRetireGrant is a GrantOperation enum value.
GrantOperationSign is a GrantOperation enum value.
GrantOperationVerify is a GrantOperation enum value.
GrantOperationVerifyMac is a GrantOperation enum value.
KeyAgreementAlgorithmSpecEcdh is a KeyAgreementAlgorithmSpec enum value.
KeyEncryptionMechanismRsaesOaepSha256 is a KeyEncryptionMechanism enum value.
KeyManagerTypeAws is a KeyManagerType enum value.
KeyManagerTypeCustomer is a KeyManagerType enum value.
KeySpecEccNistP256 is a KeySpec enum value.
KeySpecEccNistP384 is a KeySpec enum value.
KeySpecEccNistP521 is a KeySpec enum value.
KeySpecEccSecgP256k1 is a KeySpec enum value.
KeySpecHmac224 is a KeySpec enum value.
KeySpecHmac256 is a KeySpec enum value.
KeySpecHmac384 is a KeySpec enum value.
KeySpecHmac512 is a KeySpec enum value.
KeySpecRsa2048 is a KeySpec enum value.
KeySpecRsa3072 is a KeySpec enum value.
KeySpecRsa4096 is a KeySpec enum value.
KeySpecSm2 is a KeySpec enum value.
KeySpecSymmetricDefault is a KeySpec enum value.
KeyStateCreating is a KeyState enum value.
KeyStateDisabled is a KeyState enum value.
KeyStateEnabled is a KeyState enum value.
KeyStatePendingDeletion is a KeyState enum value.
KeyStatePendingImport is a KeyState enum value.
KeyStatePendingReplicaDeletion is a KeyState enum value.
KeyStateUnavailable is a KeyState enum value.
KeyStateUpdating is a KeyState enum value.
KeyUsageTypeEncryptDecrypt is a KeyUsageType enum value.
KeyUsageTypeGenerateVerifyMac is a KeyUsageType enum value.
KeyUsageTypeKeyAgreement is a KeyUsageType enum value.
KeyUsageTypeSignVerify is a KeyUsageType enum value.
MacAlgorithmSpecHmacSha224 is a MacAlgorithmSpec enum value.
MacAlgorithmSpecHmacSha256 is a MacAlgorithmSpec enum value.
MacAlgorithmSpecHmacSha384 is a MacAlgorithmSpec enum value.
MacAlgorithmSpecHmacSha512 is a MacAlgorithmSpec enum value.
MessageTypeDigest is a MessageType enum value.
MessageTypeRaw is a MessageType enum value.
MultiRegionKeyTypePrimary is a MultiRegionKeyType enum value.
MultiRegionKeyTypeReplica is a MultiRegionKeyType enum value.
OriginTypeAwsCloudhsm is a OriginType enum value.
OriginTypeAwsKms is a OriginType enum value.
OriginTypeExternal is a OriginType enum value.
OriginTypeExternalKeyStore is a OriginType enum value.
RotationTypeAutomatic is a RotationType enum value.
RotationTypeOnDemand is a RotationType enum value.
ServiceID is a unique identifier of a specific service.
Name of service.
SigningAlgorithmSpecEcdsaSha256 is a SigningAlgorithmSpec enum value.
SigningAlgorithmSpecEcdsaSha384 is a SigningAlgorithmSpec enum value.
SigningAlgorithmSpecEcdsaSha512 is a SigningAlgorithmSpec enum value.
SigningAlgorithmSpecRsassaPkcs1V15Sha256 is a SigningAlgorithmSpec enum value.
SigningAlgorithmSpecRsassaPkcs1V15Sha384 is a SigningAlgorithmSpec enum value.
SigningAlgorithmSpecRsassaPkcs1V15Sha512 is a SigningAlgorithmSpec enum value.
SigningAlgorithmSpecRsassaPssSha256 is a SigningAlgorithmSpec enum value.
SigningAlgorithmSpecRsassaPssSha384 is a SigningAlgorithmSpec enum value.
SigningAlgorithmSpecRsassaPssSha512 is a SigningAlgorithmSpec enum value.
SigningAlgorithmSpecSm2dsa is a SigningAlgorithmSpec enum value.
WrappingKeySpecRsa2048 is a WrappingKeySpec enum value.
WrappingKeySpecRsa3072 is a WrappingKeySpec enum value.
WrappingKeySpecRsa4096 is a WrappingKeySpec enum value.
WrappingKeySpecSm2 is a WrappingKeySpec enum value.
XksProxyConnectivityTypePublicEndpoint is a XksProxyConnectivityType enum value.
XksProxyConnectivityTypeVpcEndpointService is a XksProxyConnectivityType enum value.
# Structs
Contains information about an alias.
The request was rejected because it attempted to create a resource that already exists.
The request was rejected because the specified CloudHSM cluster is already associated with an CloudHSM key store in the account, or it shares a backup history with an CloudHSM key store in the account.
The request was rejected because the associated CloudHSM cluster did not meet the configuration requirements for an CloudHSM key store.
The request was rejected because the CloudHSM cluster associated with the CloudHSM key store is not active.
The request was rejected because KMS cannot find the CloudHSM cluster with the specified cluster ID.
The request was rejected because the specified CloudHSM cluster has a different cluster certificate than the original cluster.
The request was rejected because an automatic rotation of this key is currently in progress or scheduled to begin within the next 20 minutes.
The request was rejected because the custom key store contains KMS keys.
The request was rejected because of the ConnectionState of the custom key store.
The request was rejected because the specified custom key store name is already assigned to another custom key store in the account.
The request was rejected because KMS cannot find a custom key store with the specified key store name or ID.
Contains information about each custom key store in the custom key store list.
The system timed out while trying to fulfill the request.
The request was rejected because the specified KMS key is not enabled.
The request was rejected because the DryRun parameter was specified.
The request was rejected because the specified import token is expired.
Use this structure to allow cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) in the grant only when the operation request includes the specified encryption context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context).
Contains information about a grant.
The request was rejected because the specified KMS key cannot decrypt the data.
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.
The request was rejected because the trust anchor certificate in the request to create an CloudHSM key store is not the trust anchor certificate for the specified CloudHSM cluster.
The request was rejected because an internal exception occurred.
The request was rejected because the specified alias name is not valid.
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
From the Decrypt or ReEncrypt operation, 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.
The request was rejected because the specified GrantId is not valid.
The request was rejected because the specified grant token is not valid.
The request was rejected because the provided import token is invalid or is associated with a different KMS key.
The request was rejected for one of the following reasons:
- The KeyUsage value of the KMS key is incompatible with the API operation.
The request was rejected because the marker that specifies where pagination should next begin is not valid.
The request was rejected because the state of the specified resource is not valid for this request.
Contains information about each entry in the key list.
Contains metadata about a KMS key.
The request was rejected because the specified KMS key was not available.
KMS provides the API operation methods for making requests to AWS Key Management Service.
The request was rejected because the HMAC verification failed.
The request was rejected because the signature verification failed.
The request was rejected because a quota was exceeded.
The request was rejected because the specified policy is not syntactically or semantically correct.
Describes the configuration of this multi-Region key.
Describes the primary or replica key in a multi-Region key.
The request was rejected because the specified entity or resource could not be found.
Contains information about the party that receives the response from the API operation.
Contains information about completed key material rotations.
A key-value pair.
The request was rejected because one or more tags are not valid.
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
The request was rejected because the (XksKeyId) is already associated with another KMS key in this external key store.
Information about the external key (https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key)that is associated with a KMS key in an external key store.
The request was rejected because the external key specified by the XksKeyId parameter did not meet the configuration requirements for an external key store.
The request was rejected because the external key store proxy could not find the external key.
KMS uses the authentication credential to sign requests that it sends to the external key store proxy (XKS proxy) on your behalf.
Detailed information about the external key store proxy (XKS proxy).
The request was rejected because the proxy credentials failed to authenticate to the specified external key store proxy.
The request was rejected because the external key store proxy is not configured correctly.
KMS cannot interpret the response it received from the external key store proxy.
The request was rejected because the XksProxyUriEndpoint is already associated with another external key store in this Amazon Web Services Region.
The request was rejected because the concatenation of the XksProxyUriEndpoint and XksProxyUriPath is already associated with another external key store in this Amazon Web Services Region.
KMS was unable to reach the specified XksProxyUriPath.
The request was rejected because the specified Amazon VPC endpoint service is already associated with another external key store in this Amazon Web Services Region.
The request was rejected because the Amazon VPC endpoint service configuration does not fulfill the requirements for an external key store.
The request was rejected because KMS could not find the specified VPC endpoint service.