Fix broken links in docs (pynamodb#1135)

ikonst · web-flow · commit 117176164196 · 2022-12-10T17:53:14.000-05:00
diff --git a/README.rst b/README.rst
@@ -9,9 +9,9 @@ PynamoDB
 .. image:: https://github.com/pynamodb/PynamoDB/workflows/Tests/badge.svg
     :target: https://github.com/pynamodb/PynamoDB/actions
 .. image:: https://img.shields.io/coveralls/pynamodb/PynamoDB/master.svg
-    :target: https://coveralls.io/r/pynamodb/PynamoDB
+    :target: https://coveralls.io/github/pynamodb/PynamoDB
 
-A Pythonic interface for Amazon's `DynamoDB <http://aws.amazon.com/dynamodb/>`_.
+A Pythonic interface for Amazon's `DynamoDB <https://aws.amazon.com/dynamodb/>`_.
 
 DynamoDB is a great NoSQL service provided by Amazon, but the API is verbose.
 PynamoDB presents you with a simple, elegant API.
diff --git a/docs/attributes.rst b/docs/attributes.rst
@@ -2,7 +2,7 @@ Custom Attributes
 ==========================
 
 Attributes in PynamoDB are classes that are serialized to and from DynamoDB attributes. PynamoDB provides attribute classes
-for all DynamoDB data types, as defined in the `DynamoDB documentation <http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html>`_.
+for all DynamoDB data types, as defined in the `DynamoDB documentation <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html>`_.
 Higher level attribute types (internally stored as a DynamoDB data types) can be defined with PynamoDB. Two such types
 are included with PynamoDB for convenience: ``JSONAttribute`` and ``UTCDateTimeAttribute``.
 
@@ -193,7 +193,7 @@ These attributes can then be used inside of Model classes just like any other at
         make = UnicodeAttribute(null=False)
         model = UnicodeAttribute(null=True)
 
-`As with a model and its top-level attributes <https://github.com/pynamodb/PynamoDB/blob/master/docs/quickstart.rst#changing-items>`_, a PynamoDB MapAttribute will ignore sub-attributes it does not know about during deserialization. As a result, if the item in DynamoDB contains sub-attributes not declared as properties of the corresponding MapAttribute, save() will cause those sub-attributes to be deleted.
+:ref:`As with a model and its top-level attributes <changing-items>`, a PynamoDB MapAttribute will ignore sub-attributes it does not know about during deserialization. As a result, if the item in DynamoDB contains sub-attributes not declared as properties of the corresponding MapAttribute, save() will cause those sub-attributes to be deleted.
 
 ``DynamicMapAttribute`` is a subclass of ``MapAttribute`` which allows you to mix and match defined attributes and undefined attributes.
 
diff --git a/docs/awsaccess.rst b/docs/awsaccess.rst
@@ -4,12 +4,12 @@ AWS Access
 PynamoDB uses botocore to interact with the DynamoDB API. Thus, any method of configuration supported by ``botocore`` works with PynamoDB.
 For local development the use of environment variables such as `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`
 is probably preferable. You can of course use IAM users, as recommended by AWS. In addition
-`EC2 roles <http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html>`_ will work as well and
+`EC2 roles <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html>`_ will work as well and
 would be recommended when running on EC2.
 
 As for the permissions granted via IAM, many tasks can be carried out by PynamoDB. So you should construct your
 policies as required, see the
-`DynamoDB <http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/UsingIAMWithDDB.html>`_ docs for more
+`DynamoDB <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/authentication-and-access-control.html>`_ docs for more
 information.
 
 If for some reason you can't use conventional AWS configuration methods, you can set the credentials in the Model Meta class:
@@ -24,5 +24,5 @@ If for some reason you can't use conventional AWS configuration methods, you can
             aws_secret_access_key = 'my_secret_access_key'
             aws_session_token = 'my_session_token' # Optional, only for temporary credentials like those received when assuming a role
 
-Finally, see the `AWS CLI documentation <http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html#cli-installing-credentials>`_
+Finally, see the `AWS CLI documentation <https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html>`_
 for more details on how to pass credentials to botocore.
diff --git a/docs/conditional.rst b/docs/conditional.rst
@@ -4,7 +4,7 @@ Conditional Operations
 ======================
 
 Some DynamoDB operations (UpdateItem, PutItem, DeleteItem) support the inclusion of conditions. The user can supply a condition to be
-evaluated by DynamoDB before the operation is performed. See the `official documentation <http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#WorkingWithItems.ConditionalUpdate>`_
+evaluated by DynamoDB before the operation is performed. See the `official documentation <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#WorkingWithItems.ConditionalUpdate>`_
 for more details.
 
 Suppose that you have defined a `Thread` Model for the examples below.
@@ -32,7 +32,7 @@ Condition Expressions
 
 PynamoDB supports creating condition expressions from attributes using a mix of built-in operators and method calls.
 Any value provided will be serialized using the serializer defined for that attribute.
-See the `comparison operator and function reference <http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html>`_
+See the `comparison operator and function reference <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html>`_
 for more details.
 
 .. csv-table::
diff --git a/docs/contributing.rst b/docs/contributing.rst
@@ -2,7 +2,7 @@ Contributing
 ============
 
 Pull requests are welcome, forking from the ``master`` branch. If you are new to GitHub, be sure and check out
-GitHub's `Hello World <https://guides.github.com/activities/hello-world/>`_ tutorial.
+GitHub's `Hello World <https://docs.github.com/en/get-started/quickstart/hello-world>`_ tutorial.
 
 
 Environment Setup
@@ -115,7 +115,7 @@ maintainers to populate the release notes.
 Documentation
 -------------
 
-Docs are built using `sphinx <https://www.sphinx-doc.org/en/1.5.1/>`_ and
-available on `readthedocs <https://pynamodb.readthedocs.io/>`_. A release
+Docs are built using `sphinx <https://www.sphinx-doc.org/>`_ and
+the latest are available on `readthedocs <https://pynamodb.readthedocs.io/en/latest/>`_. A release
 of the `latest` tag (tracking master) happens automatically on merge via
-a Github webhook.
+a GitHub webhook.
diff --git a/docs/index.rst b/docs/index.rst
@@ -17,7 +17,7 @@ Features
 * Support for Global and Local Secondary Indexes
 * Batch operations with automatic pagination
 * Iterators for working with Query and Scan operations
-* `Fully tested <https://coveralls.io/r/pynamodb/PynamoDB>`_
+* `Fully tested <https://coveralls.io/github/pynamodb/PynamoDB>`_
 
 Topics
 ======
diff --git a/docs/indexes.rst b/docs/indexes.rst
@@ -3,7 +3,7 @@ Index Queries
 
 DynamoDB supports two types of indexes: global secondary indexes, and local secondary indexes.
 Indexes can make accessing your data more efficient, and should be used when appropriate. See
-`the documentation for more information <http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/SecondaryIndexes.html>`__.
+`the documentation for more information <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/SecondaryIndexes.html>`__.
 
 Index Settings
 ^^^^^^^^^^^^^^
diff --git a/docs/local.rst b/docs/local.rst
@@ -6,7 +6,7 @@ Use PynamoDB Locally
 Several DynamoDB compatible servers have been written for testing and debugging purposes. PynamoDB can be
 used with any server that provides the same API as DynamoDB.
 
-PynamoDB has been tested with two DynamoDB compatible servers, `DynamoDB Local <http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tools.DynamoDBLocal.html>`_
+PynamoDB has been tested with two DynamoDB compatible servers, `DynamoDB Local <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.html>`_
 and `dynalite <https://github.com/mhart/dynalite>`_.
 
 To use a local server, you need to set the ``host`` attribute on your ``Model``'s ``Meta`` class to the hostname and port
@@ -34,7 +34,7 @@ that your server is listening on.
 Running dynalite
 ^^^^^^^^^^^^^^^^
 
-Make sure you have the Node Package Manager installed (see `npm instructions <https://www.npmjs.org/doc/README.html>`_).
+Make sure you have the Node Package Manager installed (see `npm instructions <https://docs.npmjs.com/>`_).
 
 Install dynalite::
 
@@ -52,13 +52,13 @@ Running DynamoDB Local
 
 DynamoDB local is a tool provided by Amazon that mocks the DynamoDB API, and uses a local file to
 store your data. You can use DynamoDB local with PynamoDB for testing, debugging, or offline development.
-For more information, you can read `Amazon's Announcement <http://aws.amazon.com/about-aws/whats-new/2013/09/12/amazon-dynamodb-local/>`_ and
-`Jeff Barr's blog post <http://aws.typepad.com/aws/2013/09/dynamodb-local-for-desktop-development.html>`_ about it.
+For more information, you can read `Amazon's Announcement <https://aws.amazon.com/about-aws/whats-new/2013/09/12/amazon-dynamodb-local/>`_ and
+`Jeff Barr's blog post <https://aws.amazon.com/blogs/aws/dynamodb-local-for-desktop-development/>`_ about it.
 
-* Download the `latest version of DynamoDB local <http://dynamodb-local.s3-website-us-west-2.amazonaws.com/dynamodb_local_latest>`_.
+* Download the `latest version of DynamoDB Local <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.DownloadingAndRunning.html>`_.
 * Unpack the contents of the archive into a directory of your choice.
 
-DynamoDB local requires the `Java Runtime Environment <http://java.com/en/>`_ version 7. Make sure the JRE is installed before continuing.
+DynamoDB local requires the `Java Runtime Environment <https://www.java.com/en/>`_ version 7. Make sure the JRE is installed before continuing.
 
 From the directory where you unpacked DynamoDB local, you can launch it like this:
 
diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -62,6 +62,8 @@ Ready to delete the user?
 
     >>> user.delete()
 
+.. _changing-items:
+
 Changing items
 ^^^^^^^^^^^^^^
 
@@ -85,7 +87,7 @@ Use of `update()` (in its simplest form) looks like this::
     )
 
 `save()` will entirely replace an object (it internally uses `PutItem
-<http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html>`_). As
+<https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html>`_). As
 a consequence, even if you modify only one attribute prior to calling
 `save()`, the entire object is re-written. Any modifications done to
 the same user by other processes will be lost, even if made to other
diff --git a/docs/release_notes.rst b/docs/release_notes.rst
@@ -510,7 +510,7 @@ will cause a warning to be logged.
 
 New features in this release:
 
-* Add support for current version of `DynamoDB API <http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Appendix.CurrentAPI.html>`_
+* Add support for current version of DynamoDB API
 * Improved ``MapAttribute`` item assignment and access.
 
 Contributors to this release:
@@ -546,7 +546,7 @@ If your project was calling those low level methods a warning will be logged.
 
 New features in this release:
 
-* Add support for current version of `DynamoDB API <http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Appendix.CurrentAPI.html>`_
+* Add support for current version of DynamoDB API
 
 Contributors to this release:
 
@@ -593,7 +593,7 @@ This is a major release with breaking changes.
 ``MapAttribute`` now allows pythonic access when recursively defined.
 If you were not using the ``attr_name=`` kwarg then you should have no problems upgrading.
 Previously defined non subclassed ``MapAttributes`` (raw ``MapAttributes``) that were members of a subclassed ``MapAttribute`` (typed ``MapAttributes``) would have to be accessed like a dictionary.
-Now object access is possible and recommended. See [here](https://github.com/pynamodb/PynamoDB/blob/master/pynamodb/tests/test_attributes.py#L671) for a test example.
+Now object access is possible and recommended.
 Access via the ``attr_name``, also known as the DynamoDB name, will now throw an ``AttributeError``.
 
 ``UnicodeSetAttributes`` do not json serialize or deserialize anymore.
@@ -1131,7 +1131,7 @@ v1.2.0
 
 * Numerous documentation improvements
 * Improved support for conditional operations
-* Added support for filtering queries on non key attributes (http://aws.amazon.com/blogs/aws/improved-queries-and-updates-for-dynamodb/)
+* Added support for filtering queries on non key attributes (https://aws.amazon.com/blogs/aws/improved-queries-and-updates-for-dynamodb/)
 * Fixed issue with JSON loading where escaped characters caused an error (#17)
 * Minor bug fixes
 
diff --git a/docs/settings.rst b/docs/settings.rst
@@ -40,7 +40,7 @@ base_backoff_ms
 Default: ``25``
 
 The base number of milliseconds used for `exponential backoff and jitter
-<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ on retries.
+<https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/>`_ on retries.
 
 
 region
diff --git a/docs/signals.rst b/docs/signals.rst
@@ -44,5 +44,5 @@ To subscribe to a signal, the user needs to import the signal object and connect
     pre_dynamodb_send.connect(record_pre_dynamodb_send)
     post_dynamodb_send.connect(record_post_dynamodb_send)
 
-.. _blinker: https://pypi.python.org/pypi/blinker
+.. _blinker:  https://pypi.org/project/blinker/
 .. _Dynamo action: https://github.com/pynamodb/PynamoDB/blob/cd705cc4e0e3dd365c7e0773f6bc02fe071a0631/
diff --git a/docs/tutorial.rst b/docs/tutorial.rst
@@ -30,9 +30,9 @@ Installation
     $ pip install pynamodb
 
 
-Don't have pip? `Here are instructions for installing pip <https://pip.readthedocs.io/en/latest/installing.html>`_.
+Don't have pip? `Here are instructions for installing pip <https://pip.pypa.io/en/latest/installing/>`_.
 
-Alternatively, if you are running `Anaconda or miniconda <https://www.anaconda.com/distribution/#download-section>`_, use:
+Alternatively, if you are running `Anaconda or miniconda <https://www.anaconda.com/products/distribution>`_, use:
 
 ::
 
@@ -45,7 +45,7 @@ Getting Started
 PynamoDB provides three API levels, a ``Connection``, a ``TableConnection``, and a ``Model``.
 Each API is built on top of the previous, and adds higher level features. Each API level is
 fully featured, and can be used directly. Before you begin, you should already have an
-`Amazon Web Services account <http://aws.amazon.com/>`__, and have your
+`Amazon Web Services account <https://aws.amazon.com/>`__, and have your
 `AWS credentials configured your boto <https://boto.readthedocs.io/en/latest/boto_config_tut.html>`__.
 
 Defining a Model
@@ -55,7 +55,7 @@ The most powerful feature of PynamoDB is the ``Model`` API. You start using it b
 class that inherits from ``pynamodb.models.Model``. Then, you add attributes to the model that
 inherit from ``pynamodb.attributes.Attribute``. The most common attributes have already been defined for you.
 
-Here is an example, using the same table structure as shown in `Amazon's DynamoDB Thread example <http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/SampleTablesAndData.html>`__.
+Here is an example, using the same table structure as shown in `Amazon's DynamoDB Thread example <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/AppendixSampleTables.html>`__.
 
 .. note::
 
@@ -126,7 +126,7 @@ can even be a function.
 
 .. note::
 
-    `DynamoDB will not store empty attributes <http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html>`_.
+    `DynamoDB will not store empty attributes <https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html>`_.
     By default, an ``Attribute`` cannot be ``None`` unless you specify ``null=True`` in the
     attribute constructor.
 
diff --git a/docs/updates.rst b/docs/updates.rst
@@ -2,7 +2,7 @@ Update Operations
 =================
 
 The UpdateItem DynamoDB operations allows you to create or modify attributes of an item using an update expression.
-See the `official documentation <http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.UpdateExpressions.html>`_
+See the `official documentation <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.UpdateExpressions.html>`_
 for more details.
 
 Suppose that you have defined a `Thread` Model for the examples below.
diff --git a/docs/versioning.rst b/docs/versioning.rst
@@ -1,8 +1,8 @@
 Versioning Scheme
 =================
 
-PynamoDB conforms to `PEP 440 <https://www.python.org/dev/peps/pep-0440>`__.
-Generally, PynamoDB uses `Semantic Versioning <http://semver.org/>`__, where the version number has
+PynamoDB conforms to `PEP 440 <https://peps.python.org/pep-0440/>`__.
+Generally, PynamoDB uses `Semantic Versioning <https://semver.org/>`__, where the version number has
 the format:
 
 ``MAJOR`` . ``MINOR`` . ``PATCH``
diff --git a/pynamodb/connection/base.py b/pynamodb/connection/base.py
@@ -478,7 +478,7 @@ def _make_api_call(self, operation_name: str, operation_kwargs: Dict, settings:
                         raise
                     else:
                         # We use fully-jittered exponentially-backed-off retries:
-                        #  https://www.awsarchitectureblog.com/2015/03/backoff.html
+                        #  https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/
                         sleep_time_ms = random.randint(0, self._base_backoff_ms * (2 ** i))
                         log.debug(
                             'Retry with backoff needed for (%s) after attempt %s,'
diff --git a/pynamodb/pagination.py b/pynamodb/pagination.py
@@ -76,8 +76,8 @@ class PageIterator(Iterator[_T]):
     """
     PageIterator handles Query and Scan result pagination.
 
-    http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html#Query.Pagination
-    http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.Pagination
+    https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.Pagination.html
+    https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.Pagination
     """
     def __init__(
         self,
@@ -155,8 +155,8 @@ class ResultIterator(Iterator[_T]):
     """
     ResultIterator handles Query and Scan item pagination.
 
-    http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html#Query.Pagination
-    http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.Pagination
+    https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.Pagination.html
+    https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.Pagination
     """
     def __init__(
         self,
