From 764506a3b45a9efedc5643240f99e953515f5f53 Mon Sep 17 00:00:00 2001 From: Tim Finnigan Date: Tue, 24 Oct 2023 13:43:03 -0700 Subject: [PATCH 1/5] remove period --- boto3/docs/waiter.py | 2 +- tests/unit/docs/test_docstring.py | 2 +- tests/unit/docs/test_waiter.py | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/boto3/docs/waiter.py b/boto3/docs/waiter.py index e2cb3bfe63..a135d972e7 100644 --- a/boto3/docs/waiter.py +++ b/boto3/docs/waiter.py @@ -90,7 +90,7 @@ def document_resource_waiter( service_module_name = get_service_module_name(service_model) description = ( 'Waits until this {} is {}. This method calls ' - ':py:meth:`{}.Waiter.{}.wait` which polls. ' + ':py:meth:`{}.Waiter.{}.wait` which polls ' ':py:meth:`{}.Client.{}` every {} seconds until ' 'a successful state is reached. An error is returned ' 'after {} failed checks.'.format( diff --git a/tests/unit/docs/test_docstring.py b/tests/unit/docs/test_docstring.py index 6104212c2d..d2a9f3fa89 100644 --- a/tests/unit/docs/test_docstring.py +++ b/tests/unit/docs/test_docstring.py @@ -272,7 +272,7 @@ def test_resource_waiter_help(self): ( ' Waits until this Sample is complete. This method calls ' ':py:meth:`MyService.Waiter.sample_operation_complete.wait` ' - 'which polls. :py:meth:`MyService.Client.sample_operation` every ' + 'which polls :py:meth:`MyService.Client.sample_operation` every ' '15 seconds until a successful state is reached. An error ' 'is returned after 40 failed checks.' ), diff --git a/tests/unit/docs/test_waiter.py b/tests/unit/docs/test_waiter.py index 4ff7963252..ecfd884caf 100644 --- a/tests/unit/docs/test_waiter.py +++ b/tests/unit/docs/test_waiter.py @@ -39,7 +39,7 @@ def test_document_resource_waiters(self): ( ' Waits until this Sample is complete. This method calls ' ':py:meth:`MyService.Waiter.sample_operation_complete.wait` ' - 'which polls. :py:meth:`MyService.Client.sample_operation` ' + 'which polls :py:meth:`MyService.Client.sample_operation` ' 'every 15 seconds until a successful state is reached. An ' 'error is returned after 40 failed checks.' ), From 1298d61328387f5dd553c029ccdaeaca3432566a Mon Sep 17 00:00:00 2001 From: David Miller <45697098+dlm6693@users.noreply.github.com> Date: Tue, 24 Oct 2023 18:45:46 -0400 Subject: [PATCH 2/5] Update config guide to include client context params usage (#3894) * update config rst with client context params --- docs/source/guide/configuration.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/docs/source/guide/configuration.rst b/docs/source/guide/configuration.rst index 3536ca0d2d..9e4039f4aa 100644 --- a/docs/source/guide/configuration.rst +++ b/docs/source/guide/configuration.rst @@ -114,6 +114,31 @@ You can configure how Boto3 uses proxies by specifying the ``proxies_config`` op With the addition of the ``proxies_config`` option shown here, the proxy will use the specified certificate file for authentication when using the HTTPS proxy. +Using client context parameters +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Some services have configuration settings that are specific to their clients. These settings are called client context parameters. Please refer to the ``Client Context Parameters`` section of a service client's documentation for a list of available parameters and information on how to use them. + +.. _configure_client_context: + +Configuring client context parameters +''''''''''''''''''''''''''''''''''''' +You can configure client context parameters by passing a dictionary of key-value pairs to the ``client_context_params`` parameter in your ``Config``. Invalid parameter values or parameters that are not modeled by the service will be ignored. + +.. code-block:: python + + import boto3 + from botocore.config import Config + + my_config = Config( + region_name='us-east-2', + client_context_params={ + 'my_great_context_param': 'foo' + } + ) + + client = boto3.client('kinesis', config=my_config) + +Boto3 does not support setting ``client_context_params`` per request. Differing configurations will require creation of a new client. Using environment variables --------------------------- From 3665c15c5f8b62a900dbc3ca33bc22b178a94964 Mon Sep 17 00:00:00 2001 From: David Miller <45697098+dlm6693@users.noreply.github.com> Date: Tue, 24 Oct 2023 19:34:59 -0400 Subject: [PATCH 3/5] add client context params to boto3 docs (#3911) --- boto3/docs/service.py | 3 +++ tests/unit/docs/test_service.py | 20 ++++++++++++++++++++ 2 files changed, 23 insertions(+) diff --git a/boto3/docs/service.py b/boto3/docs/service.py index cb01529ee0..39ed89b871 100644 --- a/boto3/docs/service.py +++ b/boto3/docs/service.py @@ -46,6 +46,7 @@ def __init__(self, service_name, session, root_docs_path): 'waiters', 'resources', 'examples', + 'context-params', ] self._root_docs_path = root_docs_path self._USER_GUIDE_LINK = ( @@ -69,6 +70,8 @@ def document_service(self): if self._service_resource: self.resource_section(doc_structure.get_section('resources')) self._document_examples(doc_structure.get_section('examples')) + context_params_section = doc_structure.get_section('context-params') + self.client_context_params(context_params_section) return doc_structure.flush_structure() def client_api(self, section): diff --git a/tests/unit/docs/test_service.py b/tests/unit/docs/test_service.py index 511313f0bc..a6e8ef19f8 100644 --- a/tests/unit/docs/test_service.py +++ b/tests/unit/docs/test_service.py @@ -276,3 +276,23 @@ def test_injects_examples_when_found(self): contents = service_documenter.document_service().decode('utf-8') assert 'This is an example' in contents assert 'This is for another service' not in contents + + def test_service_with_context_params(self): + self.json_model['clientContextParams'] = { + 'MyContextParam': { + 'documentation': 'This is my context param', + 'type': 'boolean', + } + } + self.setup_client_and_resource() + service_documenter = ServiceDocumenter( + 'myservice', self.session, self.root_services_path + ) + contents = service_documenter.document_service().decode('utf-8') + lines = [ + "=========================", + "Client Context Parameters", + "=========================", + "* ``my_context_param`` (boolean) - This is my context param", + ] + self.assert_contains_lines_in_order(lines, contents) From cca0f1d18b4821ccb154a2c60577ca28efb1a98d Mon Sep 17 00:00:00 2001 From: aws-sdk-python-automation Date: Wed, 25 Oct 2023 20:15:14 +0000 Subject: [PATCH 4/5] Add changelog entries from botocore --- .changes/next-release/api-change-connectcases-87788.json | 5 +++++ .changes/next-release/api-change-groundstation-47343.json | 5 +++++ .changes/next-release/api-change-iam-7583.json | 5 +++++ .changes/next-release/enhancement-Configuration-49047.json | 5 +++++ 4 files changed, 20 insertions(+) create mode 100644 .changes/next-release/api-change-connectcases-87788.json create mode 100644 .changes/next-release/api-change-groundstation-47343.json create mode 100644 .changes/next-release/api-change-iam-7583.json create mode 100644 .changes/next-release/enhancement-Configuration-49047.json diff --git a/.changes/next-release/api-change-connectcases-87788.json b/.changes/next-release/api-change-connectcases-87788.json new file mode 100644 index 0000000000..1e47f1146e --- /dev/null +++ b/.changes/next-release/api-change-connectcases-87788.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``connectcases``", + "description": "[``botocore``] Increase maximum length of CommentBody to 3000, and increase maximum length of StringValue to 1500" +} diff --git a/.changes/next-release/api-change-groundstation-47343.json b/.changes/next-release/api-change-groundstation-47343.json new file mode 100644 index 0000000000..055f377312 --- /dev/null +++ b/.changes/next-release/api-change-groundstation-47343.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``groundstation``", + "description": "[``botocore``] This release will allow KMS alias names to be used when creating Mission Profiles" +} diff --git a/.changes/next-release/api-change-iam-7583.json b/.changes/next-release/api-change-iam-7583.json new file mode 100644 index 0000000000..81a3fe040d --- /dev/null +++ b/.changes/next-release/api-change-iam-7583.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``iam``", + "description": "[``botocore``] Updates to GetAccessKeyLastUsed action to replace NoSuchEntity error with AccessDeniedException error." +} diff --git a/.changes/next-release/enhancement-Configuration-49047.json b/.changes/next-release/enhancement-Configuration-49047.json new file mode 100644 index 0000000000..f94d59cdd5 --- /dev/null +++ b/.changes/next-release/enhancement-Configuration-49047.json @@ -0,0 +1,5 @@ +{ + "type": "enhancement", + "category": "Configuration", + "description": "[``botocore``] Adds client context params support to ``Config``." +} From 1c0db71eab61a0c59111ede48e473fe0703fddbf Mon Sep 17 00:00:00 2001 From: aws-sdk-python-automation Date: Wed, 25 Oct 2023 20:15:35 +0000 Subject: [PATCH 5/5] Bumping version to 1.28.71 --- .changes/1.28.71.json | 22 +++++++++++++++++++ .../api-change-connectcases-87788.json | 5 ----- .../api-change-groundstation-47343.json | 5 ----- .../next-release/api-change-iam-7583.json | 5 ----- .../enhancement-Configuration-49047.json | 5 ----- CHANGELOG.rst | 9 ++++++++ boto3/__init__.py | 2 +- setup.cfg | 2 +- setup.py | 2 +- 9 files changed, 34 insertions(+), 23 deletions(-) create mode 100644 .changes/1.28.71.json delete mode 100644 .changes/next-release/api-change-connectcases-87788.json delete mode 100644 .changes/next-release/api-change-groundstation-47343.json delete mode 100644 .changes/next-release/api-change-iam-7583.json delete mode 100644 .changes/next-release/enhancement-Configuration-49047.json diff --git a/.changes/1.28.71.json b/.changes/1.28.71.json new file mode 100644 index 0000000000..6e9500c101 --- /dev/null +++ b/.changes/1.28.71.json @@ -0,0 +1,22 @@ +[ + { + "category": "Configuration", + "description": "[``botocore``] Adds client context params support to ``Config``.", + "type": "enhancement" + }, + { + "category": "``connectcases``", + "description": "[``botocore``] Increase maximum length of CommentBody to 3000, and increase maximum length of StringValue to 1500", + "type": "api-change" + }, + { + "category": "``groundstation``", + "description": "[``botocore``] This release will allow KMS alias names to be used when creating Mission Profiles", + "type": "api-change" + }, + { + "category": "``iam``", + "description": "[``botocore``] Updates to GetAccessKeyLastUsed action to replace NoSuchEntity error with AccessDeniedException error.", + "type": "api-change" + } +] \ No newline at end of file diff --git a/.changes/next-release/api-change-connectcases-87788.json b/.changes/next-release/api-change-connectcases-87788.json deleted file mode 100644 index 1e47f1146e..0000000000 --- a/.changes/next-release/api-change-connectcases-87788.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "api-change", - "category": "``connectcases``", - "description": "[``botocore``] Increase maximum length of CommentBody to 3000, and increase maximum length of StringValue to 1500" -} diff --git a/.changes/next-release/api-change-groundstation-47343.json b/.changes/next-release/api-change-groundstation-47343.json deleted file mode 100644 index 055f377312..0000000000 --- a/.changes/next-release/api-change-groundstation-47343.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "api-change", - "category": "``groundstation``", - "description": "[``botocore``] This release will allow KMS alias names to be used when creating Mission Profiles" -} diff --git a/.changes/next-release/api-change-iam-7583.json b/.changes/next-release/api-change-iam-7583.json deleted file mode 100644 index 81a3fe040d..0000000000 --- a/.changes/next-release/api-change-iam-7583.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "api-change", - "category": "``iam``", - "description": "[``botocore``] Updates to GetAccessKeyLastUsed action to replace NoSuchEntity error with AccessDeniedException error." -} diff --git a/.changes/next-release/enhancement-Configuration-49047.json b/.changes/next-release/enhancement-Configuration-49047.json deleted file mode 100644 index f94d59cdd5..0000000000 --- a/.changes/next-release/enhancement-Configuration-49047.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "enhancement", - "category": "Configuration", - "description": "[``botocore``] Adds client context params support to ``Config``." -} diff --git a/CHANGELOG.rst b/CHANGELOG.rst index ab819341ce..08144f01c2 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,6 +2,15 @@ CHANGELOG ========= +1.28.71 +======= + +* enhancement:Configuration: [``botocore``] Adds client context params support to ``Config``. +* api-change:``connectcases``: [``botocore``] Increase maximum length of CommentBody to 3000, and increase maximum length of StringValue to 1500 +* api-change:``groundstation``: [``botocore``] This release will allow KMS alias names to be used when creating Mission Profiles +* api-change:``iam``: [``botocore``] Updates to GetAccessKeyLastUsed action to replace NoSuchEntity error with AccessDeniedException error. + + 1.28.70 ======= diff --git a/boto3/__init__.py b/boto3/__init__.py index 268368fad2..8e0bcb1adf 100644 --- a/boto3/__init__.py +++ b/boto3/__init__.py @@ -17,7 +17,7 @@ from boto3.session import Session __author__ = 'Amazon Web Services' -__version__ = '1.28.70' +__version__ = '1.28.71' # The default Boto3 session; autoloaded when needed. diff --git a/setup.cfg b/setup.cfg index 5b84bc5dba..d3e0cae846 100644 --- a/setup.cfg +++ b/setup.cfg @@ -3,7 +3,7 @@ universal = 0 [metadata] requires_dist = - botocore>=1.31.70,<1.32.0 + botocore>=1.31.71,<1.32.0 jmespath>=0.7.1,<2.0.0 s3transfer>=0.7.0,<0.8.0 diff --git a/setup.py b/setup.py index c0443a0296..91bbbf0f60 100644 --- a/setup.py +++ b/setup.py @@ -13,7 +13,7 @@ requires = [ - 'botocore>=1.31.70,<1.32.0', + 'botocore>=1.31.71,<1.32.0', 'jmespath>=0.7.1,<2.0.0', 's3transfer>=0.7.0,<0.8.0', ]