Skip to content

Commit 6d6ff5b

Browse files
authored
Update legacy documentation links (#4722)
* Update legacy botocore documentation links * Update legacy boto3 documentation links * Update fragment based links to new URL structure
1 parent 80224c1 commit 6d6ff5b

40 files changed

Lines changed: 169 additions & 170 deletions

.changes/1.4.0.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
},
2727
{
2828
"category": "s3",
29-
"description": "Port ``s3.transfer`` module to use ``s3transfer`` package. Please refer to `Upgrading Notes <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/upgrading.html>`_ when upgrading. In porting the logic over, various performance issues and bugs were fixed.",
29+
"description": "Port ``s3.transfer`` module to use ``s3transfer`` package. Please refer to `Upgrading Notes <https://docs.aws.amazon.com/boto3/latest/guide/upgrading.html>`_ when upgrading. In porting the logic over, various performance issues and bugs were fixed.",
3030
"type": "bugfix"
3131
},
3232
{

.changes/1.9.0.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@
1111
},
1212
{
1313
"category": "Events",
14-
"description": "[``botocore``] This migrates the event system to using sevice ids instead of either client name or endpoint prefix. This prevents issues that might arise when a service changes their endpoint prefix, also fixes a long-standing bug where you could not register an event to a particular service if it happened to share its endpoint prefix with another service (e.g. ``autoscaling`` and ``application-autoscaling`` both use the endpoint prefix ``autoscaling``). Please see the `upgrade notes <https://botocore.amazonaws.com/v1/documentation/api/latest/index.html#upgrade-notes>`_ to determine if you are impacted and how to proceed if you are.",
14+
"description": "[``botocore``] This migrates the event system to using sevice ids instead of either client name or endpoint prefix. This prevents issues that might arise when a service changes their endpoint prefix, also fixes a long-standing bug where you could not register an event to a particular service if it happened to share its endpoint prefix with another service (e.g. ``autoscaling`` and ``application-autoscaling`` both use the endpoint prefix ``autoscaling``). Please see the `upgrade notes <https://docs.aws.amazon.com/botocore/latest/#upgrade-notes>`_ to determine if you are impacted and how to proceed if you are.",
1515
"type": "feature"
1616
},
1717
{
1818
"category": "Events",
19-
"description": "This migrates the event system to using sevice ids instead of either client name or endpoint prefix. This prevents issues that might arise when a service changes their endpoint prefix, also fixes a long-standing bug where you could not register an event to a particular service if it happened to share its endpoint prefix with another service (e.g. ``autoscaling`` and ``application-autoscaling`` both use the endpoint prefix ``autoscaling``). Please see the `upgrade notes <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/upgrading.html>`_ to determine if you are impacted and how to proceed if you are.",
19+
"description": "This migrates the event system to using sevice ids instead of either client name or endpoint prefix. This prevents issues that might arise when a service changes their endpoint prefix, also fixes a long-standing bug where you could not register an event to a particular service if it happened to share its endpoint prefix with another service (e.g. ``autoscaling`` and ``application-autoscaling`` both use the endpoint prefix ``autoscaling``). Please see the `upgrade notes <https://docs.aws.amazon.com/boto3/latest/guide/upgrading.html>`_ to determine if you are impacted and how to proceed if you are.",
2020
"type": "feature"
2121
}
2222
]

CHANGELOG.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18710,8 +18710,8 @@ AWS Marketplace OfferSets support for opportunities
1871018710

1871118711
* api-change:``logs``: [``botocore``] Update logs client to latest version
1871218712
* api-change:``config``: [``botocore``] Update config client to latest version
18713-
* feature:Events: [``botocore``] This migrates the event system to using sevice ids instead of either client name or endpoint prefix. This prevents issues that might arise when a service changes their endpoint prefix, also fixes a long-standing bug where you could not register an event to a particular service if it happened to share its endpoint prefix with another service (e.g. ``autoscaling`` and ``application-autoscaling`` both use the endpoint prefix ``autoscaling``). Please see the `upgrade notes <https://botocore.amazonaws.com/v1/documentation/api/latest/index.html#upgrade-notes>`_ to determine if you are impacted and how to proceed if you are.
18714-
* feature:Events: This migrates the event system to using sevice ids instead of either client name or endpoint prefix. This prevents issues that might arise when a service changes their endpoint prefix, also fixes a long-standing bug where you could not register an event to a particular service if it happened to share its endpoint prefix with another service (e.g. ``autoscaling`` and ``application-autoscaling`` both use the endpoint prefix ``autoscaling``). Please see the `upgrade notes <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/upgrading.html>`_ to determine if you are impacted and how to proceed if you are.
18713+
* feature:Events: [``botocore``] This migrates the event system to using sevice ids instead of either client name or endpoint prefix. This prevents issues that might arise when a service changes their endpoint prefix, also fixes a long-standing bug where you could not register an event to a particular service if it happened to share its endpoint prefix with another service (e.g. ``autoscaling`` and ``application-autoscaling`` both use the endpoint prefix ``autoscaling``). Please see the `upgrade notes <https://docs.aws.amazon.com/botocore/latest/#upgrade-notes>`_ to determine if you are impacted and how to proceed if you are.
18714+
* feature:Events: This migrates the event system to using sevice ids instead of either client name or endpoint prefix. This prevents issues that might arise when a service changes their endpoint prefix, also fixes a long-standing bug where you could not register an event to a particular service if it happened to share its endpoint prefix with another service (e.g. ``autoscaling`` and ``application-autoscaling`` both use the endpoint prefix ``autoscaling``). Please see the `upgrade notes <https://docs.aws.amazon.com/boto3/latest/guide/upgrading.html>`_ to determine if you are impacted and how to proceed if you are.
1871518715

1871618716

1871718717
1.8.9
@@ -19985,7 +19985,7 @@ AWS Marketplace OfferSets support for opportunities
1998519985
* bugfix:Session: Fixed Session.__repr__ region argument name.
1998619986
* feature:s3: Add managed copies to S3 client, Bucket, and Object.
1998719987
* feature:s3: Add managed downloads to file-like objects in the S3 client, Bucket, and Object.
19988-
* bugfix:s3: Port ``s3.transfer`` module to use ``s3transfer`` package. Please refer to `Upgrading Notes <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/upgrading.html>`_ when upgrading. In porting the logic over, various performance issues and bugs were fixed.
19988+
* bugfix:s3: Port ``s3.transfer`` module to use ``s3transfer`` package. Please refer to `Upgrading Notes <https://docs.aws.amazon.com/boto3/latest/guide/upgrading.html>`_ when upgrading. In porting the logic over, various performance issues and bugs were fixed.
1998919989
* feature:s3: Add ``io_chunksize`` parameter to ``TransferConfig``
1999019990

1999119991

CONTRIBUTING.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
For more information, please see the official docs at
2-
https://boto3.amazonaws.com/v1/documentation/api/latest/index.html
2+
https://docs.aws.amazon.com/boto3/latest/
33

44
Contributing Code
55
-----------------

README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ For more information on deprecations, see this
2929
`blog post <https://aws.amazon.com/blogs/developer/python-support-policy-updates-for-aws-sdks-and-tools/>`__.
3030

3131
.. _boto: https://docs.pythonboto.org/
32-
.. _`doc site`: https://boto3.amazonaws.com/v1/documentation/api/latest/index.html
32+
.. _`doc site`: https://docs.aws.amazon.com/boto3/latest/
3333
.. _`Amazon Web Services`: https://aws.amazon.com/what-is-aws/
3434
.. |Python| image:: https://img.shields.io/pypi/pyversions/boto3.svg?style=flat
3535
:target: https://pypi.python.org/pypi/boto3/
@@ -87,7 +87,7 @@ Then, set up a default region (in e.g. ``~/.aws/config``):
8787
[default]
8888
region = us-east-1
8989
90-
Other credential configuration methods can be found `here <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html>`__
90+
Other credential configuration methods can be found `here <https://docs.aws.amazon.com/boto3/latest/guide/credentials.html>`__
9191

9292
Then, from a Python interpreter:
9393

boto3/docs/service.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,7 @@ def __init__(self, service_name, session, root_docs_path):
5050
]
5151
self._root_docs_path = root_docs_path
5252
self._USER_GUIDE_LINK = (
53-
'https://boto3.amazonaws.com/'
54-
'v1/documentation/api/latest/guide/resources.html'
53+
'https://docs.aws.amazon.com/boto3/latest/guide/resources.html'
5554
)
5655

5756
def document_service(self):

boto3/session.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -307,7 +307,7 @@ def client(
307307
over environment variables and configuration values, but not over
308308
a region_name value passed explicitly to the method. See
309309
`botocore config documentation
310-
<https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html>`_
310+
<https://docs.aws.amazon.com/botocore/latest/reference/config.html>`_
311311
for more details.
312312
313313
:type aws_account_id: string
@@ -416,7 +416,7 @@ def resource(
416416
user_agent_extra is specified in the client config, it overrides
417417
the default user_agent_extra provided by the resource API. See
418418
`botocore config documentation
419-
<https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html>`_
419+
<https://docs.aws.amazon.com/botocore/latest/reference/config.html>`_
420420
for more details.
421421
422422
:return: Subclass of :py:class:`~boto3.resources.base.ServiceResource`

docs/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Boto3 Documentation
22
~~~~~~~~~~~~~~~~~~~
3-
Documentation for boto3 can be found `here <https://boto3.amazonaws.com/v1/documentation/api/latest/index.html>`_.
3+
Documentation for boto3 can be found `here <https://docs.aws.amazon.com/boto3/latest/>`_.
44

55
Generating Documentation
66
~~~~~~~~~~~~~~~~~~~~~~~~

docs/source/guide/clients.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,4 +161,4 @@ General Example
161161
with ThreadPoolExecutor(max_workers=8) as executor:
162162
futures = [executor.submit(do_s3_task, s3_client, task) for task in my_tasks]
163163
164-
.. _Botocore Events: https://botocore.amazonaws.com/v1/documentation/api/latest/topics/events.html
164+
.. _Botocore Events: https://docs.aws.amazon.com/botocore/latest/topics/events.html

docs/source/guide/configuration.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@ This option is for configuring client-specific configurations that affect the be
2424

2525
* ``region_name`` (string) - The AWS Region used in instantiating the client. If used, this takes precedence over environment variable and configuration file values. But it doesn't overwrite a ``region_name`` value *explicitly* passed to individual service methods.
2626
* ``signature_version`` (string) - The signature version used when signing requests. Note that the default version is Signature Version 4. If you're using a presigned URL with an expiry of greater than 7 days, you should specify Signature Version 2.
27-
* ``s3`` (related configurations; dictionary) - Amazon S3 service-specific configurations. For more information, see the `Botocore config reference <https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html>`_.
27+
* ``s3`` (related configurations; dictionary) - Amazon S3 service-specific configurations. For more information, see the `Botocore config reference <https://docs.aws.amazon.com/botocore/latest/reference/config.html>`_.
2828
* ``proxies`` (dictionary) - Each entry maps a protocol name to the proxy server Boto3 should use to communicate using that protocol. See :ref:`specify_proxies` for more information.
2929
* ``proxies_config`` (dictionary) - Additional proxy configuration settings. For more information, see :ref:`configure_proxies`.
3030
* ``retries`` (dictionary) - Client retry behavior configuration options that include retry mode and maximum retry attempts. For more information, see the :ref:`guide_retries` guide.
3131

3232

33-
For more information about additional options, or for a complete list of options, see the `Config reference <https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html>`_.
33+
For more information about additional options, or for a complete list of options, see the `Config reference <https://docs.aws.amazon.com/botocore/latest/reference/config.html>`_.
3434

3535
To set these configuration options, create a ``Config`` object with the options you want, and then pass them into your client.
3636

@@ -89,7 +89,7 @@ Alternatively, you can use the ``HTTP_PROXY`` and ``HTTPS_PROXY`` environment va
8989

9090
Configuring proxies
9191
'''''''''''''''''''
92-
You can configure how Boto3 uses proxies by specifying the ``proxies_config`` option, which is a dictionary that specifies the values of several proxy options by name. There are three keys in this dictionary: ``proxy_ca_bundle``, ``proxy_client_cert``, and ``proxy_use_forwarding_for_https``. For more information about these keys, see the `Botocore config reference <https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config>`_.
92+
You can configure how Boto3 uses proxies by specifying the ``proxies_config`` option, which is a dictionary that specifies the values of several proxy options by name. There are three keys in this dictionary: ``proxy_ca_bundle``, ``proxy_client_cert``, and ``proxy_use_forwarding_for_https``. For more information about these keys, see the `Botocore config reference <https://docs.aws.amazon.com/botocore/latest/reference/config.html#botocore.config.Config>`_.
9393

9494
.. code-block:: python
9595

0 commit comments

Comments
 (0)