Enum aws_types::credentials::CredentialsError

#[non_exhaustive]
pub enum CredentialsError {
    CredentialsNotLoaded {
        context: Box<dyn Error + Send + Sync + 'static>,
    },
    ProviderTimedOut(Duration),
    InvalidConfiguration {
        cause: Box<dyn Error + Send + Sync + 'static>,
    },
    ProviderError {
        cause: Box<dyn Error + Send + Sync + 'static>,
    },
    Unhandled {
        cause: Box<dyn Error + Send + Sync + 'static>,
    },
}

Error returned when credentials failed to load.

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.

CredentialsNotLoaded

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

context: Box<dyn Error + Send + Sync + 'static>

Underlying cause of the error.

No credentials were available for this provider

ProviderTimedOut(Duration)

Tuple Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

0: Duration

Loading credentials from this provider exceeded the maximum allowed duration

InvalidConfiguration

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

cause: Box<dyn Error + Send + Sync + 'static>

Underlying cause of the error.

The provider was given an invalid configuration

For example:

• syntax error in ~/.aws/config
• assume role profile that forms an infinite loop

ProviderError

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

cause: Box<dyn Error + Send + Sync + 'static>

Underlying cause of the error.

The provider experienced an error during credential resolution

This may include errors like a 503 from STS or a file system error when attempting to read a configuration file.

Unhandled

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

cause: Box<dyn Error + Send + Sync + 'static>

Underlying cause of the error.

An unexpected error occurred during credential resolution

If the error is something that can occur during expected usage of a provider, ProviderError should be returned instead. Unhandled is reserved for exceptional cases, for example:

• Returned data not UTF-8
• A provider returns data that is missing required fields

Implementations

impl CredentialsError

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

The credentials provider did not provide credentials

This error indicates the credentials provider was not enable or no configuration was set. This contrasts with invalid_configuration, indicating that the provider was configured in some way, but certain settings were invalid.

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

An unexpected error occurred loading credentials from this provider

Unhandled errors should not occur during normal operation and should be reserved for exceptional cases, such as a JSON API returning an output that was not parseable as JSON.

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

The credentials provider returned an error

Provider errors may occur during normal use of a credentials provider, e.g. a 503 when retrieving credentials from IMDS.

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

The provided configuration for a provider was invalid

pub fn provider_timed_out(context: Duration) -> Self

The credentials provider did not provide credentials within an allotted duration

Trait Implementations

impl Debug for CredentialsError

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

Formats the value using the given formatter.

impl Display for CredentialsError

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

Formats the value using the given formatter.

impl Error for CredentialsError

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

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

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