m

Author: Lucas McDonald

DynamoDbEncryption/runtimes/python/src/aws_dbesdk_dynamodb/encrypted/client.py

@@ -106,11 +106,11 @@ def put_item(self, **kwargs) -> dict[str, Any]:
         https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/client/put_item.html
 
         Args:
-            **kwargs: Keyword arguments to pass to the operation. This matches the boto3 ``put_item`` request syntax.
+            **kwargs: Keyword arguments to pass to the operation. This matches the boto3 client ``put_item`` request syntax.
                 The value in ``"Item"`` will be encrypted locally before being written to DynamoDB.
 
         Returns:
-            dict: The response from DynamoDB. This matches the boto3 ``put_item`` response syntax.
+            dict: The response from DynamoDB. This matches the boto3 client ``put_item`` response syntax.
 
         """
         return self._client_operation_logic(
@@ -135,10 +135,10 @@ def get_item(self, **kwargs) -> dict[str, Any]:
         https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/client/get_item.html
 
         Args:
-            **kwargs: Keyword arguments to pass to the operation. This matches the boto3 ``get_item`` request syntax.
+            **kwargs: Keyword arguments to pass to the operation. This matches the boto3 client ``get_item`` request syntax.
 
         Returns:
-            dict: The response from DynamoDB. This matches the boto3 ``get_item`` response syntax.
+            dict: The response from DynamoDB. This matches the boto3 client ``get_item`` response syntax.
             The value in ``"Item"`` field be decrypted locally after being read from DynamoDB.
 
         """
@@ -159,16 +159,16 @@ def query(self, **kwargs) -> dict[str, Any]:
         """
         Query items from a table or index. Decrypts any returned items.
 
-        The parameters and return value match the boto3 DynamoDB query API:
+        The input and output syntaxes match those for the boto3 DynamoDB client ``query`` API:
 
         https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/client/query.html
 
         Args:
             **kwargs: Keyword arguments to pass to the operation. These match the boto3 query API parameters.
 
         Returns:
-            dict: The response from DynamoDB. This matches the boto3 query API response.
-                The "Items" field will be decrypted locally after being read from DynamoDB.
+            dict: The response from DynamoDB. This matches the boto3 client ``query`` API response.
+                The ``"Items"`` field will be decrypted locally after being read from DynamoDB.
 
         """
         return self._client_operation_logic(
@@ -193,10 +193,10 @@ def scan(self, **kwargs) -> dict[str, Any]:
         https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/client/scan.html
 
         Args:
-            **kwargs: Keyword arguments to pass to the operation. This matches the boto3 ``scan`` request syntax.
+            **kwargs: Keyword arguments to pass to the operation. This matches the boto3 client ``scan`` request syntax.
 
         Returns:
-            dict: The response from DynamoDB. This matches the boto3 ``scan`` response syntax.
+            dict: The response from DynamoDB. This matches the boto3 client ``scan`` response syntax.
             The values in ``"Items"`` will be decrypted locally after being read from DynamoDB.
 
         """
@@ -224,12 +224,12 @@ def batch_write_item(self, **kwargs) -> dict[str, Any]:
         https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/client/batch_write_item.html
 
         Args:
-            **kwargs: Keyword arguments to pass to the operation. This matches the boto3 ``batch_write_item``
+            **kwargs: Keyword arguments to pass to the operation. This matches the boto3 client ``batch_write_item``
                 request syntax. Items in ``"PutRequest"`` values in the ``"RequestItems"`` argument will be encrypted
                 locally before being written to DynamoDB.
 
         Returns:
-            dict: The response from DynamoDB. This matches the boto3 ``batch_write_item`` response syntax.
+            dict: The response from DynamoDB. This matches the boto3 client ``batch_write_item`` response syntax.
 
         """
         return self._client_operation_logic(
@@ -258,7 +258,7 @@ def batch_get_item(self, **kwargs) -> dict[str, Any]:
                 request syntax.
 
         Returns:
-            dict: The response from DynamoDB. This matches the boto3 ``batch_get_item`` response syntax.
+            dict: The response from DynamoDB. This matches the boto3 client ``batch_get_item`` response syntax.
             The values in ``"Responses"`` will be decrypted locally after being read from DynamoDB.
 
         """
@@ -284,11 +284,11 @@ def transact_get_items(self, **kwargs) -> dict[str, Any]:
         https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/client/transact_get_items.html
 
         Args:
-            **kwargs: Keyword arguments to pass to the operation. This matches the boto3 ``transact_get_items``
+            **kwargs: Keyword arguments to pass to the operation. This matches the boto3 client ``transact_get_items``
                 request syntax.
 
         Returns:
-            dict: The response from DynamoDB. This matches the boto3 ``transact_get_items`` response syntax.
+            dict: The response from DynamoDB. This matches the boto3 client ``transact_get_items`` response syntax.
 
         """
         return self._client_operation_logic(
@@ -310,17 +310,17 @@ def transact_write_items(self, **kwargs) -> dict[str, Any]:
 
         For put operations, encrypts items before writing.
 
-        The input and output syntaxes match those for the boto3 DynamoDB ``transact_write_items`` API:
+        The input and output syntaxes match those for the boto3 DynamoDB client ``transact_write_items`` API:
 
         https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/client/transact_write_items.html
 
         Args:
-            **kwargs: Keyword arguments to pass to the operation. This matches the boto3 ``transact_write_items``
+            **kwargs: Keyword arguments to pass to the operation. This matches the boto3 client ``transact_write_items``
                 request syntax. Any ``"PutRequest"`` values in the ``"TransactItems"`` argument will be encrypted
                 locally before being written to DynamoDB.
 
         Returns:
-            dict: The response from DynamoDB. This matches the boto3 ``transact_write_items`` response syntax.
+            dict: The response from DynamoDB. This matches the boto3 client ``transact_write_items`` response syntax.
 
         """
         return self._client_operation_logic(

DynamoDbEncryption/runtimes/python/src/aws_dbesdk_dynamodb/encrypted/paginator.py

@@ -27,10 +27,11 @@
 
 
 class EncryptedPaginator(EncryptedBotoInterface):
-    """Wrapping class for botocore.paginate.Paginator that decrypts returned items before returning them."""
+    """Wrapping class for the boto3 Paginator that decrypts returned items before returning them."""
 
     def __init__(
         self,
+        *,
         paginator: Paginator,
         encryption_config: DynamoDbTablesEncryptionConfig,
         expect_standard_dictionaries: bool | None = False,

DynamoDbEncryption/runtimes/python/src/aws_dbesdk_dynamodb/encrypted/resource.py

@@ -28,7 +28,7 @@
 
 class EncryptedTablesCollectionManager(EncryptedBotoInterface):
     """
-    Tables collection manager that provides EncryptedTable objects.
+    Collection manager that provides EncryptedTable objects.
 
     The API matches boto3's tables collection manager interface:
     https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/tables.html
@@ -131,16 +131,17 @@ class EncryptedResource(EncryptedBotoInterface):
     drop-in replacement that transparently handles encryption and decryption of items.
 
     The API matches the standard boto3 DynamoDB resource interface:
+
     https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/index.html
 
     This class will encrypt/decrypt items for the following operations:
-        * batch_get_item
-        * batch_write_item
+        * ``batch_get_item``
+        * ``batch_write_item``
 
-    Calling Table() will return an EncryptedTable object.
+    Calling ``Table()`` will return an ``EncryptedTable`` object.
 
     Any other operations on this class will defer to the underlying boto3 DynamoDB resource's implementation
-        and will not be encrypted/decrypted.
+    and will not be encrypted/decrypted.
 
     """
 
@@ -151,7 +152,7 @@ def __init__(
         encryption_config: DynamoDbTablesEncryptionConfig,
     ):
         """
-        Create an EncryptedResource object.
+        Create an ``EncryptedResource`` object.
 
         Args:
             resource (ServiceResource): Initialized boto3 DynamoDB resource
@@ -169,15 +170,15 @@ def __init__(
 
     def Table(self, name):
         """
-        Create an EncryptedTable resource.
+        Create an ``EncryptedTable`` resource.
 
         https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/Table.html
 
         Args:
             name (str): The EncryptedTable's name identifier. This must be set.
 
         Returns:
-            EncryptedTable: An EncryptedTable resource
+            EncryptedTable: An ``EncryptedTable`` resource
 
         """
         return EncryptedTable(table=self._resource.Table(name), encryption_config=self._encryption_config)
@@ -186,15 +187,17 @@ def batch_get_item(self, **kwargs):
         """
         Get multiple items from one or more tables. Decrypts any returned items.
 
-        The parameters and return value match the boto3 DynamoDB batch_get_item API:
+        The input and output syntaxes match those for the boto3 DynamoDB resource ``batch_get_item`` API:
+
         https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/batch_get_item.html
 
         Args:
-            **kwargs: Keyword arguments to pass to the operation. These match the boto3 batch_get_item API parameters.
+            **kwargs: Keyword arguments to pass to the operation. These match the boto3 resource ``batch_get_item``
+                request syntax.
 
         Returns:
-            dict: The response from DynamoDB. This matches the boto3 batch_get_item API response.
-                The "Responses" field will be decrypted locally after being read from DynamoDB.
+            dict: The response from DynamoDB. This matches the boto3 resource ``batch_get_item`` response syntax.
+            The ``"Responses"`` field will be decrypted locally after being read from DynamoDB.
 
         """
         return self._resource_operation_logic(
@@ -216,16 +219,17 @@ def batch_write_item(self, **kwargs):
 
         For put operations, encrypts items before writing.
 
-        The parameters and return value match the boto3 DynamoDB batch_write_item API:
+        The input and output syntaxes match those for the boto3 DynamoDB resource ``batch_write_item`` API:
+
         https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/batch_write_item.html
 
         Args:
-            **kwargs: Keyword arguments to pass to the operation. These match the boto3 batch_write_item API parameters.
-                Any put operations in the "RequestItems" argument will be encrypted locally
-                before being written to DynamoDB.
+            **kwargs: Keyword arguments to pass to the operation. These match the boto3 resource
+                ``batch_write_item`` request syntax. Any ``"PutRequest"`` values in the ``"RequestItems"``
+                argument will be encrypted locally before being written to DynamoDB.
 
         Returns:
-            dict: The response from DynamoDB. This matches the boto3 batch_write_item API response.
+            dict: The response from DynamoDB. This matches the boto3 resource ``batch_write_item`` response syntax.
 
         """
         return self._resource_operation_logic(

DynamoDbEncryption/runtimes/python/src/aws_dbesdk_dynamodb/encrypted/table.py

@@ -38,7 +38,7 @@ class EncryptedTable(EncryptedBotoInterface):
 
     The API matches the standard boto3 DynamoDB table interface:
 
-    https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table.html
+    https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/index.html
 
     This class will encrypt/decrypt items for the following operations:
         * ``put_item``
@@ -119,7 +119,7 @@ def get_item(self, **kwargs) -> dict[str, Any]:
 
         Returns:
             dict: The response from DynamoDB. This matches the boto3 Table ``get_item`` response syntax.
-                The value in ``"Item"`` will be decrypted locally after being read from DynamoDB.
+            The value in ``"Item"`` will be decrypted locally after being read from DynamoDB.
 
         """
         return self._table_operation_logic(
@@ -149,7 +149,7 @@ def query(self, **kwargs) -> dict[str, Any]:
 
         Returns:
             dict: The response from DynamoDB. This matches the boto3 Table ``query`` response syntax.
-                The value in ``"Items"`` will be decrypted locally after being read from DynamoDB.
+            The value in ``"Items"`` will be decrypted locally after being read from DynamoDB.
 
         """
         return self._table_operation_logic(
@@ -179,7 +179,7 @@ def scan(self, **kwargs) -> dict[str, Any]:
 
         Returns:
             dict: The response from DynamoDB. This matches the boto3 Table ``scan`` response syntax.
-                The value in ``"Items"`` will be decrypted locally after being read from DynamoDB.
+            The value in ``"Items"`` will be decrypted locally after being read from DynamoDB.
 
         """
         return self._table_operation_logic(