amazon-dax-client 1.0.5

Installation

Install Amazon DAX Client using pip:

$ pip install amazon-dax-client

Quick Start

Boto3 has two different interfaces, the resource interface and the botocore client interface. Both are supported by the Amazon DAX client, with slightly different client initialization.

For the resource API, change from:

ddb = boto3.resource('dynamodb')

to

dax = AmazonDaxClient.resource(
    endpoint_url='dax.abcdef.us-east-1.amazon.com')

All other boto3.resource() arguments are accepted.

For the botocore client API, change from:

session = botocore.session.get_session()
ddb = session.create_client('dynamodb', ...)

to

session = botocore.session.get_session()
dax = AmazonDaxClient(session, ...)

For Boto3 client API, change from:

ddb = boto3.client('dynamodb')

to

dax = AmazonDaxClient(endpoint_url='dax.abcdef.us-east-1.amazon.com')

The Boto3 and botocore client APIs are exactly the same.

Unsupported Features

The Amazon DAX client does not support table operations. Any table manipulation operations must use the regular Boto3 or botocore DynamoDB client.

Paginators are not currently supported for DAX.

Documentation

Once created, the interface is the same as the Boto3/botocore DynamoDB clients.

• Boto3 DynamoDB resource API

• botocore DynamoDB client API

For acomplete example, follow the guide to create a sample app.

Publish

To publish:

python3 setup.py sdist bdist_wheel
./s3-upload $VERSION
twine upload dist/*

Getting Help

Please use these community resources for getting help.

• Ask a question on StackOverflow and tag it with amazon-dynamodb-dax

• Ask a question on the AWS DynamoDB forum

• Open a support ticket with AWS Support

Changes

v1.0.5

• Fix UpdateItem result parsing with a subset of attributes changed

v1.0.4

• Use user-specified timeouts

• Fix issue with update response if the item is not changed

• Fix error decoding BatchWrite UnprocessedItems.

v1.0.3

• Fix AmazonDaxClient.resource() when using batch_get_items or batch_write_items.

v1.0.2

• Fix Python 2 encoding issues

• Fix decoding of ConsumedCapacity, ItemCollectionMetrics in batch operations

v1.0.1

• Initial release