#[non_exhaustive]pub enum CreateCustomKeyStoreError {
Show 18 variants
CloudHsmClusterInUseException(CloudHsmClusterInUseException),
CloudHsmClusterInvalidConfigurationException(CloudHsmClusterInvalidConfigurationException),
CloudHsmClusterNotActiveException(CloudHsmClusterNotActiveException),
CloudHsmClusterNotFoundException(CloudHsmClusterNotFoundException),
CustomKeyStoreNameInUseException(CustomKeyStoreNameInUseException),
IncorrectTrustAnchorException(IncorrectTrustAnchorException),
KmsInternalException(KmsInternalException),
LimitExceededException(LimitExceededException),
XksProxyIncorrectAuthenticationCredentialException(XksProxyIncorrectAuthenticationCredentialException),
XksProxyInvalidConfigurationException(XksProxyInvalidConfigurationException),
XksProxyInvalidResponseException(XksProxyInvalidResponseException),
XksProxyUriEndpointInUseException(XksProxyUriEndpointInUseException),
XksProxyUriInUseException(XksProxyUriInUseException),
XksProxyUriUnreachableException(XksProxyUriUnreachableException),
XksProxyVpcEndpointServiceInUseException(XksProxyVpcEndpointServiceInUseException),
XksProxyVpcEndpointServiceInvalidConfigurationException(XksProxyVpcEndpointServiceInvalidConfigurationException),
XksProxyVpcEndpointServiceNotFoundException(XksProxyVpcEndpointServiceNotFoundException),
Unhandled(Unhandled),
}Expand description
Error type for the CreateCustomKeyStoreError operation.
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
CloudHsmClusterInUseException(CloudHsmClusterInUseException)
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. Each CloudHSM key store in the account must be associated with a different CloudHSM 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.
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, andCreateKeyoperations, the CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For theConnectCustomKeyStoreoperation, 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.
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.
IncorrectTrustAnchorException(IncorrectTrustAnchorException)
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.
When you initialize the CloudHSM cluster, you create the trust anchor certificate and save it in the customerCA.crt file.
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.
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)
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 CreateCustomKeyStoreError
impl CreateCustomKeyStoreError
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 CreateCustomKeyStoreError::Unhandled variant from any error type.
Sourcepub fn generic(err: ErrorMetadata) -> Self
pub fn generic(err: ErrorMetadata) -> Self
Creates the CreateCustomKeyStoreError::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_in_use_exception(&self) -> bool
pub fn is_cloud_hsm_cluster_in_use_exception(&self) -> bool
Returns true if the error kind is CreateCustomKeyStoreError::CloudHsmClusterInUseException.
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 CreateCustomKeyStoreError::CloudHsmClusterInvalidConfigurationException.
Sourcepub fn is_cloud_hsm_cluster_not_active_exception(&self) -> bool
pub fn is_cloud_hsm_cluster_not_active_exception(&self) -> bool
Returns true if the error kind is CreateCustomKeyStoreError::CloudHsmClusterNotActiveException.
Sourcepub fn is_cloud_hsm_cluster_not_found_exception(&self) -> bool
pub fn is_cloud_hsm_cluster_not_found_exception(&self) -> bool
Returns true if the error kind is CreateCustomKeyStoreError::CloudHsmClusterNotFoundException.
Sourcepub fn is_custom_key_store_name_in_use_exception(&self) -> bool
pub fn is_custom_key_store_name_in_use_exception(&self) -> bool
Returns true if the error kind is CreateCustomKeyStoreError::CustomKeyStoreNameInUseException.
Sourcepub fn is_incorrect_trust_anchor_exception(&self) -> bool
pub fn is_incorrect_trust_anchor_exception(&self) -> bool
Returns true if the error kind is CreateCustomKeyStoreError::IncorrectTrustAnchorException.
Sourcepub fn is_kms_internal_exception(&self) -> bool
pub fn is_kms_internal_exception(&self) -> bool
Returns true if the error kind is CreateCustomKeyStoreError::KmsInternalException.
Sourcepub fn is_limit_exceeded_exception(&self) -> bool
pub fn is_limit_exceeded_exception(&self) -> bool
Returns true if the error kind is CreateCustomKeyStoreError::LimitExceededException.
Sourcepub fn is_xks_proxy_incorrect_authentication_credential_exception(&self) -> bool
pub fn is_xks_proxy_incorrect_authentication_credential_exception(&self) -> bool
Returns true if the error kind is CreateCustomKeyStoreError::XksProxyIncorrectAuthenticationCredentialException.
Sourcepub fn is_xks_proxy_invalid_configuration_exception(&self) -> bool
pub fn is_xks_proxy_invalid_configuration_exception(&self) -> bool
Returns true if the error kind is CreateCustomKeyStoreError::XksProxyInvalidConfigurationException.
Sourcepub fn is_xks_proxy_invalid_response_exception(&self) -> bool
pub fn is_xks_proxy_invalid_response_exception(&self) -> bool
Returns true if the error kind is CreateCustomKeyStoreError::XksProxyInvalidResponseException.
Sourcepub fn is_xks_proxy_uri_endpoint_in_use_exception(&self) -> bool
pub fn is_xks_proxy_uri_endpoint_in_use_exception(&self) -> bool
Returns true if the error kind is CreateCustomKeyStoreError::XksProxyUriEndpointInUseException.
Sourcepub fn is_xks_proxy_uri_in_use_exception(&self) -> bool
pub fn is_xks_proxy_uri_in_use_exception(&self) -> bool
Returns true if the error kind is CreateCustomKeyStoreError::XksProxyUriInUseException.
Sourcepub fn is_xks_proxy_uri_unreachable_exception(&self) -> bool
pub fn is_xks_proxy_uri_unreachable_exception(&self) -> bool
Returns true if the error kind is CreateCustomKeyStoreError::XksProxyUriUnreachableException.
Sourcepub fn is_xks_proxy_vpc_endpoint_service_in_use_exception(&self) -> bool
pub fn is_xks_proxy_vpc_endpoint_service_in_use_exception(&self) -> bool
Returns true if the error kind is CreateCustomKeyStoreError::XksProxyVpcEndpointServiceInUseException.
Sourcepub fn is_xks_proxy_vpc_endpoint_service_invalid_configuration_exception(
&self,
) -> bool
pub fn is_xks_proxy_vpc_endpoint_service_invalid_configuration_exception( &self, ) -> bool
Returns true if the error kind is CreateCustomKeyStoreError::XksProxyVpcEndpointServiceInvalidConfigurationException.
Sourcepub fn is_xks_proxy_vpc_endpoint_service_not_found_exception(&self) -> bool
pub fn is_xks_proxy_vpc_endpoint_service_not_found_exception(&self) -> bool
Returns true if the error kind is CreateCustomKeyStoreError::XksProxyVpcEndpointServiceNotFoundException.
Trait Implementations§
Source§impl CreateUnhandledError for CreateCustomKeyStoreError
impl CreateUnhandledError for CreateCustomKeyStoreError
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 CreateCustomKeyStoreError
impl Debug for CreateCustomKeyStoreError
Source§impl Display for CreateCustomKeyStoreError
impl Display for CreateCustomKeyStoreError
Source§impl Error for CreateCustomKeyStoreError
impl Error for CreateCustomKeyStoreError
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<CreateCustomKeyStoreError> for Error
impl From<CreateCustomKeyStoreError> for Error
Source§fn from(err: CreateCustomKeyStoreError) -> Self
fn from(err: CreateCustomKeyStoreError) -> Self
Source§impl ProvideErrorMetadata for CreateCustomKeyStoreError
impl ProvideErrorMetadata for CreateCustomKeyStoreError
Source§fn meta(&self) -> &ErrorMetadata
fn meta(&self) -> &ErrorMetadata
Source§impl RequestId for CreateCustomKeyStoreError
impl RequestId for CreateCustomKeyStoreError
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None if the service could not be reached.Auto Trait Implementations§
impl Freeze for CreateCustomKeyStoreError
impl !RefUnwindSafe for CreateCustomKeyStoreError
impl Send for CreateCustomKeyStoreError
impl Sync for CreateCustomKeyStoreError
impl Unpin for CreateCustomKeyStoreError
impl !UnwindSafe for CreateCustomKeyStoreError
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightBlack.
§Example
println!("{}", value.bright_black());Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightGreen.
§Example
println!("{}", value.bright_green());Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightYellow.
§Example
println!("{}", value.bright_yellow());Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightMagenta.
§Example
println!("{}", value.bright_magenta());Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightWhite.
§Example
println!("{}", value.bright_white());Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightBlack.
§Example
println!("{}", value.on_bright_black());Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightGreen.
§Example
println!("{}", value.on_bright_green());Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightYellow.
§Example
println!("{}", value.on_bright_yellow());Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightBlue.
§Example
println!("{}", value.on_bright_blue());Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightMagenta.
§Example
println!("{}", value.on_bright_magenta());Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightCyan.
§Example
println!("{}", value.on_bright_cyan());Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightWhite.
§Example
println!("{}", value.on_bright_white());Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self with the
attr()
set to
Attribute::Underline.
§Example
println!("{}", value.underline());Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self with the
attr()
set to
Attribute::RapidBlink.
§Example
println!("{}", value.rapid_blink());Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);