Enum aws_types::credentials::CredentialsError
source · #[non_exhaustive]
pub enum CredentialsError {
CredentialsNotLoaded(CredentialsNotLoaded),
ProviderTimedOut(ProviderTimedOut),
InvalidConfiguration(InvalidConfiguration),
ProviderError(ProviderError),
Unhandled(Unhandled),
}
Expand description
Error returned when credentials failed to load.
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
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§
source§impl CredentialsError
impl CredentialsError
sourcepub fn not_loaded(
source: impl Into<Box<dyn Error + Send + Sync + 'static>>
) -> Self
pub fn not_loaded(
source: 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.
sourcepub fn unhandled(
source: impl Into<Box<dyn Error + Send + Sync + 'static>>
) -> Self
pub fn unhandled(
source: 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.
sourcepub fn provider_error(
source: impl Into<Box<dyn Error + Send + Sync + 'static>>
) -> Self
pub fn provider_error(
source: 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.
sourcepub fn invalid_configuration(
source: impl Into<Box<dyn Error + Send + Sync + 'static>>
) -> Self
pub fn invalid_configuration(
source: impl Into<Box<dyn Error + Send + Sync + 'static>>
) -> Self
The provided configuration for a provider was invalid
sourcepub fn provider_timed_out(timeout_duration: Duration) -> Self
pub fn provider_timed_out(timeout_duration: Duration) -> Self
The credentials provider did not provide credentials within an allotted duration