Enum EncryptError

#[non_exhaustive]
pub enum EncryptError {
    DependencyTimeoutException(DependencyTimeoutException),
    DisabledException(DisabledException),
    DryRunOperationException(DryRunOperationException),
    InvalidGrantTokenException(InvalidGrantTokenException),
    InvalidKeyUsageException(InvalidKeyUsageException),
    KeyUnavailableException(KeyUnavailableException),
    KmsInternalException(KmsInternalException),
    KmsInvalidStateException(KmsInvalidStateException),
    NotFoundException(NotFoundException),
    Unhandled(Unhandled),
}

Error type for the EncryptError 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.

DependencyTimeoutException(DependencyTimeoutException)

The system timed out while trying to fulfill the request. You can retry the request.

DisabledException(DisabledException)

The request was rejected because the specified KMS key is not enabled.

DryRunOperationException(DryRunOperationException)

The request was rejected because the DryRun parameter was specified.

InvalidGrantTokenException(InvalidGrantTokenException)

The request was rejected because the specified grant token is not valid.

InvalidKeyUsageException(InvalidKeyUsageException)

The request was rejected for one of the following reasons:

• The KeyUsage value of the KMS key is incompatible with the API operation.

• The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the KMS key (KeySpec).

For encrypting, decrypting, re-encrypting, and generating data keys, the KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying messages, the KeyUsage must be SIGN_VERIFY. For generating and verifying message authentication codes (MACs), the KeyUsage must be GENERATE_VERIFY_MAC. For deriving key agreement secrets, the KeyUsage must be KEY_AGREEMENT. To find the KeyUsage of a KMS key, use the DescribeKey operation.

To find the encryption or signing algorithms supported for a particular KMS key, use the DescribeKey operation.

KeyUnavailableException(KeyUnavailableException)

The request was rejected because the specified KMS key was not available. You can retry the request.

KmsInternalException(KmsInternalException)

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

KmsInvalidStateException(KmsInvalidStateException)

The request was rejected because the state of the specified resource is not valid for this request.

This exceptions means one of the following:

• The key state of the KMS key is not compatible with the operation.

  To find the key state, use the DescribeKey operation. For more information about which key states are compatible with each KMS operation, see Key states of KMS keys in the Key Management Service Developer Guide .

• For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.

NotFoundException(NotFoundException)

The request was rejected because the specified entity or resource could not be found.

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 EncryptError

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

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

pub fn generic(err: ErrorMetadata) -> Self

Creates the EncryptError::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_dependency_timeout_exception(&self) -> bool

Returns true if the error kind is EncryptError::DependencyTimeoutException.

pub fn is_disabled_exception(&self) -> bool

Returns true if the error kind is EncryptError::DisabledException.

pub fn is_dry_run_operation_exception(&self) -> bool

Returns true if the error kind is EncryptError::DryRunOperationException.

pub fn is_invalid_grant_token_exception(&self) -> bool

Returns true if the error kind is EncryptError::InvalidGrantTokenException.

pub fn is_invalid_key_usage_exception(&self) -> bool

Returns true if the error kind is EncryptError::InvalidKeyUsageException.

pub fn is_key_unavailable_exception(&self) -> bool

Returns true if the error kind is EncryptError::KeyUnavailableException.

pub fn is_kms_internal_exception(&self) -> bool

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

pub fn is_kms_invalid_state_exception(&self) -> bool

Returns true if the error kind is EncryptError::KmsInvalidStateException.

pub fn is_not_found_exception(&self) -> bool

Returns true if the error kind is EncryptError::NotFoundException.

Trait Implementations

impl CreateUnhandledError for EncryptError

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 EncryptError

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

Formats the value using the given formatter.

impl Display for EncryptError

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

Formats the value using the given formatter.

impl Error for EncryptError

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<EncryptError> for Error

fn from(err: EncryptError) -> Self

Converts to this type from the input type.

impl ProvideErrorKind for EncryptError

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 EncryptError

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 EncryptError

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

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