2
2
Amazon DynamoDB Encryption Client for Python
3
3
############################################
4
4
5
- The `Amazon DynamoDB Encryption Client for Python `_ provides client-side encryption of DynamoDB
6
- items to help you to protect your table data before you send it to Amazon DynamoDB. It provides
7
- an implementation of the `Amazon DynamoDB Encryption Client `_ that is fully compatible with the
8
- `Amazon DynamoDB Encryption Client for Java `_.
5
+ The `Amazon DynamoDB Encryption Client for Python `_ provides client-side encryption of ` Amazon
6
+ DynamoDB `_ items to help you to protect your table data before you send it to DynamoDB. It
7
+ provides an implementation of the `Amazon DynamoDB Encryption Client `_ that is fully compatible
8
+ with the `Amazon DynamoDB Encryption Client for Java `_.
9
9
10
10
You can find the latest Python documentation at `Read the Docs `_ and you can find the latest
11
11
full documents in our `primary documents `_.
@@ -54,25 +54,25 @@ from the `boto3`_ library. For most uses, once configured, these clients can be
54
54
as you would a standard client from `boto3 `_, and your items will be transparently encrypted
55
55
on write and decrypted on read.
56
56
57
- What can I not do with the helper clients?
58
- ------------------------------------------
57
+ What can't I do with the helper clients?
58
+ ----------------------------------------
59
59
60
60
For most uses, the helper clients (once configured) can be used as drop-in replacements for
61
61
the `boto3 `_ clients. However, there are a couple cases where this is not the case.
62
62
63
63
Update Item
64
64
^^^^^^^^^^^
65
65
66
- Because we cannot know that a partial update you might be making to an item covers all
66
+ Because we can't know that a partial update you might be making to an item covers all
67
67
of the signed attributes in your item, we do not allow ``update_item `` on the helper clients.
68
68
69
- The reason for this is because if you update only some of the signed attributes, then next
70
- time you try to read that item the signature validation will fail.
69
+ This is because if you update only some of the signed attributes, then next time you try
70
+ to read that item the signature validation will fail.
71
71
72
72
Attribute Filtering
73
73
^^^^^^^^^^^^^^^^^^^
74
74
75
- Because we cannot know what attributes in an item are signed, the helper clients do not allow
75
+ Because we can't know what attributes in an item are signed, the helper clients do not allow
76
76
any attribute filtering.
77
77
78
78
For ``get_item ``, ``batch_get_item ``, and ``scan ``, this includes the use of ``AttributesToGet ``
@@ -81,8 +81,8 @@ and ``ProjectionExpression``.
81
81
For ``scan ``, this also includes the use of ``Select `` values ``SPECIFIC_ATTRIBUTES `` and
82
82
``ALL_PROJECTED_ATTRIBUTES ``.
83
83
84
- The reason for this is because if you do not retrieve all signed attributes, the signature
85
- validation will fail.
84
+ This is because if you do not retrieve all signed attributes, the signature validation will
85
+ fail.
86
86
87
87
Item Encryptor
88
88
==============
@@ -149,6 +149,7 @@ of the one that the client would normally construct for you.
149
149
150
150
151
151
.. _Amazon DynamoDB Encryption Client : https://docs.aws.amazon.com/dynamodb-encryption-client/latest/devguide/
152
+ .. _Amazon DynamoDB : https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Introduction.html
152
153
.. _primary documents : https://docs.aws.amazon.com/dynamodb-encryption-client/latest/devguide/
153
154
.. _Concepts Guide : https://docs.aws.amazon.com/dynamodb-encryption-client/latest/devguide/concepts.html
154
155
.. _Amazon DynamoDB Encryption Client for Java : https://github.com/awslabs/aws-dynamodb-encryption-java/
0 commit comments