Configs

Added in version 7.1.0.

Historically, assume_role_kwargs and sts_client_kwargs parameters accepted dictionaries to configure STS clients and role assumption behavior.

Beginning v7.1.0, AssumeRoleConfig and STSClientConfig objects were introduced to encapsulate these configurations, providing a more structured and maintainable approach.

Tip

Dictionaries are still supported for backward compatibility, but using these new objects is now the recommended approach.

Tip

AssumeRoleConfig and STSClientConfig attributes can be accessed using dot-notation or dictionary-style access.

Note

Accessing a valid but unset attribute (e.g., SerialNumber) via dot-notation returns None instead of raising an error. While this behavior is convenient, it may surprise users accustomed to seeing AttributeError exceptions in similar contexts

Warning

TokenCode values in AssumeRoleConfig which do not conform with AWS’ specifications (i.e. 6 digit numeric strings) will result in errors raised during construction of the TokenCode attribute.

This still works:

from boto3_refresh_session import RefreshableSession

refreshable_session = RefreshableSession(
    assume_role_kwargs={
        "RoleArn": "arn:aws:iam::123456789012:role/MyRole",
        "RoleSessionName": "MySession",
        "DurationSeconds": 3600,
    },
    sts_client_kwargs={
        "region_name": "us-west-2",
        "endpoint_url": "https://sts.us-west-2.amazonaws.com",
    },
)

But this is now preferred:

from boto3_refresh_session import (
    AssumeRoleConfig,
    RefreshableSession,
    STSClientConfig,
)

refreshable_session = RefreshableSession(
    assume_role_kwargs=AssumeRoleConfig(
        RoleArn="arn:aws:iam::123456789012:role/MyRole",
        RoleSessionName="MySession",
        DurationSeconds=3600,
    ),
    sts_client_kwargs=STSClientConfig(
        region_name="us-west-2",
        endpoint_url="https://sts.us-west-2.amazonaws.com",
    ),
)

Configs

AssumeRoleConfig	Configuration for AWS STS AssumeRole API.
STSClientConfig	Configuration for boto3 STS Client.