Enum CredentialsError 

#[non_exhaustive]
pub enum CredentialsError {
    CredentialsNotLoaded(CredentialsNotLoaded),
    ProviderTimedOut(ProviderTimedOut),
    InvalidConfiguration(InvalidConfiguration),
    ProviderError(ProviderError),
    Unhandled(Unhandled),
}

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(CredentialsNotLoaded)

No credentials were available for this provider

ProviderTimedOut(ProviderTimedOut)

Loading credentials from this provider exceeded the maximum allowed duration

InvalidConfiguration(InvalidConfiguration)

The provider was given an invalid configuration

For example:

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

ProviderError(ProviderError)

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(Unhandled)

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( source: impl Into<Box<dyn Error + Send + Sync>>, ) -> CredentialsError

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 not_loaded_no_source() -> CredentialsError

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( source: impl Into<Box<dyn Error + Send + Sync>>, ) -> CredentialsError

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( source: impl Into<Box<dyn Error + Send + Sync>>, ) -> CredentialsError

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( source: impl Into<Box<dyn Error + Send + Sync>>, ) -> CredentialsError

The provided configuration for a provider was invalid

pub fn provider_timed_out(timeout_duration: Duration) -> CredentialsError

The credentials provider did not provide credentials within an allotted duration

Trait Implementations

impl Debug for CredentialsError

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

Formats the value using the given formatter.

impl Display for CredentialsError

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

Formats the value using the given formatter.

impl Error for CredentialsError

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.