DynamoDB Encryption Client for Python - AWS Database Encryption SDK
PrerequisitesInstallation

DynamoDB Encryption Client for Python

Note

Our client-side encryption library was renamed to AWS Database Encryption SDK. The following topic provides information on versions 1.x—2.x of the DynamoDB Encryption Client for Java and versions 1.x—3.x of the DynamoDB Encryption Client for Python. For more information, see AWS Database Encryption SDK for DynamoDB version support.

This topic explains how to install and use the DynamoDB Encryption Client for Python. You can find the code in the aws-dynamodb-encryption-python repository on GitHub, including complete and tested sample code to help you get started.

Note

Versions 1.x.x and 2.x.x of the DynamoDB Encryption Client for Python are in end-of-support phase effective July 2022. Upgrade to a newer version as soon as possible.

Topics

Prerequisites

Before you install the Amazon DynamoDB Encryption Client for Python, be sure you have the following prerequisites.

A supported version of Python

Python 3.8 or later is required by the Amazon DynamoDB Encryption Client for Python versions 3.3.0 and later. To download Python, see Python downloads.

Earlier versions of the Amazon DynamoDB Encryption Client for Python support Python 2.7 and Python 3.4 and later, but we recommend that you use the latest version of the DynamoDB Encryption Client.

The pip installation tool for Python

Python 3.6 and later include pip, although you might want to upgrade it. For more information about upgrading or installing pip, see Installation in the pip documentation.

Installation

Use pip to install the Amazon DynamoDB Encryption Client for Python, as shown in the following examples.

To install the latest version
pip install dynamodb-encryption-sdk

For more details about using pip to install and upgrade packages, see Installing Packages.

The DynamoDB Encryption Client requires the cryptography library on all platforms. All versions of pip install and build the cryptography library on Windows. pip 8.1 and later installs and builds cryptography on Linux. If you are using an earlier version of pip and your Linux environment doesn't have the tools needed to build the cryptography library, you need to install them. For more information, see Building cryptography on Linux.

You can get the latest development version of the DynamoDB Encryption Client from the aws-dynamodb-encryption-python repository on GitHub.

After you install the DynamoDB Encryption Client, get started by looking at the example Python code in this guide.