You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
"description": "[``botocore``] Add support for Image Tag Mutability Exception feature, allowing repositories to define wildcard-based patterns that override the default image tag mutability settings.",
5
+
"type": "api-change"
6
+
},
7
+
{
8
+
"category": "``emr``",
9
+
"description": "[``botocore``] This release adds new parameter 'ExtendedSupport' in AWS EMR RunJobFlow, ModifyCluster and DescribeCluster API.",
10
+
"type": "api-change"
11
+
},
12
+
{
13
+
"category": "``lambda``",
14
+
"description": "[``botocore``] This release migrated the model to Smithy keeping all features unchanged.",
15
+
"type": "api-change"
16
+
},
17
+
{
18
+
"category": "``neptunedata``",
19
+
"description": "[``botocore``] This release updates the supported regions for Neptune API to include current AWS regions.",
Copy file name to clipboardExpand all lines: CHANGELOG.rst
+9Lines changed: 9 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,15 @@
2
2
CHANGELOG
3
3
=========
4
4
5
+
1.39.11
6
+
=======
7
+
8
+
* api-change:``ecr``: [``botocore``] Add support for Image Tag Mutability Exception feature, allowing repositories to define wildcard-based patterns that override the default image tag mutability settings.
9
+
* api-change:``emr``: [``botocore``] This release adds new parameter 'ExtendedSupport' in AWS EMR RunJobFlow, ModifyCluster and DescribeCluster API.
10
+
* api-change:``lambda``: [``botocore``] This release migrated the model to Smithy keeping all features unchanged.
11
+
* api-change:``neptunedata``: [``botocore``] This release updates the supported regions for Neptune API to include current AWS regions.
Copy file name to clipboardExpand all lines: docs/source/guide/retries.rst
+22-9Lines changed: 22 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ Legacy mode is the default mode used by any Boto3 client you create. As its name
24
24
25
25
**Legacy mode’s functionality includes:**
26
26
27
-
* A default value of 5 for maximum retry attempts. This value can be overwritten through the ``max_attempts`` configuration parameter.
27
+
* A default value of 5 for maximum attempts (including the initial request). See `Available configuration options`_ for more information on overwriting this value.
28
28
* Retry attempts for a limited number of errors/exceptions::
29
29
30
30
# General socket/connection errors
@@ -55,7 +55,7 @@ Standard mode is a retry mode that was introduced with the updated retry handler
55
55
56
56
**Standard mode’s functionality includes:**
57
57
58
-
* A default value of 3 for maximum retry attempts. This value can be overwritten through the ``max_attempts`` configuration parameter.
58
+
* A default value of 3 for maximum attempts (including the initial request). See `Available configuration options`_ for more information on overwriting this value.
59
59
* Retry attempts for an expanded list of errors/exceptions::
60
60
61
61
# Transient errors/exceptions
@@ -102,10 +102,23 @@ Boto3 includes a variety of both retry configurations as well as configuration m
102
102
Available configuration options
103
103
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104
104
105
-
In Boto3, users can customize two retry configurations:
105
+
In Boto3, users can customize retry configurations:
106
106
107
107
* ``retry_mode`` - This tells Boto3 which retry mode to use. As described previously, there are three retry modes available: legacy (default), standard, and adaptive.
108
-
* ``max_attempts`` - This provides Boto3’s retry handler with a value of maximum retry attempts, where the initial call counts toward the ``max_attempts`` value that you provide.
108
+
* ``max_attempts`` - This provides Boto3's retry handler with a value of maximum attempts. **Important**: The behavior differs depending on how it's configured:
109
+
110
+
* When set in your AWS config file or using the ``AWS_MAX_ATTEMPTS`` environment variable: ``max_attempts`` includes the initial request (total requests)
111
+
* When set in a ``Config`` object: ``max_attempts`` excludes the initial request (retries only)
112
+
113
+
**Examples:**
114
+
115
+
* AWS config file with ``max_attempts = 3``: 1 initial request + 2 retries = 3 total attempts
* Config object with ``max_attempts: 3``: 1 initial request + 3 retries = 4 total attempts
118
+
119
+
* ``total_max_attempts`` - Available only in ``Config`` objects, this always represents total requests including the initial call. This parameter was introduced to provide consistent behavior with the ``max_attempts`` setting used in AWS config files and environment variables. Note that ``total_max_attempts`` is not supported as an environment variable or in AWS config files.
120
+
121
+
For consistency, consider using ``total_max_attempts`` in ``Config`` objects instead of ``max_attempts``.
109
122
110
123
Defining a retry configuration in your AWS configuration file
@@ -117,7 +130,7 @@ This first way to define your retry configuration is to update your global AWS c
117
130
max_attempts = 10
118
131
retry_mode = standard
119
132
120
-
Any Boto3 script or code that uses your AWS config file inherits these configurations when using your profile, unless otherwise explicitly overwritten by a ``Config`` object when instantiating your client object at runtime. If no configuration options are set, the default retry mode value is ``legacy``, and the default ``max_attempts`` value is 5.
133
+
Any Boto3 script or code that uses your AWS config file inherits these configurations when using your profile, unless otherwise explicitly overwritten by a ``Config`` object when instantiating your client object at runtime. If no configuration options are set, the default retry mode value is ``legacy``, and the default ``max_attempts`` value is 5 (total attempts including initial request).
121
134
122
135
Defining a retry configuration in a Config object for your Boto3 client
@@ -126,13 +139,13 @@ The second way to define your retry configuration is to use botocore to enable m
126
139
127
140
Additionally, if your AWS configuration file is configured with retry behavior, but you want to override those global settings, you can use the ``Config`` object to override an individual client object at runtime.
128
141
129
-
As shown in the following example, the ``Config`` object takes a ``retries`` dictionary where you can supply your two configuration options, ``max_attempts`` and ``mode``, and the values for each.
142
+
As shown in the following example, the ``Config`` object takes a ``retries`` dictionary where you can supply configuration options such as ``total_max_attempts`` and ``mode``, and the values for each.
130
143
131
144
.. code-block:: python
132
145
133
146
config = Config(
134
147
retries= {
135
-
'max_attempts': 10,
148
+
'total_max_attempts': 10,
136
149
'mode': 'standard'
137
150
}
138
151
)
@@ -149,15 +162,15 @@ The following is an example of instantiating a ``Config`` object and passing it
149
162
150
163
config = Config(
151
164
retries= {
152
-
'max_attempts': 10,
165
+
'total_max_attempts': 10,
153
166
'mode': 'standard'
154
167
}
155
168
)
156
169
157
170
ec2 = boto3.client('ec2', config=config)
158
171
159
172
.. note::
160
-
As mentioned previously, if no configuration options are set, the default mode is ``legacy`` and the default ``max_attempts`` is 5.
173
+
As mentioned previously, if no configuration options are set, the default mode is ``legacy`` and the default ``total_max_attempts`` is 5 (total attempts including initial request).
0 commit comments