DynamoDB

Protocol: JSON 1.1 (X-Amz-Target: DynamoDB_20120810.*) Endpoint: POST http://localhost:4566/

Supported Actions

Action	Description
CreateTable	Create a table with indexes
DeleteTable	Delete a table
DescribeTable	Get table metadata
ListTables	List all tables
UpdateTable	Update throughput, indexes, streams
PutItem	Write an item
GetItem	Read an item by primary key
DeleteItem	Delete an item
UpdateItem	Partially update an item
Query	Query by partition key with optional filter
Scan	Full table scan with optional filter
BatchWriteItem	Write/delete up to 25 items across tables
BatchGetItem	Read up to 100 items across tables
TransactWriteItems	ACID write transaction
TransactGetItems	ACID read transaction
DescribeTimeToLive	Get TTL configuration
UpdateTimeToLive	Enable/disable TTL on a table
TagResource	Tag a table
UntagResource	Remove tags
ListTagsOfResource	List tags

Streams

DynamoDB Streams are supported via a separate target (DynamoDBStreams_20120810):

Action	Description
ListStreams	List all streams
DescribeStream	Get stream and shard info
GetShardIterator	Get a shard iterator
GetRecords	Read stream records from a shard

Examples

export AWS_ENDPOINT=http://localhost:4566

# Create a table
aws dynamodb create-table \
  --table-name Users \
  --attribute-definitions \
    AttributeName=userId,AttributeType=S \
  --key-schema \
    AttributeName=userId,KeyType=HASH \
  --billing-mode PAY_PER_REQUEST \
  --endpoint-url $AWS_ENDPOINT

# Put an item
aws dynamodb put-item \
  --table-name Users \
  --item '{"userId":{"S":"u1"},"name":{"S":"Alice"},"age":{"N":"30"}}' \
  --endpoint-url $AWS_ENDPOINT

# Get an item
aws dynamodb get-item \
  --table-name Users \
  --key '{"userId":{"S":"u1"}}' \
  --endpoint-url $AWS_ENDPOINT

# Query (partition key)
aws dynamodb query \
  --table-name Users \
  --key-condition-expression "userId = :id" \
  --expression-attribute-values '{":id":{"S":"u1"}}' \
  --endpoint-url $AWS_ENDPOINT

# Scan with filter
aws dynamodb scan \
  --table-name Users \
  --filter-expression "age > :min" \
  --expression-attribute-values '{":min":{"N":"25"}}' \
  --endpoint-url $AWS_ENDPOINT

# Enable TTL
aws dynamodb update-time-to-live \
  --table-name Users \
  --time-to-live-specification Enabled=true,AttributeName=expiresAt \
  --endpoint-url $AWS_ENDPOINT

# Enable Streams
aws dynamodb update-table \
  --table-name Users \
  --stream-specification StreamEnabled=true,StreamViewType=NEW_AND_OLD_IMAGES \
  --endpoint-url $AWS_ENDPOINT

Global Secondary Indexes

aws dynamodb create-table \
  --table-name Orders \
  --attribute-definitions \
    AttributeName=orderId,AttributeType=S \
    AttributeName=customerId,AttributeType=S \
  --key-schema AttributeName=orderId,KeyType=HASH \
  --global-secondary-indexes '[{
    "IndexName": "CustomerIndex",
    "KeySchema": [{"AttributeName":"customerId","KeyType":"HASH"}],
    "Projection": {"ProjectionType":"ALL"}
  }]' \
  --billing-mode PAY_PER_REQUEST \
  --endpoint-url $AWS_ENDPOINT