polars.CredentialProviderAWS

class polars.CredentialProviderAWS(
    *,
    profile_name: str | None = None,
    region_name: str | None = None,
    assume_role: AWSAssumeRoleKWArgs | None = None,
    _auto_init_unhandled_key: str | None = None,
    _storage_options_has_endpoint_url: bool = False,
)

AWS Credential Provider.

Using this requires the boto3 Python package to be installed.

Warning

This functionality is considered unstable. It may be changed at any point without it being considered a breaking change.

__init__(
    *,
    profile_name: str | None = None,
    region_name: str | None = None,
    assume_role: AWSAssumeRoleKWArgs | None = None,
    _auto_init_unhandled_key: str | None = None,
    _storage_options_has_endpoint_url: bool = False,
) → None

Initialize a credential provider for AWS.

Parameters:

profile_namestr

Profile name to use from credentials file.

assume_roleAWSAssumeRoleKWArgs | None

Configure a role to assume. These are passed as kwarg parameters to [STS.client.assume_role()](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sts/client/assume_role.html#STS.Client.assume_role)

Methods

__init__(*[, profile_name, region_name, ...])	Initialize a credential provider for AWS.
clear_cached_credentials()
retrieve_credentials_impl()	Fetch the credentials for the configured profile name.

Attributes

profile_name
region_name
assume_role