m

Author: Lucas McDonald

Examples/runtimes/python/DynamoDBEncryption/src/encrypted_paginator.py

@@ -14,8 +14,6 @@
 https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.Pagination
 For more information on paginating the Query operation, see:
 https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.Pagination.html
-
-This example also requires access to the KMS key ARN with permissions: (TODO)
 """
 
 import boto3
@@ -113,7 +111,6 @@ def encrypted_paginator_search_example(
     encrypted_client = EncryptedClient(
         client=boto3.client("dynamodb"),
         encryption_config=tables_config,
-        expect_standard_dictionaries=True,
     )
 
     # 6. Put 10 items into our table using the above client.
@@ -122,11 +119,11 @@ def encrypted_paginator_search_example(
     #    client-side, according to our configuration.
     for i in range(10):
         item_to_encrypt = {
-            "partition_key": "PythonEncryptedPaginatorSearchExample",
-            "sort_key": i,
-            "attribute1": "encrypt and sign me!",
-            "attribute2": "sign me!",
-            ":attribute3": "ignore me!",
+            "partition_key": {"S": "PythonEncryptedPaginatorSearchExample"},
+            "sort_key": {"N": str(i)},
+            "attribute1": {"S": "encrypt and sign me!"},
+            "attribute2": {"S": "sign me!"},
+            ":attribute3": {"S": "ignore me!"},
         }
 
         put_item_request = {
@@ -136,13 +133,10 @@ def encrypted_paginator_search_example(
 
         put_item_response = encrypted_client.put_item(**put_item_request)
 
-        # print(f"{put_item_response=}")
-
         # Demonstrate that PutItem succeeded
         assert put_item_response["ResponseMetadata"]["HTTPStatusCode"] == 200
 
-    ### here
-
+    # 7. Search for the items using the EncryptedPaginator's Scan operation.
     encrypted_scan_paginator = encrypted_client.get_paginator("scan")
 
     scan_item_request = {
@@ -157,28 +151,32 @@ def encrypted_paginator_search_example(
             # `MaxItems` configures the number of items the paginator will return before stopping the scan.
             # Scans are expensive, and we know that we only added 10 items, so this example will stop at 10.
             # The default is None; i.e. no size limit.
+            # We set this for demonstration purposes only, but leaving this unset is recommended for most cases.
             "MaxItems": 10,
             # `PageSize` configures the maximum number of items that will be returned in a single page.
             # The default is to return ~1 MB of data.
+            # We set this for demonstration purposes only, but leaving this unset is recommended for most cases.
             "PageSize": 5,
         },
     }
 
     scan_response_iterator = encrypted_scan_paginator.paginate(**scan_item_request)
 
+    # 8. Iterate over the paginator's response pages.
+    #    Each page will contain a list of items.
+    #    Each item will have been decrypted by the EncryptedPaginator before being returned here.
     scan_collected_items = []
-
     for scan_response_page in scan_response_iterator:
-        # print(f'{scan_response_page=}')
         for item in scan_response_page["Items"]:
-            if int(item["sort_key"]["N"]) % 2 == 0:
-                scan_collected_items.append(item)
+            scan_collected_items.append(item)
 
-    assert len(scan_collected_items) == 5
+    # 9. Assert that we have received all 10 items correctly.
+    # We do this for demonstration purposes only; you do not need to do this in your code.
+    assert len(scan_collected_items) == 10
     for scan_collected_item in scan_collected_items:
-        assert int(scan_collected_item["sort_key"]["N"]) % 2 == 0
         assert scan_collected_item["attribute1"] == {"S": "encrypt and sign me!"}
 
+    # 10. Search for the items using the EncryptedPaginator's Query operation.
     encrypted_query_paginator = encrypted_client.get_paginator("query")
 
     query_item_request = {
@@ -194,18 +192,15 @@ def encrypted_paginator_search_example(
 
     query_response_iterator = encrypted_query_paginator.paginate(**query_item_request)
 
+    # 11. Iterate over the paginator's response pages.
+    #     Each page will contain a list of items.
+    #     Each item will have been decrypted by the EncryptedPaginator before being returned here.
     query_collected_items = []
-
     for query_response_page in query_response_iterator:
         for item in query_response_page["Items"]:
             query_collected_items.append(item)
 
-    assert len(query_collected_items) == 1
+    # 12. Assert that we have received all 10 items correctly.
+    # We do this for demonstration purposes only; you do not need to do this in your code.
+    assert len(query_collected_items) == 10
     assert query_collected_items[0]["attribute1"] == {"S": "encrypt and sign me!"}
-
-    # # Demonstrate that GetItem succeeded
-    # assert get_item_response["ResponseMetadata"]["HTTPStatusCode"] == 200
-    # print(f"{item_to_encrypt=}")
-    # print(f"{get_item_response['Item']=}")
-    # # assert get_item_response["Item"] == item_to_encrypt
-    # assert get_item_response["Item"]["attribute1"] == {"S" : "encrypt and sign me!"}