Struct aws_config::profile::retry_config::ProfileFileRetryConfigProvider

pub struct ProfileFileRetryConfigProvider { /* private fields */ }

Load retry configuration properties from a profile file

This provider will attempt to load AWS shared configuration, then read retry configuration properties from the active profile.

Location of Profile Files

• The location of the config file will be loaded from the AWS_CONFIG_FILE environment variable with a fallback to ~/.aws/config
• The location of the credentials file will be loaded from the AWS_SHARED_CREDENTIALS_FILE environment variable with a fallback to ~/.aws/credentials

The location of these files can also be customized programmatically using ProfileFiles.

Home directory resolution

Home directory resolution is implemented to match the behavior of the CLI & Python. ~ is only used for home directory resolution when it:

• Starts the path
• Is followed immediately by / or a platform specific separator. (On windows, ~/ and ~\ both resolve to the home directory.

When determining the home directory, the following environment variables are checked:

• HOME on all platforms
• USERPROFILE on Windows
• The concatenation of HOMEDRIVE and HOMEPATH on Windows ($HOMEDRIVE$HOMEPATH)

Examples

Loads 2 as the max_attempts to make when sending a request

[default]
max_attempts = 2

Loads standard as the retry_mode if and only if the other profile is selected.

[profile other]
retry_mode = standard

This provider is part of the default retry_config provider chain.

Implementations

impl ProfileFileRetryConfigProvider

pub fn new() -> Self

Create a new ProfileFileRetryConfigProvider

To override the selected profile, set the AWS_PROFILE environment variable or use the Builder.

pub fn builder() -> Builder

Builder to construct a ProfileFileRetryConfigProvider

pub async fn retry_config_builder(
    &self
) -> Result<RetryConfigBuilder, RetryConfigError>

Attempt to create a new RetryConfigBuilder from a profile file.

Trait Implementations

impl Debug for ProfileFileRetryConfigProvider

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

Formats the value using the given formatter.

impl Default for ProfileFileRetryConfigProvider

fn default() -> ProfileFileRetryConfigProvider

Returns the “default value” for a type.