m

Author: Lucas McDonald

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

@@ -104,6 +104,7 @@ def put_item(self, **kwargs) -> dict[str, Any]:
 
         Args:
             **kwargs: Keyword arguments to pass to the operation. These match the boto3 put_item API parameters.
+                The "Item" argument will be encrypted locally before being written to DynamoDB.
 
         Returns:
             dict: The response from DynamoDB. This matches the boto3 put_item API response.
@@ -134,6 +135,7 @@ def get_item(self, **kwargs) -> dict[str, Any]:
 
         Returns:
             dict: The response from DynamoDB. This matches the boto3 get_item API response.
+                The "Item" field will be decrypted locally after being read from DynamoDB.
 
         """
         return self._client_operation_logic(
@@ -161,6 +163,7 @@ def query(self, **kwargs) -> dict[str, Any]:
 
         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.
 
         """
         return self._client_operation_logic(
@@ -188,6 +191,7 @@ def scan(self, **kwargs) -> dict[str, Any]:
 
         Returns:
             dict: The response from DynamoDB. This matches the boto3 scan API response.
+                The "Items" field will be decrypted locally after being read from DynamoDB.
 
         """
         return self._client_operation_logic(
@@ -214,6 +218,8 @@ def batch_write_item(self, **kwargs) -> dict[str, Any]:
 
         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.
 
         Returns:
             dict: The response from DynamoDB. This matches the boto3 batch_write_item API response.
@@ -244,6 +250,7 @@ def batch_get_item(self, **kwargs) -> dict[str, Any]:
 
         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.
 
         """
         return self._client_operation_logic(
@@ -272,7 +279,7 @@ def transact_get_items(self, **kwargs) -> dict[str, Any]:
 
         Returns:
             dict: The response from DynamoDB. This matches the boto3 transact_get_items API response.
-
+                
         """
         return self._client_operation_logic(
             operation_input=kwargs,
@@ -298,7 +305,8 @@ def transact_write_items(self, **kwargs) -> dict[str, Any]:
 
         Args:
             **kwargs: Keyword arguments to pass to the operation. These match the boto3 transact_write_items API
-                parameters.
+                parameters. Any put operations 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 API response.

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

@@ -78,6 +78,7 @@ def paginate(self, **kwargs) -> Generator[dict, None, None]:
 
         Returns:
             Generator[dict, None, None]: A generator yielding pages as dictionaries.
+                The items in the pages will be decrypted locally after being read from DynamoDB.
 
         """
         if self._paginator._model.name == "Query":

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

@@ -194,6 +194,7 @@ def batch_get_item(self, **kwargs):
 
         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.
 
         """
         return self._resource_operation_logic(
@@ -220,6 +221,8 @@ def batch_write_item(self, **kwargs):
 
         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.
 
         Returns:
             dict: The response from DynamoDB. This matches the boto3 batch_write_item API response.

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

@@ -84,6 +84,7 @@ def put_item(self, **kwargs) -> dict[str, Any]:
 
         Args:
             **kwargs: Keyword arguments to pass to the operation. These match the boto3 put_item API parameters.
+                The "Item" field will be encrypted locally before being written to DynamoDB.
 
         Returns:
             dict: The response from DynamoDB. This matches the boto3 put_item API response.
@@ -114,6 +115,7 @@ def get_item(self, **kwargs) -> dict[str, Any]:
 
         Returns:
             dict: The response from DynamoDB. This matches the boto3 get_item API response.
+                The "Item" field will be decrypted locally after being read from DynamoDB.
 
         """
         return self._table_operation_logic(
@@ -141,6 +143,7 @@ def query(self, **kwargs) -> dict[str, Any]:
 
         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.
 
         """
         return self._table_operation_logic(
@@ -168,7 +171,8 @@ def scan(self, **kwargs) -> dict[str, Any]:
 
         Returns:
             dict: The response from DynamoDB. This matches the boto3 scan API response.
-
+                The "Items" field will be decrypted locally after being read from DynamoDB.
+                
         """
         return self._table_operation_logic(
             operation_input=kwargs,