Skip to content

Conversation

@jonathan343
Copy link
Contributor

@jonathan343 jonathan343 commented Jul 16, 2025

This PR updates the Boto3 Retries documentation page to be more accurate in explaining the max_attempts and total_max_attempts config values.


Historical Context

As documented here, when boto3 added support for the cross-SDK max_attempts config in the AWS config file and the AWS_MAX_ATTEMPTS environment variable, there was a pre-existing max_attempts option in the botocore.Config object that behaved differently. To preserve backwards compatibility, a new total_max_attempts was added to the botocore.Config object to match the behavior of the new AWS config file and env var options.

The current Boto3 Retries documentation is missing this context which may lead to customers confusing the behavior of max_attempts when configuring it in the botocore.Config object.

Testing

I ran the following commands to build the docs to validate the changes render correctly:

# Install Boto3 and dependencies
uv pip install -e .
uv pip install -r requirements-docs.txt

# Build the docs (Note: I modified `boto3/docs/__init__.py` so I only build one service to save time)
cd docs
make clean html

# Host the docs locally and verify updates
cd build/html
python -m http.server

Copy link
Contributor

@hssyoo hssyoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating the docs, just had a couple small comments for added clarity. Also did we confirm that max_attempts (in the Config() object) behaves the same between legacy and standard modes? If they differ we should also document that

@jonathan343 jonathan343 requested a review from hssyoo July 21, 2025 19:51
Copy link
Contributor

@hssyoo hssyoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🏆

@jonathan343 jonathan343 merged commit 3e2d247 into boto:develop Jul 22, 2025
76 checks passed
aws-sdk-python-automation added a commit that referenced this pull request Jul 22, 2025
* release-1.39.11:
  Bumping version to 1.39.11
  Add changelog entries from botocore
  Update retries documentation (#4571)
hswong3i pushed a commit to alvistack/boto-boto3 that referenced this pull request Jul 23, 2025
Updates the Boto3 retries documentation page to be more accurate in explaining the max_attempts and total_max_attempts config values.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants