m

Author: Lucas McDonald

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

@@ -49,20 +49,20 @@ class EncryptedClient(EncryptedBotoInterface):
 
     This class will encrypt/decrypt items for the following operations:
 
-        * `put_item`
-        * `get_item`
-        * `query`
-        * `scan`
-        * `batch_write_item`
-        * `batch_get_item`
-        * `transact_get_items`
-        * `transact_write_items`
+        * ``put_item``
+        * ``get_item``
+        * ``query``
+        * ``scan``
+        * ``batch_write_item``
+        * ``batch_get_item``
+        * ``transact_get_items``
+        * ``transact_write_items``
 
-    The `update_item` operation is not currently supported. Calling this operation will raise `NotImplementedError`.
+    The ``update_item`` operation is not currently supported. Calling this operation will raise ``NotImplementedError``.
 
     Any other operations on this class will defer to the underlying boto3 DynamoDB client's implementation.
 
-    `EncryptedClient` can also return an `EncryptedPaginator` for transparent decryption of paginated results.
+    ``EncryptedClient`` can also return an ``EncryptedPaginator`` for transparent decryption of paginated results.
     """
 
     _client: botocore.client.BaseClient
@@ -78,15 +78,15 @@ def __init__(
         expect_standard_dictionaries: bool | None = False,
     ):
         """
-        Create an `EncryptedClient` object.
+        Create an ``EncryptedClient`` object.
 
         Args:
             client (botocore.client.BaseClient): Initialized boto3 DynamoDB client
             encryption_config (DynamoDbTablesEncryptionConfig): Initialized DynamoDbTablesEncryptionConfig
             expect_standard_dictionaries (Optional[bool]): Does the underlying boto3 client expect items
                 to be standard Python dictionaries? This should only be set to True if you are using a
-                client obtained from a service resource or table resource (ex: `table.meta.client`).
-                If this is True, EncryptedClient will expect item-like shapes to be
+                client obtained from a service resource or table resource (ex: ``table.meta.client``).
+                If this is True, ``EncryptedClient`` will expect item-like shapes to be
                 standard Python dictionaries (default: False).
 
         """

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

@@ -31,7 +31,7 @@ def __init__(
         item_encryptor_config: DynamoDbItemEncryptorConfig,
     ):
         """
-        Create an `ItemEncryptor`.
+        Create an ``ItemEncryptor``.
 
         Args:
             item_encryptor_config (DynamoDbItemEncryptorConfig): Encryption configuration object.
@@ -58,8 +58,8 @@ def encrypt_python_item(
         boto3 DynamoDB Tables and Resources expect items formatted as native Python dictionaries.
         Use this method to encrypt an item if you intend to pass the encrypted item
         to a boto3 DynamoDB Table or Resource interface to store it.
-        (Alternatively, you can use this library's `EncryptedTable` or `EncryptedResource` interfaces
-        to transparently encrypt items without an intermediary `ItemEncryptor`.)
+        (Alternatively, you can use this library's ``EncryptedTable`` or ``EncryptedResource`` interfaces
+        to transparently encrypt items without an intermediary ``ItemEncryptor``.)
 
         Args:
             plaintext_dict_item (dict[str, Any]): A standard Python dictionary.
@@ -70,7 +70,7 @@ def encrypt_python_item(
                 - **encrypted_item** (*dict[str, Any]*): The encrypted Python dictionary.
                   **Note:** The item was encrypted as DynamoDB JSON, then transformed to a Python dictionary.
                 - **parsed_header** (*Optional[ParsedHeader]*): The encrypted DynamoDB item's header
-                  (parsed `aws_dbe_head` value).
+                  (parsed ``aws_dbe_head`` value).
 
         Example:
             >>> plaintext_item = {
@@ -100,8 +100,8 @@ def encrypt_dynamodb_item(
 
         Use this method to encrypt an item if you intend to pass the encrypted item
         to a boto3 DynamoDB client to store it.
-        (Alternatively, you can use this library's `EncryptedClient` interface
-        to transparently encrypt items without an intermediary `ItemEncryptor`.)
+        (Alternatively, you can use this library's ``EncryptedClient`` interface
+        to transparently encrypt items without an intermediary ``ItemEncryptor``.)
 
         Args:
             plaintext_dynamodb_item (dict[str, dict[str, Any]]): The item to encrypt formatted as DynamoDB JSON.
@@ -112,7 +112,7 @@ def encrypt_dynamodb_item(
                 - **encrypted_item** (*dict[str, Any]*): A dictionary containing the encrypted DynamoDB item
                   formatted as DynamoDB JSON.
                 - **parsed_header** (*Optional[ParsedHeader]*): The encrypted DynamoDB item's header
-                  (`aws_dbe_head` value).
+                  (``aws_dbe_head`` value).
 
         Example:
             >>> plaintext_item = {
@@ -147,7 +147,7 @@ def encrypt_item(
 
                 - **encrypted_item** (*dict[str, Any]*): The encrypted DynamoDB item formatted as DynamoDB JSON.
                 - **parsed_header** (*Optional[ParsedHeader]*): The encrypted DynamoDB item's header
-                  (`aws_dbe_head` value).
+                  (``aws_dbe_head`` value).
 
         Example:
             >>> plaintext_item = {
@@ -184,8 +184,8 @@ def decrypt_python_item(
         boto3 DynamoDB Tables and Resources return items formatted as native Python dictionaries.
         Use this method to decrypt an item if you retrieve the encrypted item
         from a boto3 DynamoDB Table or Resource interface.
-        (Alternatively, you can use this library's `EncryptedTable` or `EncryptedResource` interfaces
-        to transparently decrypt items without an intermediary `ItemEncryptor`.)
+        (Alternatively, you can use this library's ``EncryptedTable`` or ``EncryptedResource`` interfaces
+        to transparently decrypt items without an intermediary ``ItemEncryptor``.)
 
         Args:
             encrypted_dict_item (dict[str, Any]): A standard Python dictionary with encrypted values.
@@ -196,7 +196,7 @@ def decrypt_python_item(
                 - **plaintext_item** (*dict[str, Any]*): The decrypted Python dictionary.
                   **Note:** The item was decrypted as DynamoDB JSON, then transformed to a Python dictionary.
                 - **parsed_header** (*Optional[ParsedHeader]*): The encrypted DynamoDB item's header
-                  (parsed `aws_dbe_head` value).
+                  (parsed ``aws_dbe_head`` value).
 
         Example:
             >>> encrypted_item = {
@@ -226,8 +226,8 @@ def decrypt_dynamodb_item(
 
         Use this method to decrypt an item if you retrieved the encrypted item
         from a boto3 DynamoDB client.
-        (Alternatively, you can use this library's `EncryptedClient` interface
-        to transparently decrypt items without an intermediary `ItemEncryptor`.)
+        (Alternatively, you can use this library's ``EncryptedClient`` interface
+        to transparently decrypt items without an intermediary ``ItemEncryptor``.)
 
         Args:
             encrypted_dynamodb_item (dict[str, dict[str, Any]]): The item to decrypt formatted as DynamoDB JSON.
@@ -237,7 +237,7 @@ def decrypt_dynamodb_item(
 
                 - **plaintext_item** (*dict[str, Any]*): The plaintext DynamoDB item formatted as DynamoDB JSON.
                 - **parsed_header** (*Optional[ParsedHeader]*): The decrypted DynamoDB item's header
-                  (`aws_dbe_head` value).
+                  (``aws_dbe_head`` value).
 
         Example:
             >>> encrypted_item = {
@@ -272,7 +272,7 @@ def decrypt_item(
 
                 - **plaintext_item** (*dict[str, Any]*): The decrypted DynamoDB item formatted as DynamoDB JSON.
                 - **parsed_header** (*Optional[ParsedHeader]*): The decrypted DynamoDB item's header
-                  (`aws_dbe_head` value).
+                  (``aws_dbe_head`` value).
 
         Example:
             >>> encrypted_item = {