Modules#

boto3-refresh-session includes multiple modules, grouped into two categories:

  • The core interface (session)

  • Individual modules for each supported refresh strategy (e.g., STS)

Core interface#

Basic usage of boto3-refresh-session requires familiarity only with the session module. The boto3_refresh_session.session.RefreshableSession class provides a unified interface for all supported credential refresh strategies.

Tip

For most users, STS is sufficient — there’s no need to manually specify the method parameter unless using advanced strategies like ECS. All users should, however, familiarize themselves with the documentation in the Refresh strategies in order to understand required and optional parameters and available methods.

Refresh strategies#

boto3-refresh-session supports multiple AWS services. There is also a highly flexible module named “custom” for users with highly sophisticated, novel, or idiosyncratic authentication flows.

Tip

It is recommended to use boto3_refresh_session.session.RefreshableSession instead of initializing the below classes. Refer to the below documentation to understand what sort of parameters each refresh strategy requires and what sort of methods are available.

Each strategy supported by boto3-refresh-session is encapsulated in its own module below.

Exceptions and Warnings#

Mistakes and problems happen. You can find all of the custom exceptions and warnings for boto3-refresh-session below.