Update retries documentation #4571
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the Boto3 Retries documentation page to be more accurate in explaining the
max_attemptsandtotal_max_attemptsconfig values.Historical Context
As documented here, when boto3 added support for the cross-SDK
max_attemptsconfig in the AWS config file and theAWS_MAX_ATTEMPTSenvironment variable, there was a pre-existingmax_attemptsoption in thebotocore.Configobject that behaved differently. To preserve backwards compatibility, a newtotal_max_attemptswas added to thebotocore.Configobject 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_attemptswhen configuring it in thebotocore.Configobject.Testing
I ran the following commands to build the docs to validate the changes render correctly: