Enum aws_sdk_kms::operation::create_key::CreateKeyError
source · #[non_exhaustive]pub enum CreateKeyError {
Show 14 variants
CloudHsmClusterInvalidConfigurationException(CloudHsmClusterInvalidConfigurationException),
CustomKeyStoreInvalidStateException(CustomKeyStoreInvalidStateException),
CustomKeyStoreNotFoundException(CustomKeyStoreNotFoundException),
DependencyTimeoutException(DependencyTimeoutException),
InvalidArnException(InvalidArnException),
KmsInternalException(KmsInternalException),
LimitExceededException(LimitExceededException),
MalformedPolicyDocumentException(MalformedPolicyDocumentException),
TagException(TagException),
UnsupportedOperationException(UnsupportedOperationException),
XksKeyAlreadyInUseException(XksKeyAlreadyInUseException),
XksKeyInvalidConfigurationException(XksKeyInvalidConfigurationException),
XksKeyNotFoundException(XksKeyNotFoundException),
Unhandled(Unhandled),
}
Expand description
Error type for the CreateKeyError
operation.
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
CloudHsmClusterInvalidConfigurationException(CloudHsmClusterInvalidConfigurationException)
The request was rejected because the associated CloudHSM cluster did not meet the configuration requirements for an CloudHSM key store.
-
The CloudHSM cluster must be configured with private subnets in at least two different Availability Zones in the Region.
-
The security group for the cluster (cloudhsm-cluster-
-sg) must include inbound rules and outbound rules that allow TCP traffic on ports 2223-2225. The Source in the inbound rules and the Destination in the outbound rules must match the security group ID. These rules are set by default when you create the CloudHSM cluster. Do not delete or change them. To get information about a particular security group, use the DescribeSecurityGroups operation. -
The CloudHSM cluster must contain at least as many HSMs as the operation requires. To add HSMs, use the CloudHSM CreateHsm operation.
For the
CreateCustomKeyStore
,UpdateCustomKeyStore
, andCreateKey
operations, the CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For theConnectCustomKeyStore
operation, the CloudHSM must contain at least one active HSM.
For information about the requirements for an CloudHSM cluster that is associated with an CloudHSM key store, see Assemble the Prerequisites in the Key Management Service Developer Guide. For information about creating a private subnet for an CloudHSM cluster, see Create a Private Subnet in the CloudHSM User Guide. For information about cluster security groups, see Configure a Default Security Group in the CloudHSM User Guide .
CustomKeyStoreInvalidStateException(CustomKeyStoreInvalidStateException)
The request was rejected because of the ConnectionState
of the custom key store. To get the ConnectionState
of a custom key store, use the DescribeCustomKeyStores
operation.
This exception is thrown under the following conditions:
-
You requested the
ConnectCustomKeyStore
operation on a custom key store with aConnectionState
ofDISCONNECTING
orFAILED
. This operation is valid for all otherConnectionState
values. To reconnect a custom key store in aFAILED
state, disconnect it (DisconnectCustomKeyStore
), then connect it (ConnectCustomKeyStore
). -
You requested the
CreateKey
operation in a custom key store that is not connected. This operations is valid only when the custom key storeConnectionState
isCONNECTED
. -
You requested the
DisconnectCustomKeyStore
operation on a custom key store with aConnectionState
ofDISCONNECTING
orDISCONNECTED
. This operation is valid for all otherConnectionState
values. -
You requested the
UpdateCustomKeyStore
orDeleteCustomKeyStore
operation on a custom key store that is not disconnected. This operation is valid only when the custom key storeConnectionState
isDISCONNECTED
. -
You requested the
GenerateRandom
operation in an CloudHSM key store that is not connected. This operation is valid only when the CloudHSM key storeConnectionState
isCONNECTED
.
CustomKeyStoreNotFoundException(CustomKeyStoreNotFoundException)
The request was rejected because KMS cannot find a custom key store with the specified key store name or ID.
DependencyTimeoutException(DependencyTimeoutException)
The system timed out while trying to fulfill the request. You can retry the request.
InvalidArnException(InvalidArnException)
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
KmsInternalException(KmsInternalException)
The request was rejected because an internal exception occurred. The request can be retried.
LimitExceededException(LimitExceededException)
The request was rejected because a quota was exceeded. For more information, see Quotas in the Key Management Service Developer Guide.
MalformedPolicyDocumentException(MalformedPolicyDocumentException)
The request was rejected because the specified policy is not syntactically or semantically correct.
TagException(TagException)
The request was rejected because one or more tags are not valid.
UnsupportedOperationException(UnsupportedOperationException)
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
XksKeyAlreadyInUseException(XksKeyAlreadyInUseException)
The request was rejected because the (XksKeyId
) is already associated with another KMS key in this external key store. Each KMS key in an external key store must be associated with a different external key.
XksKeyInvalidConfigurationException(XksKeyInvalidConfigurationException)
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 external key must be an AES-256 symmetric key that is enabled and performs encryption and decryption.
XksKeyNotFoundException(XksKeyNotFoundException)
The request was rejected because the external key store proxy could not find the external key. This exception is thrown when the value of the XksKeyId
parameter doesn't identify a key in the external key manager associated with the external key proxy.
Verify that the XksKeyId
represents an existing key in the external key manager. Use the key identifier that the external key store proxy uses to identify the key. For details, see the documentation provided with your external key store proxy or key manager.
Unhandled(Unhandled)
Unhandled
directly is not forwards compatible. Instead, match using a variable wildcard pattern and check .code()
:
err if err.code() == Some("SpecificExceptionCode") => { /* handle the error */ }
See ProvideErrorMetadata
for what information is available for the error.An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
Implementations§
source§impl CreateKeyError
impl CreateKeyError
sourcepub fn unhandled(err: impl Into<Box<dyn Error + Send + Sync + 'static>>) -> Self
pub fn unhandled(err: impl Into<Box<dyn Error + Send + Sync + 'static>>) -> Self
Creates the CreateKeyError::Unhandled
variant from any error type.
sourcepub fn generic(err: ErrorMetadata) -> Self
pub fn generic(err: ErrorMetadata) -> Self
Creates the CreateKeyError::Unhandled
variant from an ErrorMetadata
.
sourcepub fn meta(&self) -> &ErrorMetadata
pub fn meta(&self) -> &ErrorMetadata
Returns error metadata, which includes the error code, message, request ID, and potentially additional information.
sourcepub fn is_cloud_hsm_cluster_invalid_configuration_exception(&self) -> bool
pub fn is_cloud_hsm_cluster_invalid_configuration_exception(&self) -> bool
Returns true
if the error kind is CreateKeyError::CloudHsmClusterInvalidConfigurationException
.
sourcepub fn is_custom_key_store_invalid_state_exception(&self) -> bool
pub fn is_custom_key_store_invalid_state_exception(&self) -> bool
Returns true
if the error kind is CreateKeyError::CustomKeyStoreInvalidStateException
.
sourcepub fn is_custom_key_store_not_found_exception(&self) -> bool
pub fn is_custom_key_store_not_found_exception(&self) -> bool
Returns true
if the error kind is CreateKeyError::CustomKeyStoreNotFoundException
.
sourcepub fn is_dependency_timeout_exception(&self) -> bool
pub fn is_dependency_timeout_exception(&self) -> bool
Returns true
if the error kind is CreateKeyError::DependencyTimeoutException
.
sourcepub fn is_invalid_arn_exception(&self) -> bool
pub fn is_invalid_arn_exception(&self) -> bool
Returns true
if the error kind is CreateKeyError::InvalidArnException
.
sourcepub fn is_kms_internal_exception(&self) -> bool
pub fn is_kms_internal_exception(&self) -> bool
Returns true
if the error kind is CreateKeyError::KmsInternalException
.
sourcepub fn is_limit_exceeded_exception(&self) -> bool
pub fn is_limit_exceeded_exception(&self) -> bool
Returns true
if the error kind is CreateKeyError::LimitExceededException
.
sourcepub fn is_malformed_policy_document_exception(&self) -> bool
pub fn is_malformed_policy_document_exception(&self) -> bool
Returns true
if the error kind is CreateKeyError::MalformedPolicyDocumentException
.
sourcepub fn is_tag_exception(&self) -> bool
pub fn is_tag_exception(&self) -> bool
Returns true
if the error kind is CreateKeyError::TagException
.
sourcepub fn is_unsupported_operation_exception(&self) -> bool
pub fn is_unsupported_operation_exception(&self) -> bool
Returns true
if the error kind is CreateKeyError::UnsupportedOperationException
.
sourcepub fn is_xks_key_already_in_use_exception(&self) -> bool
pub fn is_xks_key_already_in_use_exception(&self) -> bool
Returns true
if the error kind is CreateKeyError::XksKeyAlreadyInUseException
.
sourcepub fn is_xks_key_invalid_configuration_exception(&self) -> bool
pub fn is_xks_key_invalid_configuration_exception(&self) -> bool
Returns true
if the error kind is CreateKeyError::XksKeyInvalidConfigurationException
.
sourcepub fn is_xks_key_not_found_exception(&self) -> bool
pub fn is_xks_key_not_found_exception(&self) -> bool
Returns true
if the error kind is CreateKeyError::XksKeyNotFoundException
.
Trait Implementations§
source§impl CreateUnhandledError for CreateKeyError
impl CreateUnhandledError for CreateKeyError
source§fn create_unhandled_error(
source: Box<dyn Error + Send + Sync + 'static>,
meta: Option<ErrorMetadata>
) -> Self
fn create_unhandled_error( source: Box<dyn Error + Send + Sync + 'static>, meta: Option<ErrorMetadata> ) -> Self
source
and error metadata.source§impl Debug for CreateKeyError
impl Debug for CreateKeyError
source§impl Display for CreateKeyError
impl Display for CreateKeyError
source§impl Error for CreateKeyError
impl Error for CreateKeyError
source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
1.0.0 · source§fn description(&self) -> &str
fn description(&self) -> &str
source§impl From<CreateKeyError> for Error
impl From<CreateKeyError> for Error
source§fn from(err: CreateKeyError) -> Self
fn from(err: CreateKeyError) -> Self
source§impl ProvideErrorKind for CreateKeyError
impl ProvideErrorKind for CreateKeyError
source§impl ProvideErrorMetadata for CreateKeyError
impl ProvideErrorMetadata for CreateKeyError
source§fn meta(&self) -> &ErrorMetadata
fn meta(&self) -> &ErrorMetadata
source§impl RequestId for CreateKeyError
impl RequestId for CreateKeyError
source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.