Skip to content

Commit 86e2f89

Browse files
author
Lucas McDonald
committed
m
1 parent b82250e commit 86e2f89

File tree

1 file changed

+17
-16
lines changed
  • DynamoDbEncryption/runtimes/python/src/aws_dbesdk_dynamodb/encrypted

1 file changed

+17
-16
lines changed

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

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,9 @@ def encrypt_python_item(
6767
Returns:
6868
EncryptItemOutput: Structure containing the following fields:
6969
70-
- encrypted_item (dict[str, Any]): The encrypted Python dictionary.
70+
- **encrypted_item** (*dict[str, Any]*): The encrypted Python dictionary.
7171
**Note:** The item was encrypted as DynamoDB JSON, then transformed to a Python dictionary.
72-
- parsed_header (Optional[ParsedHeader]): The encrypted DynamoDB item's header
72+
- **parsed_header** (*Optional[ParsedHeader]*): The encrypted DynamoDB item's header
7373
(parsed `aws_dbe_head` value).
7474
7575
Example:
@@ -101,17 +101,17 @@ def encrypt_dynamodb_item(
101101
Use this method to encrypt an item if you intend to pass the encrypted item
102102
to a boto3 DynamoDB client to store it.
103103
(Alternatively, you can use this library's EncryptedClient interface
104-
to transparently encrypt items without an intermediary ItemEncryptor.)
104+
to transparently encrypt items without an intermediary ItemEncryptor.)
105105
106106
Args:
107107
plaintext_dynamodb_item (dict[str, dict[str, Any]]): The item to encrypt formatted as DynamoDB JSON.
108108
109109
Returns:
110110
EncryptItemOutput: Structure containing the following fields:
111111
112-
- encrypted_item (dict[str, Any]): A dictionary containing the encrypted DynamoDB item
112+
- **encrypted_item** (*dict[str, Any]*): A dictionary containing the encrypted DynamoDB item
113113
formatted as DynamoDB JSON.
114-
- parsed_header (Optional[ParsedHeader]): The encrypted DynamoDB item's header (`aws_dbe_head` value).
114+
- **parsed_header** (*Optional[ParsedHeader]*): The encrypted DynamoDB item's header (`aws_dbe_head` value).
115115
116116
Example:
117117
>>> plaintext_item = {
@@ -144,8 +144,8 @@ def encrypt_item(
144144
Returns:
145145
EncryptItemOutput: Structure containing the following fields:
146146
147-
- encrypted_item (dict[str, Any]): The encrypted DynamoDB item formatted as DynamoDB JSON.
148-
- parsed_header (Optional[ParsedHeader]): The encrypted DynamoDB item's header
147+
- **encrypted_item** (*dict[str, Any]*): The encrypted DynamoDB item formatted as DynamoDB JSON.
148+
- **parsed_header** (*Optional[ParsedHeader]*): The encrypted DynamoDB item's header
149149
(`aws_dbe_head` value).
150150
151151
Example:
@@ -192,10 +192,10 @@ def decrypt_python_item(
192192
Returns:
193193
DecryptItemOutput: Structure containing the following fields:
194194
195-
- plaintext_item (dict[str, Any]): The decrypted Python dictionary.
195+
- **plaintext_item** (*dict[str, Any]*): The decrypted Python dictionary.
196196
**Note:** The item was decrypted as DynamoDB JSON, then transformed to a Python dictionary.
197-
- parsed_header (Optional[ParsedHeader]): The encrypted DynamoDB item's header
198-
(parsed `aws_dbe_head` value).
197+
- **parsed_header** (*Optional[ParsedHeader]*): The encrypted DynamoDB item's header
198+
(parsed `aws_dbe_head` value).
199199
200200
Example:
201201
>>> encrypted_item = {
@@ -234,8 +234,8 @@ def decrypt_dynamodb_item(
234234
Returns:
235235
DecryptItemOutput: Structure containing the following fields:
236236
237-
- plaintext_item (dict[str, Any]): The plaintext DynamoDB item formatted as DynamoDB JSON.
238-
- parsed_header (Optional[ParsedHeader]): The decrypted DynamoDB item's header (`aws_dbe_head` value).
237+
- **plaintext_item** (*dict[str, Any]*): The plaintext DynamoDB item formatted as DynamoDB JSON.
238+
- **parsed_header** (*Optional[ParsedHeader]*): The decrypted DynamoDB item's header (`aws_dbe_head` value).
239239
240240
Example:
241241
>>> encrypted_item = {
@@ -261,14 +261,15 @@ def decrypt_item(
261261
https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.LowLevelAPI.html
262262
263263
Args:
264-
decrypt_item_input (DecryptItemInput): Structure containing the following field:
265-
- encrypted_item (dict[str, Any]): The item to decrypt formatted as DynamoDB JSON.
264+
decrypt_item_input (DecryptItemInput): Structure containing the following fields:
265+
266+
- **encrypted_item** (*dict[str, Any]*): The item to decrypt formatted as DynamoDB JSON.
266267
267268
Returns:
268269
DecryptItemOutput: Structure containing the following fields:
269270
270-
- plaintext_item (dict[str, Any]): The decrypted DynamoDB item formatted as DynamoDB JSON.
271-
- parsed_header (Optional[ParsedHeader]): The decrypted DynamoDB item's header (`aws_dbe_head` value).
271+
- **plaintext_item** (*dict[str, Any]*): The decrypted DynamoDB item formatted as DynamoDB JSON.
272+
- **parsed_header** (*Optional[ParsedHeader]*): The decrypted DynamoDB item's header (`aws_dbe_head` value).
272273
273274
Example:
274275
>>> encrypted_item = {

0 commit comments

Comments
 (0)