Enum UpdateCustomKeyStoreError

#[non_exhaustive]
pub enum UpdateCustomKeyStoreError {
    CloudHsmClusterInvalidConfigurationException(CloudHsmClusterInvalidConfigurationException),
    CloudHsmClusterNotActiveException(CloudHsmClusterNotActiveException),
    CloudHsmClusterNotFoundException(CloudHsmClusterNotFoundException),
    CloudHsmClusterNotRelatedException(CloudHsmClusterNotRelatedException),
    CustomKeyStoreInvalidStateException(CustomKeyStoreInvalidStateException),
    CustomKeyStoreNameInUseException(CustomKeyStoreNameInUseException),
    CustomKeyStoreNotFoundException(CustomKeyStoreNotFoundException),
    KmsInternalException(KmsInternalException),
    XksProxyIncorrectAuthenticationCredentialException(XksProxyIncorrectAuthenticationCredentialException),
    XksProxyInvalidConfigurationException(XksProxyInvalidConfigurationException),
    XksProxyInvalidResponseException(XksProxyInvalidResponseException),
    XksProxyUriEndpointInUseException(XksProxyUriEndpointInUseException),
    XksProxyUriInUseException(XksProxyUriInUseException),
    XksProxyUriUnreachableException(XksProxyUriUnreachableException),
    XksProxyVpcEndpointServiceInUseException(XksProxyVpcEndpointServiceInUseException),
    XksProxyVpcEndpointServiceInvalidConfigurationException(XksProxyVpcEndpointServiceInvalidConfigurationException),
    XksProxyVpcEndpointServiceNotFoundException(XksProxyVpcEndpointServiceNotFoundException),
    Unhandled(Unhandled),
}

Error type for the UpdateCustomKeyStoreError operation.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

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, and CreateKey operations, the CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the ConnectCustomKeyStore 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 .

CloudHsmClusterNotActiveException(CloudHsmClusterNotActiveException)

The request was rejected because the CloudHSM cluster associated with the CloudHSM key store is not active. Initialize and activate the cluster and try the command again. For detailed instructions, see Getting Started in the CloudHSM User Guide.

CloudHsmClusterNotFoundException(CloudHsmClusterNotFoundException)

The request was rejected because KMS cannot find the CloudHSM cluster with the specified cluster ID. Retry the request with a different cluster ID.

CloudHsmClusterNotRelatedException(CloudHsmClusterNotRelatedException)

The request was rejected because the specified CloudHSM cluster has a different cluster certificate than the original cluster. You cannot use the operation to specify an unrelated cluster for an CloudHSM key store.

Specify an CloudHSM cluster that shares a backup history with the original cluster. This includes clusters that were created from a backup of the current cluster, and clusters that were created from the same backup that produced the current cluster.

CloudHSM clusters that share a backup history have the same cluster certificate. To view the cluster certificate of an CloudHSM cluster, use the DescribeClusters operation.

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 a ConnectionState of DISCONNECTING or FAILED. This operation is valid for all other ConnectionState values. To reconnect a custom key store in a FAILED 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 store ConnectionState is CONNECTED.

• You requested the DisconnectCustomKeyStore operation on a custom key store with a ConnectionState of DISCONNECTING or DISCONNECTED. This operation is valid for all other ConnectionState values.

• You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on a custom key store that is not disconnected. This operation is valid only when the custom key store ConnectionState is DISCONNECTED.

• You requested the GenerateRandom operation in an CloudHSM key store that is not connected. This operation is valid only when the CloudHSM key store ConnectionState is CONNECTED.

CustomKeyStoreNameInUseException(CustomKeyStoreNameInUseException)

The request was rejected because the specified custom key store name is already assigned to another custom key store in the account. Try again with a custom key store name that is unique in the account.

CustomKeyStoreNotFoundException(CustomKeyStoreNotFoundException)

The request was rejected because KMS cannot find a custom key store with the specified key store name or ID.

KmsInternalException(KmsInternalException)

The request was rejected because an internal exception occurred. The request can be retried.

XksProxyIncorrectAuthenticationCredentialException(XksProxyIncorrectAuthenticationCredentialException)

The request was rejected because the proxy credentials failed to authenticate to the specified external key store proxy. The specified external key store proxy rejected a status request from KMS due to invalid credentials. This can indicate an error in the credentials or in the identification of the external key store proxy.

XksProxyInvalidConfigurationException(XksProxyInvalidConfigurationException)

The request was rejected because the external key store proxy is not configured correctly. To identify the cause, see the error message that accompanies the exception.

XksProxyInvalidResponseException(XksProxyInvalidResponseException)

KMS cannot interpret the response it received from the external key store proxy. The problem might be a poorly constructed response, but it could also be a transient network issue. If you see this error repeatedly, report it to the proxy vendor.

XksProxyUriEndpointInUseException(XksProxyUriEndpointInUseException)

The request was rejected because the XksProxyUriEndpoint is already associated with another external key store in this Amazon Web Services Region. To identify the cause, see the error message that accompanies the exception.

XksProxyUriInUseException(XksProxyUriInUseException)

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. Each external key store in a Region must use a unique external key store proxy API address.

XksProxyUriUnreachableException(XksProxyUriUnreachableException)

KMS was unable to reach the specified XksProxyUriPath. The path must be reachable before you create the external key store or update its settings.

This exception is also thrown when the external key store proxy response to a GetHealthStatus request indicates that all external key manager instances are unavailable.

XksProxyVpcEndpointServiceInUseException(XksProxyVpcEndpointServiceInUseException)

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. Each external key store in a Region must use a different Amazon VPC endpoint service.

XksProxyVpcEndpointServiceInvalidConfigurationException(XksProxyVpcEndpointServiceInvalidConfigurationException)

The request was rejected because the Amazon VPC endpoint service configuration does not fulfill the requirements for an external key store. To identify the cause, see the error message that accompanies the exception and review the requirements for Amazon VPC endpoint service connectivity for an external key store.

XksProxyVpcEndpointServiceNotFoundException(XksProxyVpcEndpointServiceNotFoundException)

The request was rejected because KMS could not find the specified VPC endpoint service. Use DescribeCustomKeyStores to verify the VPC endpoint service name for the external key store. Also, confirm that the Allow principals list for the VPC endpoint service includes the KMS service principal for the Region, such as cks.kms.us-east-1.amazonaws.com.

Unhandled(Unhandled)

👎Deprecated: Matching 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

impl UpdateCustomKeyStoreError

pub fn unhandled(err: impl Into<Box<dyn Error + Send + Sync + 'static>>) -> Self

Creates the UpdateCustomKeyStoreError::Unhandled variant from any error type.

pub fn generic(err: ErrorMetadata) -> Self

Creates the UpdateCustomKeyStoreError::Unhandled variant from an ErrorMetadata.

pub fn meta(&self) -> &ErrorMetadata

Returns error metadata, which includes the error code, message, request ID, and potentially additional information.

pub fn is_cloud_hsm_cluster_invalid_configuration_exception(&self) -> bool

Returns true if the error kind is UpdateCustomKeyStoreError::CloudHsmClusterInvalidConfigurationException.

pub fn is_cloud_hsm_cluster_not_active_exception(&self) -> bool

Returns true if the error kind is UpdateCustomKeyStoreError::CloudHsmClusterNotActiveException.

pub fn is_cloud_hsm_cluster_not_found_exception(&self) -> bool

Returns true if the error kind is UpdateCustomKeyStoreError::CloudHsmClusterNotFoundException.

pub fn is_cloud_hsm_cluster_not_related_exception(&self) -> bool

Returns true if the error kind is UpdateCustomKeyStoreError::CloudHsmClusterNotRelatedException.

pub fn is_custom_key_store_invalid_state_exception(&self) -> bool

Returns true if the error kind is UpdateCustomKeyStoreError::CustomKeyStoreInvalidStateException.

pub fn is_custom_key_store_name_in_use_exception(&self) -> bool

Returns true if the error kind is UpdateCustomKeyStoreError::CustomKeyStoreNameInUseException.

pub fn is_custom_key_store_not_found_exception(&self) -> bool

Returns true if the error kind is UpdateCustomKeyStoreError::CustomKeyStoreNotFoundException.

pub fn is_kms_internal_exception(&self) -> bool

Returns true if the error kind is UpdateCustomKeyStoreError::KmsInternalException.

pub fn is_xks_proxy_incorrect_authentication_credential_exception(&self) -> bool

Returns true if the error kind is UpdateCustomKeyStoreError::XksProxyIncorrectAuthenticationCredentialException.

pub fn is_xks_proxy_invalid_configuration_exception(&self) -> bool

Returns true if the error kind is UpdateCustomKeyStoreError::XksProxyInvalidConfigurationException.

pub fn is_xks_proxy_invalid_response_exception(&self) -> bool

Returns true if the error kind is UpdateCustomKeyStoreError::XksProxyInvalidResponseException.

pub fn is_xks_proxy_uri_endpoint_in_use_exception(&self) -> bool

Returns true if the error kind is UpdateCustomKeyStoreError::XksProxyUriEndpointInUseException.

pub fn is_xks_proxy_uri_in_use_exception(&self) -> bool

Returns true if the error kind is UpdateCustomKeyStoreError::XksProxyUriInUseException.

pub fn is_xks_proxy_uri_unreachable_exception(&self) -> bool

Returns true if the error kind is UpdateCustomKeyStoreError::XksProxyUriUnreachableException.

pub fn is_xks_proxy_vpc_endpoint_service_in_use_exception(&self) -> bool

Returns true if the error kind is UpdateCustomKeyStoreError::XksProxyVpcEndpointServiceInUseException.

pub fn is_xks_proxy_vpc_endpoint_service_invalid_configuration_exception( &self, ) -> bool

Returns true if the error kind is UpdateCustomKeyStoreError::XksProxyVpcEndpointServiceInvalidConfigurationException.

pub fn is_xks_proxy_vpc_endpoint_service_not_found_exception(&self) -> bool

Returns true if the error kind is UpdateCustomKeyStoreError::XksProxyVpcEndpointServiceNotFoundException.

Trait Implementations

impl CreateUnhandledError for UpdateCustomKeyStoreError

fn create_unhandled_error( source: Box<dyn Error + Send + Sync + 'static>, meta: Option<ErrorMetadata>, ) -> Self

Creates an unhandled error variant with the given source and error metadata.

impl Debug for UpdateCustomKeyStoreError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for UpdateCustomKeyStoreError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for UpdateCustomKeyStoreError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<UpdateCustomKeyStoreError> for Error

fn from(err: UpdateCustomKeyStoreError) -> Self

Converts to this type from the input type.

impl ProvideErrorKind for UpdateCustomKeyStoreError

fn code(&self) -> Option<&str>

Returns the code for this error if one exists

fn retryable_error_kind(&self) -> Option<ErrorKind>

Returns the ErrorKind when the error is modeled as retryable

impl ProvideErrorMetadata for UpdateCustomKeyStoreError

fn meta(&self) -> &ErrorMetadata

Returns error metadata, which includes the error code, message, request ID, and potentially additional information.

fn code(&self) -> Option<&str>

Returns the error code if it’s available.

fn message(&self) -> Option<&str>

Returns the error message, if there is one.

impl RequestId for UpdateCustomKeyStoreError

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.