03.DynamoDB Data Model
03.DynamoDB Data Model
Developer Guide
API Version 2012-08-10
Table of Contents
What Is Amazon DynamoDB? ......................................................................................................... 1
Service Highlights ................................................................................................................. 2
Data Model .......................................................................................................................... 3
Data Model Concepts - Tables, Items, and Attributes ............................................................ 4
Primary Key ................................................................................................................. 5
Secondary Indexes ........................................................................................................ 6
Data Types ................................................................................................................... 6
Supported Operations ............................................................................................................ 9
Table Operations ........................................................................................................... 9
Item Operations ............................................................................................................ 9
Query and Scan ............................................................................................................ 9
Data Read and Consistency Considerations ..................................................................... 10
Conditional Updates and Concurrency Control .................................................................. 10
Provisioned Throughput ........................................................................................................ 11
Read Capacity Units .................................................................................................... 11
Write Capacity Units ..................................................................................................... 12
Accessing DynamoDB .......................................................................................................... 12
Regions and Endpoints for DynamoDB ............................................................................ 13
Creating Tables and Loading Sample Data ....................................................................................... 14
Step 1: Before You Begin ....................................................................................................... 14
Sign up for the Service ................................................................................................. 14
Download AWS SDK .................................................................................................... 15
Step 2: Create Example Tables ............................................................................................... 15
Use Case 1: Product Catalog ......................................................................................... 16
Use Case 2: Forum Application ...................................................................................... 16
Creating Tables ........................................................................................................... 17
Step 3: Load Data into Tables ................................................................................................. 21
Load Data into Tables - Java .......................................................................................... 21
Load Data into Tables - .NET ......................................................................................... 28
Load Data into Tables - PHP .......................................................................................... 38
Verify Data Load .......................................................................................................... 43
Step 4: Try a Query .............................................................................................................. 44
Try a Query - Console .................................................................................................. 44
Try a Query - Java ....................................................................................................... 45
Try a Query - .NET ....................................................................................................... 47
Try a Query - PHP ....................................................................................................... 50
Step 5: Delete Example Tables ............................................................................................... 51
Where Do I Go from Here? .................................................................................................... 52
Using the AWS SDKs ................................................................................................................... 53
Using the AWS SDK for Java ................................................................................................. 53
Running Java Examples ............................................................................................... 55
Using the AWS SDK for .NET ................................................................................................ 56
Running .NET Examples ............................................................................................... 57
Using the AWS SDK for PHP ................................................................................................. 59
Running PHP Examples ............................................................................................... 59
Working with Tables ..................................................................................................................... 61
Specifying the Primary Key .................................................................................................... 61
Read and Write Requirements for Tables ................................................................................. 62
Capacity Units Calculations for Various Operations .................................................................... 64
Item Size Calculations .................................................................................................. 64
Read Operation and Consistency ................................................................................... 66
Listing and Describing Tables ................................................................................................. 66
Guidelines for Working with Tables .......................................................................................... 66
Design For Uniform Data Access Across Items In Your Tables .............................................. 66
Understand Partition Behavior ........................................................................................ 68
API Version 2012-08-10
iii
148
149
150
152
154
162
173
178
178
180
181
183
184
186
187
188
191
193
193
195
195
195
196
196
197
197
197
197
197
198
199
200
202
203
203
209
220
223
223
231
241
249
261
264
266
266
266
267
268
269
279
281
289
300
310
313
314
315
316
316
316
318
318
321
323
333
347
356
356
356
357
357
357
358
359
360
361
361
362
362
363
363
364
364
365
369
371
382
382
384
389
393
394
394
398
400
400
403
403
404
406
406
407
409
409
412
413
417
426
428
431
433
438
446
446
447
450
451
452
454
455
461
465
477
479
481
486
487
489
493
497
500
506
513
513
514
515
515
515
516
516
517
518
518
518
522
523
524
524
526
527
527
528
530
530
532
537
538
539
539
540
543
544
544
545
546
546
547
547
548
549
550
550
Getting Started with the DynamoDB Storage Backend for Titan ..........................................
Titan Graph Modeling in DynamoDB .............................................................................
Titan Metrics .............................................................................................................
Logstash Plugin for Amazon DynamoDB ................................................................................
Prerequisites .............................................................................................................
Setting Up the Logstash Plugin for Amazon DynamoDB ....................................................
Running the Logstash Plugin for Amazon DynamoDB .......................................................
Testing the Logstash Plugin for Amazon DynamoDB ........................................................
AWS Command Line Interface for DynamoDB .........................................................................
Downloading and Configuring the AWS CLI ....................................................................
Using the AWS CLI with DynamoDB ..............................................................................
Using the AWS CLI with Downloadable DynamoDB .........................................................
Integration with Other Services .....................................................................................................
Monitoring DynamoDB with CloudWatch ................................................................................
AWS Management Console .........................................................................................
Command Line Interface (CLI) ......................................................................................
API ..........................................................................................................................
DynamoDB Metrics ....................................................................................................
Dimensions for DynamoDB Metrics ...............................................................................
Using IAM to Control Access to DynamoDB Resources ............................................................
Amazon Resource Names (ARNs) for DynamoDB ...........................................................
DynamoDB Actions ....................................................................................................
Condition Types and Operators .....................................................................................
IAM Policy Keys .........................................................................................................
Example Policies for API Actions and Resource Access ....................................................
Fine-Grained Access Control for DynamoDB ..................................................................
Example Policies for Fine-Grained Access Control ...........................................................
Using Web Identity Federation ......................................................................................
Logging DynamoDB API Calls By Using AWS CloudTrail ...........................................................
DynamoDB Information in CloudTrail .............................................................................
Understanding DynamoDB Log File Entries ....................................................................
Exporting, Importing and Transforming Data Using AWS Data Pipeline ........................................
Using the AWS Management Console to Export and Import Data .......................................
Predefined Templates for AWS Data Pipeline and DynamoDB ............................................
Querying and Joining Tables Using Amazon Elastic MapReduce ................................................
Prerequisites for Integrating Amazon EMR .....................................................................
Step 1: Create a Key Pair ............................................................................................
Step 2: Create a Cluster ..............................................................................................
Step 3: SSH into the Master Node .................................................................................
Step 4: Set Up a Hive Table to Run Hive Commands ........................................................
Hive Command Examples for Exporting, Importing, and Querying Data ...............................
Optimizing Performance ..............................................................................................
Walkthrough: Using DynamoDB and Amazon Elastic MapReduce ......................................
Loading Data From DynamoDB Into Amazon Redshift ..............................................................
Limits .......................................................................................................................................
Document History ......................................................................................................................
Appendix ..................................................................................................................................
Example Tables and Data ....................................................................................................
ProductCatalog Table - Sample Data .............................................................................
Forum Table - Sample Data .........................................................................................
Thread Table - Sample Data .........................................................................................
Reply Sample Data ....................................................................................................
Creating Example Tables and Uploading Data .........................................................................
Creating Example Tables and Uploading Data - Java ........................................................
Creating Example Tables and Uploading Data - .NET .......................................................
Creating Example Tables and Uploading Data - PHP ........................................................
Reserved Words in DynamoDB ............................................................................................
Legacy Conditional Parameters ............................................................................................
API Version 2012-08-10
viii
552
558
564
569
570
570
572
574
575
575
575
576
577
577
578
578
578
579
588
588
589
590
590
591
592
597
599
605
611
611
612
617
618
631
631
633
633
634
637
639
643
650
653
662
664
669
678
678
679
681
682
682
683
684
692
710
718
728
728
729
729
729
729
730
736
737
737
742
748
752
756
759
762
764
766
771
777
785
790
795
Easy Administration DynamoDB is a fully managed service you simply create a database table
and let the service handle the rest. You don't need to worry about hardware or software provisioning,
setup and configuration, software patching, operating a reliable, distributed database cluster, or
partitioning data over multiple instances as you scale.
Built-in Fault Tolerance DynamoDB has built-in fault tolerance, automatically and synchronously
replicating your data across multiple Availability Zones in a Region for high availability and to help
protect your data against individual machine, or even facility failures.
Flexible DynamoDB does not have a fixed schema. Instead, each data item may have a different
number of attributes. Multiple data types (strings, numbers, binary, and sets) add richness to the data
model.
Efficient Indexing Every item in an DynamoDB table is identified by a primary key, allowing you to
access data items quickly and efficiently.You can also define secondary indexes on non-key attributes,
and query your data using an alternate key.
Strong Consistency, Atomic Counters Unlike many non-relational databases, DynamoDB makes
development easier by allowing you to use strong consistency on reads to ensure you are always
reading the latest values. DynamoDB supports multiple native data types (numbers, strings, binaries,
and multi-valued attributes). The service also natively supports atomic counters, allowing you to
atomically increment or decrement numerical attributes with a single API call.
Cost Effective DynamoDB is designed to be extremely cost-efficient for workloads of any scale.
You can get started with a free tier that allows more than 40 million database operations per month,
and pay low hourly rates only for the resources you consume above that limit. With easy administration
and efficient request pricing, DynamoDB can offer significantly lower total cost of ownership (TCO) for
your workload compared to operating a relational or non-relational database on your own.
Secure DynamoDB is secure and uses proven cryptographic methods to authenticate users and
prevent unauthorized data access. It also integrates with AWS Identity and Access Management for
fine-grained access control for users within your organization.
Integrated Monitoring DynamoDB displays key operational metrics for your table in the AWS
Management Console. The service also integrates with CloudWatch so you can see your request
throughput and latency for each DynamoDB table, and easily track your resource consumption.
Amazon Redshift IntegrationYou can load data from DynamoDB tables into Amazon Redshift, a
fully managed data warehouse service. You can connect to Amazon Redshift with a SQL client or
business intelligence tool using standard PostgreSQL JDBC or ODBC drivers, and perform complex
SQL queries and business intelligence tasks on your data.
Amazon Elastic MapReduce Integration DynamoDB also integrates with Amazon Elastic MapReduce
(Amazon EMR). Amazon EMR allows businesses to perform complex analytics of their large datasets
using a hosted pay-as-you-go Hadoop framework on AWS. With the launch of DynamoDB, it is easy
for customers to use Amazon EMR to analyze datasets stored in DynamoDB and archive the results
in Amazon Simple Storage Service (Amazon S3), while keeping the original dataset in DynamoDB
intact. Businesses can also use Amazon EMR to access data in multiple stores (i.e. DynamoDB and
Amazon RDS), perform complex analysis over this combined dataset, and store the results of this work
in Amazon S3.
You can store various kinds of product items in the table. The following table shows sample items.
Example items
{
Id = 101
ProductName = "Book 101 Title"
ISBN = "111-1111111111"
Authors = [ "Author 1", "Author 2" ]
Price = -2
Dimensions = "8.5 x 11.0 x 0.5"
PageCount = 500
InPublication = 1
ProductCategory = "Book"
}
{
Id = 201
ProductName = "18-Bicycle 201"
Description = "201 description"
BicycleType = "Road"
Brand = "Brand-Company A"
Price = 100
Gender = "M"
Color = [ "Red", "Black" ]
ProductCategory = "Bike"
}
Example items
{
Id = 202
ProductName = "21-Bicycle 202"
Description = "202 description"
BicycleType = "Road"
Brand = "Brand-Company A"
Price = 200
Gender = "M"
Color = [ "Green", "Black" ]
ProductCategory = "Bike"
}
In the example, the ProductCatalog table has one book item and two bicycle items. Item 101 is a book
with many attributes including the Authors multi-valued attribute. Item 201 and 202 are bikes, and these
items have a Color multi-valued attribute. The Id is the only required attribute. Note that attribute values
are shown using JSON-like syntax for illustration purposes.
Primary Key
When you create a table, in addition to the table name, you must specify the primary key of the table.
The primary key uniquely identifies each item in the table, so that no two items can have the same key.
DynamoDB supports the following two types of primary keys:
Hash Type Primary KeyThe primary key is made of one attribute, a hash attribute. DynamoDB
builds an unordered hash index on this primary key attribute. Each item in the table is uniquely identified
by its hash key value.
Hash and Range Type Primary KeyThe primary key is made of two attributes. The first attribute is
the hash attribute and the second one is the range attribute. DynamoDB builds an unordered hash
index on the hash primary key attribute, and a sorted range index on the range primary key attribute.
Each item in the table is uniquely identified by the combination of its hash and range key values. It is
possible for two items to have the same hash key value, but those two items must have different range
key values.
You must define the data type for each primary key attribute: String, Number, or Binary.
Different applications will have different requirements for tables and primary keys. For example, Amazon
Web Services maintains several forums (see Discussion Forums). Each forum has many threads of
discussion and each thread has many replies. You could potentially model this by creating the following
three tables:
Table Name
Primary
Key Type
Hash Attribute
Name
Hash
Name
Hash and
Range
ForumName
Subject
Hash and
Range
Id
ReplyDateTime
In this example, both the Thread and Reply tables have primary key of the hash and range type. For the
Thread table, each forum name can have one or more subjects. In this case, ForumName is the hash
attribute and Subject is the range attribute.
The Reply table has Id as the hash attribute and ReplyDateTime as the range attribute. The reply Id
identifies the thread to which the reply belongs. When designing DynamoDB tables you have to take into
account the fact that DynamoDB does not support cross-table joins. For example, the Reply table stores
both the forum name and subject values in the Id attribute. If you have a thread reply item, you can then
parse the Id attribute to find the forum name and subject and use the information to query the Thread or
the Forum tables. This developer guide uses these tables to illustrate DynamoDB functionality. For
information about these tables and sample data stored in these tables, see Example Tables and
Data (p. 678).
Secondary Indexes
When you create a table with a hash-and-range key, you can optionally define one or more secondary
indexes on that table. A secondary index lets you query the data in the table using an alternate key, in
addition to queries against the primary key.
With the Reply table, you can query data items by Id (hash) or by Id and ReplyDateTime (hash and range).
Now suppose you had an attribute in the tablePostedBywith the user ID of the person who posted
each reply. With a secondary index on PostedBy, you could query the data by Id (hash) and PostedBy
(range). Such a query would let you retrieve all the replies posted by a particular user in a thread, with
maximum efficiency and without having to access any other items.
DynamoDB supports two kinds of secondary indexes:
Local secondary index an index that has the same hash key as the table, but a different range key.
Global secondary index an index with a hash and range key that can be different from those on the
table.
You can define up to 5 global secondary indexes and 5 local secondary indexes per table. For more
information, see Improving Data Access with Secondary Indexes in DynamoDB (p. 249).
DynamoDB (p. 664). Also, the length of the attribute is constrained by the 400 KB item size limit. Note that
the length of the attribute must be greater than zero.
String value comparison is used when returning ordered results in the Query and Scan API actions.
Comparison is based on ASCII character code values. For example, "a" is greater that "A" , and "aa" is
greater than "B". For a list of code values, see http://en.wikipedia.org/wiki/
ASCII#ASCII_printable_characters.
Example
"Bicycle"
Number
Numbers can have up to 38 digits precision, and can be positive, negative, or zero.
Positive range: 1E-130 to 9.9999999999999999999999999999999999999E+125
Negative range: -9.9999999999999999999999999999999999999E+125 to -1E-130
In DynamoDB, numbers are represented as variable length. Leading and trailing zeroes are trimmed.
All numbers are sent to DynamoDB as String types, which maximizes compatibility across languages
and libraries. However DynamoDB handles them as the Number type for mathematical operations.
Note
If number precision is important, you should pass numbers to DynamoDB using strings that you
convert from a number type. DynamoDB limits numbers to 38 digits. More than 38 digits will
cause an error.
Example
"300"
Binary
Binary type attributes can store any binary data, for example compressed data, encrypted data, or images.
DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example
when evaluating query expressions.
There is no upper limit to the length of the binary value when you assign it to an attribute except when
the attribute is part of the primary key. For more information, see Limits in DynamoDB (p. 664). Also, the
length of the attribute is constrained by the 400 KB item size limit. Note that the length of the attribute
must be greater than zero.
Client applications must encode binary values in base64 format. When DynamoDB receives the data
from the client, it decodes the data into an unsigned byte array and uses that as the length of the attribute.
The following example is a binary attribute, using base64-encoded text.
Example
"dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"
Boolean
A Boolean type attribute can store either true or false.
API Version 2012-08-10
7
Example
true
Null
Null represents an attribute with an unknown or undefined state.
Example
NULL
Erasers: { Quantity : 1}
}
]
}
Note
DynamoDB lets you access individual elements within lists and arrays, even if those elements
are deeply nested. For more information, see Document Paths (p. 100).
Table Operations
DynamoDB provides operations to create, update and delete tables. After the table is created, you can
use the UpdateTable operation to increase or decrease a table's provisioned throughput. DynamoDB
also supports an operation to retrieve table information (the DescribeTable operation) including the
current status of the table, the primary key, and when the table was created. The ListTables operation
enables you to get a list of tables in your account in the region of the endpoint you are using to communicate
with DynamoDB. For more information, see Working with Tables in DynamoDB (p. 61).
Item Operations
Item operations enable you to add, update and delete items from a table. The UpdateItem operation
allows you to update existing attribute values, add new attributes, and delete existing attributes from an
item. You can also perform conditional updates. For example, if you are updating a price value, you can
set a condition so the update happens only if the current price is $20.
DynamoDB provides an operation to retrieve a single item (GetItem) or multiple items (BatchGetItem).
You can use the BatchGetItem operation to retrieve items from multiple tables. For more information,
see Working with Items in DynamoDB (p. 92).
How to Calculate
Reads
Writes
If your application's read or write requests exceed the provisioned throughput for a table, then those
requests might be throttled. You can use the AWS Management Console to monitor your provisioned
and actual throughput and to change your provisioned capacity in anticipation of traffic changes.
For more information about specifying the provisioned throughput requirements for a table, see Specifying
Read and Write Requirements for Tables (p. 62).
For tables with secondary indexes, DynamoDB consumes additional capacity units. For example, if you
wanted to add a single 1 KB item to a table, and that item contained an indexed attribute, then you would
need two write capacity unitsone for writing to the table, and another for writing to the index. For more
information, see:
Provisioned Throughput Considerations for Local Secondary Indexes (p. 316)
Provisioned Throughput Considerations for Global Secondary Indexes (p. 267)
You can use the Query and Scan operations in DynamoDB to retrieve multiple consecutive items from
a table or an index in a single request. With these operations, DynamoDB uses the cumulative size of
the processed items to calculate provisioned throughput. For example, if a Query operation retrieves 100
items that are 1 KB each, the read capacity calculation is not (100 4 KB) = 100 read capacity units, as
if those items were retrieved individually using GetItem or BatchGetItem. Instead, the total would be
only 25 read capacity units ((100 * 1024 bytes) = 100 KB, which is then divided by 4 KB). For more
information see Item Size Calculations (p. 64).
Accessing DynamoDB
Amazon DynamoDB is a web service that uses HTTP and HTTPS as a transport and JavaScript Object
Notation (JSON) as a message serialization format. Your application code can make requests directly to
the DynamoDB web service API. Instead of making the requests to the DynamoDB API directly from your
application, we recommend that you use the AWS Software Development Kits (SDKs). The easy-to-use
libraries in the AWS SDKs make it unnecessary to call the DynamoDB API directly from your application.
The libraries take care of request authentication, serialization, and connection management. For more
information about using the AWS SDKs, see Using the AWS SDKs with DynamoDB (p. 53).
The AWS SDKs provide low-level APIs that closely match the underlying DynamoDB API. To further
simplify application development, the SDKs also provide the following additional APIs:
The Java and .NET SDKs provide APIs with higher levels of abstraction. These higher-level interfaces
let you define the relationships between objects in your program and the database tables that store
those objects' data. After you define this mapping, you call simple object methods. This allows you to
write object-centric code, rather than database-centric code.
The .NET SDK provides a document model that wraps some of the low-level API functionality to further
simplify your coding.
For more information, see Using the AWS SDK for Java (p. 53) and Using the AWS SDK for .NET (p. 56).
If you decide not to use the AWS SDKs, then your application will need to construct individual service
requests. Each request must contain a valid JSON payload and correct HTTP headers, including a valid
AWS signature. For more information on constructing your own service requests, see Using the DynamoDB
API (p. 513).
DynamoDB also provides a management console that enables you to work with tables and items. You
can create, update, and delete tables without writing any code. You can view all the existing items in a
table or use a query to filter the items in the table. You can add new items or delete items. You can also
use the management console to monitor the performance of your tables. Using CloudWatch metrics in
the console, you can monitor table throughput and other performance metrics. For more information, go
to DynamoDB console.
2.
Note
This developer guide provides code examples in Java, C#, and PHP.
If you want to use a different programming language with DynamoDB, go to http://
aws.amazon.com/code and download the appropriate SDK. AWS provides SDK support for
Python, Ruby, JavaScript, and more.
Primary
Key Type
Hash Attribute
Name and Type
Range Attribute
Name and Type
Provisioned
Throughput
Attribute Name: Id
Type: Number
Primary
Key Type
Hash Attribute
Name and Type
Range Attribute
Name and Type
Provisioned
Throughput
Hash
Attribute Name:
Name
Type: String
Attribute Name:
ForumName
Type: String
Attribute Name:
Subject
Type: String
Attribute Name: Id
Type: String
Attribute Name:
ReplyDateTime
Type: String
Attribute to Index
Projected Attributes
PostedBy-index
PostedBy
In the next step, you will write a simple query to retrieve data from these tables.
Creating Tables
For this exercise, you will use the DynamoDB console to create the ProductCatalog, Forum, Thread
and Reply tables.
Note
In these steps, you use these tables to explore some of the basic DynamoDB operations.
However, these tables are also used in other examples throughout this reference. If you delete
these tables and later want to recreate them, you can repeat this step, or programmatically
recreate them and upload sample data. For more information about creating the tables and
loading the data programmatically, see Creating Example Tables and Uploading Data (p. 683).
1.
ProductCatalog
Forum
Thread
Reply
Sign in to the AWS Management Console and open the DynamoDB console at https://
console.aws.amazon.com/dynamodb/.
For first time users, the following wizard opens.
If you already have tables in DynamoDB, you'll see the console with your list of tables.
2.
3.
b.
See the preceding table for the list of tables that you are creating.
Select the primary key type.
c.
d.
See the preceding table for the primary key type of the table that you are creating.
If the table's primary key is of Hash and Range type, specify the hash attribute name and type
for both the hash and range attributes.
If the table's primary key is of Hash type, specify the hash attribute name and select the attribute
type.
e.
4.
Click Continue.
If you are creating the Reply table, you will need to define a local secondary index:
A local secondary index allows you to perform queries against an attribute that is not part of the
primary key. For this exercise, you will create a local secondary index on the PostedBy attribute of
the Reply table.
5.
a.
b.
c.
d.
e.
f.
Click Continue.
In the Create Table - Provisioned Throughput step, leave the Help me estimate Provisioned
Throughput checkbox unchecked.
It is important to configure the appropriate provisioned throughput based on your expected item
size and your expected read and write request rates. There is cost associated with the configured
provisioned throughput. For more information, see Specifying Read and Write Requirements
for Tables (p. 62). However, for this exercise, you will set finite values.
b.
In the Read Capacity Units field, enter 10. In the Write Capacity Units field, enter 5 and click
Continue.
These throughput values allow you up to ten 4 KB read operations and up to five 1 KB write
operations per second. For more information, see DynamoDB Data Model (p. 3).
6.
7.
Note
Repeat this procedure to create the remaining tables described in Use Case 1: Product
Catalog (p. 16) and Use Case 2: Forum Application (p. 16).
The console shows the list of tables. You must wait for the status of all the tables to become ACTIVE.
The console also shows the Details, Monitoring, and Alarm Setup tabs that provide additional information
about the selected table.
Load Data into Tables Using the AWS SDK for Java
In the preceding step, you created sample tables using the console. Now, you can upload the sample
data to these tables. The following Java code example uses the AWS SDK for Java to upload the sample
data. For step-by-step instructions on configuring your AWS access keys, setting the default endpoint
and running the sample, see Running Java Examples for DynamoDB (p. 55).
Note
After you run this program, see Verify Data Load (p. 43) to view the tables and data in the
DynamoDB console.
Example - Upload Sample Items Using the AWS SDK for Java
// Copyright 2012-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
// Licensed under the Apache License, Version 2.0.
package com.amazonaws.codesamples;
import
import
import
import
import
java.text.SimpleDateFormat;
java.util.Arrays;
java.util.Date;
java.util.HashSet;
java.util.TimeZone;
import
import
import
import
import
import
com.amazonaws.AmazonServiceException;
com.amazonaws.auth.profile.ProfileCredentialsProvider;
com.amazonaws.services.dynamodbv2.AmazonDynamoDBClient;
com.amazonaws.services.dynamodbv2.document.DynamoDB;
com.amazonaws.services.dynamodbv2.document.Item;
com.amazonaws.services.dynamodbv2.document.Table;
.withNumber("Price", 2)
.withString("Dimensions", "8.5 x 11.0 x 0.5")
.withNumber("PageCount", 500)
.withBoolean("InPublication", true)
.withString("ProductCategory", "Book");
table.putItem(item);
item = new Item()
.withPrimaryKey("Id", 102)
.withString("Title", "Book 102 Title")
.withString("ISBN", "222-2222222222")
.withStringSet("Authors", new HashSet<String>(
Arrays.asList("Author1", "Author2")))
.withNumber("Price", 20)
.withString("Dimensions", "8.5 x 11.0 x 0.8")
.withNumber("PageCount", 600)
.withBoolean("InPublication", true)
.withString("ProductCategory", "Book");
table.putItem(item);
item = new Item()
.withPrimaryKey("Id", 103)
.withString("Title", "Book 103 Title")
.withString("ISBN", "333-3333333333")
.withStringSet( "Authors", new HashSet<String>(
Arrays.asList("Author1", "Author2")))
// Intentional. Later we'll run Scan to find price error. Find
// items > 1000 in price.
.withNumber("Price", 2000)
.withString("Dimensions", "8.5 x 11.0 x 1.5")
.withNumber("PageCount", 600)
.withBoolean("InPublication", false)
.withString("ProductCategory", "Book");
table.putItem(item);
// Add bikes.
item = new Item()
.withPrimaryKey("Id", 201)
.withString("Title", "18-Bike-201")
// Size, followed by some title.
.withString("Description", "201 Description")
.withString("BicycleType", "Road")
.withString("Brand", "Mountain A")
// Trek, Specialized.
.withNumber("Price", 100)
.withString("Gender", "M")
// Men's
.withStringSet("Color", new HashSet<String>(
Arrays.asList("Red", "Black")))
.withString("ProductCategory", "Bicycle");
table.putItem(item);
item = new Item()
.withPrimaryKey("Id", 202)
.withString("Title", "21-Bike-202")
.withString("Description", "202 Description")
.withString("BicycleType", "Road")
.withString("Brand", "Brand-Company A")
.withNumber("Price", 200)
.withString("Gender", "M")
.withStringSet("Color", new HashSet<String>(
Arrays.asList("Green", "Black")))
.withString("ProductCategory", "Bicycle");
table.putItem(item);
item = new Item()
.withPrimaryKey("Id", 203)
.withString("Title", "19-Bike-203")
.withString("Description", "203 Description")
.withString("BicycleType", "Road")
.withString("Brand", "Brand-Company B")
.withNumber("Price", 300)
.withString("Gender", "W")
// Women's
.withStringSet( "Color", new HashSet<String>(
Arrays.asList("Red", "Green", "Black")))
.withString("ProductCategory", "Bicycle");
table.putItem(item);
item = new Item()
.withPrimaryKey("Id", 204)
.withString("Title", "18-Bike-204")
.withString("Description", "204 Description")
.withString("BicycleType", "Mountain")
.withString("Brand", "Brand-Company B")
.withNumber("Price", 400)
.withString("Gender", "W")
.withStringSet("Color", new HashSet<String>(
Arrays.asList("Red")))
.withString("ProductCategory", "Bicycle");
table.putItem(item);
item = new Item()
.withPrimaryKey("Id", 205)
.withString("Title", "20-Bike-205")
.withString("Description", "205 Description")
.withString("BicycleType", "Hybrid")
.withString("Brand", "Brand-Company C")
.withNumber("Price", 500)
.withString("Gender", "B")
// Boy's
.withStringSet("Color", new HashSet<String>(
Arrays.asList("Red", "Black")))
.withString("ProductCategory", "Bicycle");
table.putItem(item);
} catch (Exception e) {
System.err.println("Failed to create item in " + tableName);
System.err.println(e.getMessage());
}
}
private static void loadSampleForums(String tableName) {
Load Data into Tables Using the AWS SDK for .NET
In the preceding step, you created sample tables using the console. Now, you can upload sample data
to these tables. The following C# code example uses the AWS SDK for .NET document model API to
upload sample data. For step-by-step instructions on configuring your AWS access keys, setting the
default endpoint and running the sample, see Running .NET Examples for DynamoDB (p. 57).
Note
After you run this program, see Verify Data Load (p. 43) to view the tables and data in the
DynamoDB console.
Example - Upload Sample Items Using the AWS SDK for .NET Document Model API
using System;
using System.Collections.Generic;
using Amazon.DynamoDBv2;
using Amazon.DynamoDBv2.DocumentModel;
using Amazon.Runtime;
using Amazon.SecurityToken;
namespace com.amazonaws.codesamples
{
class SampleDataLoad
{
private static AmazonDynamoDBClient client = new AmazonDynamoDBClient();
book2["Id"] = 102;
book2["Title"] = "Book 102 Title";
book2["ISBN"] = "222-2222222222";
book2["Authors"] = new List<string> { "Author 1", "Author 2" }; ;
book2["Price"] = 20;
book2["Dimensions"] = "8.5 x 11.0 x 0.8";
book2["PageCount"] = 600;
book2["InPublication"] = true;
book2["ProductCategory"] = "Book";
productCatalogTable.PutItem(book2);
productCatalogTable.PutItem(bicycle1);
forum1["Threads"] = 2;
forum1["Messages"] = 4;
forum1["Views"] = 1000;
forumTable.PutItem(forum1);
forumTable.PutItem(forum2);
}
// Thread 1.
var thread1 = new Document();
thread1["ForumName"] = "Amazon DynamoDB"; // Hash attribute.
thread1["Subject"] = "DynamoDB Thread 1"; // Range attribute.
thread1["Message"] = "DynamoDB thread 1 message text";
thread1["LastPostedBy"] = "User A";
thread1["LastPostedDateTime"] = DateTime.UtcNow.Subtract(new
TimeSpan(14, 0, 0, 0));
thread1["Views"] = 0;
thread1["Replies"] = 0;
thread1["Answered"] = false;
threadTable.PutItem(thread1);
// Thread 2.
var thread2 = new Document();
thread2["ForumName"] = "Amazon DynamoDB"; // Hash attribute.
thread2["Subject"] = "DynamoDB Thread 2"; // Range attribute.
thread2["Message"] = "DynamoDB thread 2 message text";
thread2["LastPostedBy"] = "User A";
thread2["LastPostedDateTime"] = DateTime.UtcNow.Subtract(new
TimeSpan(21, 0, 0, 0));
thread2["Views"] = 0;
thread2["Replies"] = 0;
thread2["Answered"] = false;
thread2["Tags"] = new List<string> { "index", "primarykey",
"rangekey" };
threadTable.PutItem(thread2);
// Thread 3.
var thread3 = new Document();
thread3["ForumName"] = "Amazon S3"; // Hash attribute.
thread3["Subject"] = "S3 Thread 1"; // Range attribute.
thread3["Message"] = "S3 thread 3 message text";
thread3["LastPostedBy"] = "User A";
thread3["LastPostedDateTime"] = DateTime.UtcNow.Subtract(new
TimeSpan(7, 0, 0, 0));
thread3["Views"] = 0;
thread3["Replies"] = 0;
thread3["Answered"] = false;
thread3["Tags"] = new List<string> { "largeobjects", "multipart
upload" };
threadTable.PutItem(thread3);
}
// Reply 1 - thread 1.
var thread1Reply1 = new Document();
thread1Reply1["Id"] = "Amazon DynamoDB#DynamoDB Thread 1"; // Hash
attribute.
thread1Reply1["ReplyDateTime"] = DateTime.UtcNow.Subtract(new
TimeSpan(21, 0, 0, 0)); // Range attribute.
thread1Reply1["Message"] = "DynamoDB Thread 1 Reply 1 text";
thread1Reply1["PostedBy"] = "User A";
replyTable.PutItem(thread1Reply1);
// Reply 2 - thread 1.
var thread1reply2 = new Document();
thread1reply2["Id"] = "Amazon DynamoDB#DynamoDB Thread 1"; // Hash
attribute.
thread1reply2["ReplyDateTime"] = DateTime.UtcNow.Subtract(new
TimeSpan(14, 0, 0, 0)); // Range attribute.
thread1reply2["Message"] = "DynamoDB Thread 1 Reply 2 text";
thread1reply2["PostedBy"] = "User B";
replyTable.PutItem(thread1reply2);
// Reply 3 - thread 1.
var thread1Reply3 = new Document();
thread1Reply3["Id"] = "Amazon DynamoDB#DynamoDB Thread 1"; // Hash
attribute.
thread1Reply3["ReplyDateTime"] = DateTime.UtcNow.Subtract(new
TimeSpan(7, 0, 0, 0)); // Range attribute.
thread1Reply3["Message"] = "DynamoDB Thread 1 Reply 3 text";
thread1Reply3["PostedBy"] = "User B";
replyTable.PutItem(thread1Reply3);
// Reply 1 - thread 2.
var thread2Reply1 = new Document();
thread2Reply1["Id"] = "Amazon DynamoDB#DynamoDB Thread 2"; // Hash
attribute.
thread2Reply1["ReplyDateTime"] = DateTime.UtcNow.Subtract(new
TimeSpan(7, 0, 0, 0)); // Range attribute.
thread2Reply1["Message"] = "DynamoDB Thread 2 Reply 1 text";
thread2Reply1["PostedBy"] = "User A";
replyTable.PutItem(thread2Reply1);
// Reply 2 - thread 2.
var thread2Reply2 = new Document();
thread2Reply2["Id"] = "Amazon DynamoDB#DynamoDB Thread 2"; // Hash
attribute.
thread2Reply2["ReplyDateTime"] = DateTime.UtcNow.Subtract(new
TimeSpan(1, 0, 0, 0)); // Range attribute.
thread2Reply2["Message"] = "DynamoDB Thread 2 Reply 2 text";
thread2Reply2["PostedBy"] = "User A";
replyTable.PutItem(thread2Reply2);
}
}
}
Load Data into Tables Using the AWS SDK for PHP
Note
This topic assumes that you are already following the instructions for Creating Tables and Loading
Sample Data (p. 14) and have the AWS SDK for PHP properly installed. For information about
setting up the SDK, configuring your AWS access keys and setting the default endpoint, see
Running PHP Examples (p. 59).
After you create a table and the table is in the ACTIVE state, you can begin performing data operations
on the table.
Example - Upload Sample Items Using the AWS SDK for PHP
The following PHP code example adds items to your existing tables using the PHP command put_item.
Notice the following code example puts 8 items in the ProductCatalog table. The table has a write capacity
units value of 5.You might see ProvisionedThroughputExceeded errors in the response from DynamoDB.
However, the AWS SDKs retry requests for this error, and eventually all of the data is written to the table.
Note
After you run this program, see Verify Data Load (p. 43) to view the tables and data in the
DynamoDB console.
<?php
use Aws\DynamoDb\DynamoDbClient;
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' // replace with your desired region
));
# Setup some local variables for dates
date_default_timezone_set('UTC');
$oneDayAgo = date('Y-m-d H:i:s', strtotime('-1 days'));
$sevenDaysAgo = date('Y-m-d H:i:s', strtotime('-7 days'));
$fourteenDaysAgo = date('Y-m-d H:i:s', strtotime('-14 days'));
$twentyOneDaysAgo = date('Y-m-d H:i:s', strtotime('-21 days'));
$tableName = 'ProductCatalog';
echo "Adding data to the $tableName table..." . PHP_EOL;
$response = $client->batchWriteItem(array(
'RequestItems' => array(
$tableName => array(
array(
'PutRequest' => array(
'Item' => array(
'Id'
=>
'Title'
=>
'ISBN'
=>
'Authors'
=>
'Price'
=>
'Dimensions'
=>
'PageCount'
=> array('N' => '500'),
'InPublication'
=> array('N' => '1'),
'ProductCategory' => array('S' => 'Book')
)
),
),
array(
'PutRequest' => array(
'Item' => array(
'Id'
'Title'
'ISBN'
'Authors'
=>
=>
=>
=>
'Author2')),
'Price'
'Dimensions'
'PageCount'
=> array('N' => '600'),
'InPublication'
=> array('N' => '1'),
'ProductCategory' => array('S' => 'Book')
)
),
),
array(
'PutRequest' => array(
'Item' => array(
'Id'
'Title'
'ISBN'
'Authors'
=>
=>
=>
=>
'Author2')),
'Price'
'Dimensions'
'PageCount'
=> array('N' => '600'),
'InPublication'
=> array('N' => '0'),
'ProductCategory' => array('S' => 'Book')
)
),
),
array(
'PutRequest' => array(
'Item' => array(
'Id'
'Title'
'Description'
'BicycleType'
'Brand'
'Price'
'Gender'
'Color'
'Black')),
'ProductCategory' => array('S' => 'Bicycle')
)
),
),
array(
'PutRequest' => array(
'Item' => array(
'Id'
'Title'
'Description'
'BicycleType'
'Brand'
'Price'
'Gender'
'Color'
'Black')),
'ProductCategory' => array('S' => 'Bicycle')
)
),
),
array(
'PutRequest' => array(
'Item' => array(
'Id'
'Title'
'Description'
'BicycleType'
'Brand'
'Price'
'Gender'
'Color'
'Black')),
'ProductCategory' => array('S' => 'Bicycle')
)
),
),
array(
'PutRequest' => array(
'Item' => array(
'Id'
'Title'
'Description'
'BicycleType'
'Brand'
'Price'
'Gender'
'Color'
'ProductCategory'
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
)
),
),
array(
'PutRequest' => array(
'Item' => array(
'Id'
'Title'
'Description'
'BicycleType'
'Brand'
'Price'
'Gender'
'Color'
'Black')),
'ProductCategory' => array('S' => 'Bicycle')
)
)
)
),
),
));
echo "done." . PHP_EOL;
$tableName = 'Forum';
echo "Adding data to the $tableName table..." . PHP_EOL;
$response = $client->batchWriteItem(array(
'RequestItems' => array(
$tableName => array(
array(
'PutRequest' => array(
'Item' => array(
'Name'
=> array('S'
'Category' => array('S'
'Threads' => array('N'
'Messages' => array('N'
'Views'
=> array('N'
)
)
),
array(
'PutRequest' => array(
'Item' => array(
'Name'
=> array('S'
'Category' => array('S'
'Threads' => array('N'
)
)
),
)
)
));
=>
=>
=>
=>
=>
'Amazon DynamoDB'),
'Amazon Web Services'),
'0'),
'0'),
'1000')
$tableName = 'Reply';
echo "Adding data to the $tableName table..." . PHP_EOL;
$response = $client->batchWriteItem(array(
'RequestItems' => array(
$tableName => array(
array(
'PutRequest' => array(
'Item' => array(
'Id'
=> array('S' => 'Amazon DynamoDB#DynamoDB
Thread 1'),
'ReplyDateTime' => array('S' => $fourteenDaysAgo),
'Message'
=> array('S' => 'DynamoDB Thread 1 Reply
2 text'),
'PostedBy'
=> array('S' => 'User B')
)
)
),
array(
'PutRequest' => array(
'Item' => array(
'Id'
=> array('S' => 'Amazon DynamoDB#DynamoDB
Thread 2'),
'ReplyDateTime' => array('S' => $twentyOneDaysAgo),
'Message'
=> array('S' => 'DynamoDB Thread 2 Reply
3 text'),
'PostedBy'
)
)
),
array(
'PutRequest' => array(
'Item' => array(
'Id'
=> array('S' => 'Amazon DynamoDB#DynamoDB
Thread 2'),
'ReplyDateTime' => array('S' => $sevenDaysAgo),
'Message'
=> array('S' => 'DynamoDB Thread 2 Reply
2 text'),
'PostedBy'
)
)
),
array(
'PutRequest' => array(
'Item' => array(
'Id'
=> array('S' => 'Amazon DynamoDB#DynamoDB
Thread 2'),
'ReplyDateTime' => array('S' => $oneDayAgo),
'Message'
=> array('S' => 'DynamoDB Thread 2 Reply
1 text'),
'PostedBy'
)
)
)
),
)
));
echo "done." . PHP_EOL;
?>
Sign in to the AWS Management Console and open the DynamoDB console at https://
console.aws.amazon.com/dynamodb/.
2.
3.
To query a table
1.
2.
If you have not already signed in, you will see the Sign In dialog before you see the console.
In the Tables pane, select the Reply table and click Explore Table.
3.
Note
A Query operation is only valid for tables that have a hash and range type primary key. If
you explore a table with a hash type primary key, the console will display Get instead of
Query.
4.
Specify the Hash Key and Range Key values and select comparison operators as shown in the
following screen shot. For the Hash Key, enter Amazon DynamoDB#DynamoDB Thread 1. For the
Range Key (ReplyDateTime), set the condition to greater than and enter a date 15 days earlier than
today's date. Use the format YYYY-MM-DD for the date.
Note that the Range Key (ReplyDateTime) value shown is only for illustration. The date value you
will use depends on when you uploaded the sample data.
5.
Click Go.
The Browse Items tab shows the query result.
For step-by-step instructions on configuring your AWS access keys, setting the default endpoint and
running the sample, see Running Java Examples for DynamoDB (p. 55).
// Copyright 2012-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
// Licensed under the Apache License, Version 2.0.
package com.amazonaws.codesamples;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Iterator;
import
import
import
import
import
import
import
import
import
com.amazonaws.auth.profile.ProfileCredentialsProvider;
com.amazonaws.services.dynamodbv2.AmazonDynamoDBClient;
com.amazonaws.services.dynamodbv2.document.DynamoDB;
com.amazonaws.services.dynamodbv2.document.Item;
com.amazonaws.services.dynamodbv2.document.ItemCollection;
com.amazonaws.services.dynamodbv2.document.QueryOutcome;
com.amazonaws.services.dynamodbv2.document.Table;
com.amazonaws.services.dynamodbv2.document.spec.QuerySpec;
com.amazonaws.services.dynamodbv2.document.utils.ValueMap;
}
private static void findRepliesInLast15DaysWithConfig(
String tableName, String forumName, String threadSubject) {
String replyId = forumName + "#" + threadSubject;
long twoWeeksAgoMilli = (new Date()).getTime()
- (15L * 24L * 60L * 60L * 1000L);
Date twoWeeksAgo = new Date();
twoWeeksAgo.setTime(twoWeeksAgoMilli);
SimpleDateFormat df = new SimpleDateFormat("yyyy-MMdd'T'HH:mm:ss.SSS'Z'");
String twoWeeksAgoStr = df.format(twoWeeksAgo);
Table table = dynamoDB.getTable(tableName);
QuerySpec querySpec = new QuerySpec()
.withKeyConditionExpression("Id = :v1 and ReplyDateTime > :v2")
.withValueMap(new ValueMap()
.withString(":v1", replyId)
.withString(":v2", twoWeeksAgoStr))
.withProjectionExpression("Message, ReplyDateTime, PostedBy");
ItemCollection<QueryOutcome> items = table.query(querySpec);
Iterator<Item> iterator = items.iterator();
System.out.println("Query: printing results...");
while (iterator.hasNext()) {
System.out.println(iterator.next().toJSONPretty());
}
}
}
For step-by-step instructions on configuring your AWS access keys, setting the default endpoint and
running the sample, see Running .NET Examples for DynamoDB (p. 57).
using System;
using System.Collections.Generic;
using Amazon.DynamoDBv2;
using Amazon.DynamoDBv2.Model;
using Amazon.Runtime;
using Amazon.Util;
namespace com.amazonaws.codesamples
{
class SampleDataTryQuery
{
private static AmazonDynamoDBClient client = new AmazonDynamoDBClient();
string threadSubject)
{
string replyId = forumName + "#" + threadSubject;
DateTime twoWeeksAgoDate = DateTime.UtcNow - TimeSpan.FromDays(15);
string twoWeeksAgoString =
twoWeeksAgoDate.ToString(AWSSDKUtils.ISO8601DateFormat);
Dictionary<string, AttributeValue> lastKeyEvaluated = null;
do
{
var request = new QueryRequest
{
TableName = "Reply",
KeyConditionExpression = "Id = :v_replyId and ReplyDateTime
> :v_datetime",
ExpressionAttributeValues = new Dictionary<string, Attrib
uteValue> {
{":v_replyId", new AttributeValue { S = replyId }},
{":v_datetime", new AttributeValue { S = twoWeek
sAgoString }}
},
// Optional parameter.
ProjectionExpression = "Id, ReplyDateTime, PostedBy",
// Optional parameter.
ConsistentRead = true,
Limit = 2, // The Reply table has only a few sample items.
So the page size is smaller.
ExclusiveStartKey = lastKeyEvaluated,
ReturnConsumedCapacity = "TOTAL"
};
// Optional parameter.
request.ProjectionExpression = "Id, ReplyDateTime, PostedBy";
// Optional parameter.
request.ConsistentRead = true;
request.Limit = 2; // The Reply table has only a few sample
items. So the page size is smaller.
request.ExclusiveStartKey = lastKeyEvaluated;
request.ReturnConsumedCapacity = "TOTAL";
var response = client.Query(request);
Console.WriteLine("No. of reads used (by query in FindReplies
ForAThreadSpecifyLimit) {0}\n",
response.ConsumedCapacity.CapacityUnits);
foreach (var item in response.Items)
{
PrintItem(item);
}
lastKeyEvaluated = response.LastEvaluatedKey;
} while (lastKeyEvaluated != null && lastKeyEvaluated.Count !=
0);
Sign in to the AWS Management Console and open the DynamoDB console at https://
console.aws.amazon.com/dynamodb/.
Select the table that you want to delete.
3.
Click the Delete Table button. You will be asked to confirm your selection.
4.
Select the Delete this table check box and click Delete.
This deletes the table from DynamoDB, along with the CloudWatch alarms and export/import pipelines
associated with this table.
API
Comment
Document API
The AWS SDK for Java Document API provides an intuitive interface for DynamoDB operations. With this API,
you work with Tables, Items, Attributes, and other objects
that closely resemble their counterparts in the database.
The Document API also provides utilities for working
with document data types, such as Lists and Maps. Finally, the document API makes it easy to store and retrieve JSON documents in DynamoDB.
The following sections describe the document API and
also provide working samples:
Working with Tables Using the AWS SDK for Java
Document API (p. 73)
Working with Items Using the AWS SDK for Java
Document API (p. 121)
Querying Using the AWS SDK for Java Document
API (p. 203)
Scanning Using the AWS SDK for Java Document
API (p. 223)
The Document API resides in the com.amazonaws.services.dynamodbv2.document namespace.
High-level API
Low-level API
Note
These APIs provide thread-safe clients for accessing DynamoDB. As a best practice, your
applications should create one client and reuse the client between threads.
For more information about the AWS SDK for Java API, go to the AWS SDK for Java API Reference.
Choosing a JVM
For the best performance of your server-based applications with the AWS SDK for Java, we recommend
that you use the 64-bit version of the Java Virtual Machine (JVM). This JVM runs only in Server mode,
even if you specify the -Client option at run time. Using the 32-bit version of the JVM with the -Server
option at run time should provide comparable performance to the 64-bit JVM.
Download and install the AWS Toolkit for Eclipse. This toolkit includes the AWS SDK for
Java, along with preconfigured templates for building applications.
You will now need to create a default credential profiles file. This file enhances security by
storing your credentials separately from your project directories, so that they cannot be unintentionally committed to a public repository. For more information, see Using the Default
Credential Provider Chain in the AWS SDK for Java Developer Guide.
The credential properties file should be saved as ~/.aws/credentials, where the tilde
character represents your home directory. In this file, you can store multiple sets of credentials
from any number of accounts. Each set is referred to as a profile. The following is an example
of a credential properties file with a profile named default:
[default]
aws_access_key_id = <Your Access Key ID>
aws_secret_access_key = <Your Secret Key>
The code examples in this document use the default client constructors that read your AWS
credentials stored in the credential properties file.
4
Copy the code from the section that you are reading to your project.
For a current list of supported regions and endpoints, see Regions and Endpoints.
Note
The low-level API and high-level API provide thread-safe clients for accessing DynamoDB. As
a best practice, your applications should create one client and reuse the client between threads.
API
Comment
Low-level API
API
Comment
Download and install the AWS SDK for .NET. This toolkit includes the AWS .NET library
and the AWS Toolkit for Visual Studio, along with preconfigured templates for building applications.
Create a new Visual Studio project using the AWS Empty Project template. You get this
template if you installed the Toolkit for Visual Studio.
The AWS Access Credentials dialog box opens.
In the AWS Access Credentials dialog box, select either an account that you previously
added to the toolkit, or add a new account. For each account that you add to the toolkit, you
must provide your AWS access keys credentials.
Visual Studio saves your credentials in the SDK Store. The SDK Store enhances security
by storing your credentials separately from your project directories, so that they cannot be
unintentionally committed to a public repository. For more information, see Setting Up the
AWS Toolkit for Visual Studio in the AWS Toolkit for Visual Studio User Guide.
The Toolkit for Visual Studio supports multiple sets of credentials from any number of accounts. Each set is referred to as a profile. Visual Studio adds entries to the project's
App.config file so that your application can find the AWS Credentials at runtime:
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="default"/>
<add key="AWSRegion" value="us-west-2" />
</appSettings>
</configuration>
The code examples in this document use the default client constructors that read your AWS
credentials stored in the SDK Store.
4
Note that the AWS Empty Project template includes the required AWSSDK reference.
Replace the code in the project file, Program.cs, with the code in the section you are
reading.
You can also set the DynamoDB endpoint explicitly from the app.config file, as shown in the following C#
code snippet.
private static void CreateClient()
{
AmazonDynamoDBConfig config = new AmazonDynamoDBConfig();
config.ServiceURL = System.Configuration.ConfigurationManager.AppSettings["Ser
viceURL"];
client = new AmazonDynamoDBClient(config);
}
For a current list of supported regions and endpoints, see Regions and Endpoints.
Note
The setup for using the AWS SDK for PHP depends on your environment and how you want to
run your application. To set up your environment to run the examples in this documentation, see
the AWS SDK for PHP Getting Started Guide.
Download and install the AWS SDK for PHP, and then verify that your environment meets
the minimum requirements as described in the AWS SDK for PHP Getting Started Guide.
Install the AWS SDK for PHP according to the instructions in the AWS SDK for PHP Getting
Started Guide. Depending on the installation method that you use, you might have to
modify your code to resolve dependencies among the PHP extensions.
The PHP code samples in this document use the Composer dependency manager that is
described in the AWS SDK for PHP Getting Started Guide.
Configure your credentials provider for the AWS SDK for PHP. For more information, go to
Providing Credentials to the SDK in the AWS SDK for PHP Getting Started Guide.
use Aws\DynamoDb\DynamoDbClient;
$client = DynamoDbClient::factory(array(
'profile' => 'default',
));
For more information, go to Providing Credentials to the SDK in the AWS SDK for PHP Getting Started
Guide
For a current list of supported regions and endpoints, see Regions and Endpoints.
uniquely identified by the combination of its hash and range key values. It is possible for two items to
have the same hash key value, but those two items must have different range key values.
in determining how many read capacity units you need to provision for your table. By default, DynamoDB
read operations are eventually consistent. Some of these operations allow you to specify strongly
consistent reads.
Local secondary indexes If you want to create one or more local secondary indexes on a table,
you must do so at table creation time. DynamoDB automatically creates and maintains these indexes.
Queries against indexes consume provisioned read throughput. If you write to a table, DynamoDB will
automatically write data to the indexes when needed, to keep them synchronized with the table. The
capacity units consumed by index operations are charged against the table's provisioned throughput.
In other words, you only specify provisioned throughput settings for the table, not for each individual
index on that table. For more information, see Provisioned Throughput Considerations for Local
Secondary Indexes (p. 316).
These factors help you to determine your application's throughput requirements that you provide when
you create a table. You can monitor the performance using CloudWatch metrics, and even configure
alarms to notify you in the event you reach certain threshold of consumed capacity units. The DynamoDB
console provides several default metrics that you can review to monitor your table performance and adjust
the throughput requirements as needed. For more information, go to DynamoDB Console.
DynamoDB automatically distributes your data across table partitions, which are stored on multiple servers.
For optimal throughput, you should distribute read requests as evenly as possible across these partitions.
For example, you might provision a table with 1 million read capacity units per second. If you issue 1
million requests for a single item in the table, all of the read activity will be concentrated on a single
partition. However, if you spread your requests across all of the items in the table, DynamoDB can access
the table partitions in parallel, and allow you to reach your provisioned throughput goal for the table.
For reads, the following table compares some provisioned throughput values for different average item
sizes, request rates, and consistency combinations.
Expected Item Size Consistency
Provisioned Throughput
Required
4 KB
Strongly consistent
50
50
8 KB
Strongly consistent
50
100
4 KB
Eventually consistent 50
25
8 KB
Eventually consistent 50
50
Item sizes for reads are rounded up to the next 4 KB multiple. For example, an item of 3,500 bytes
consumes the same throughput as a 4 KB item.
For writes, the following table compares some provisioned throughput values for different average item
sizes and write request rates.
Expected Item Size
1 KB
50
50
2 KB
50
100
Item sizes for writes are rounded up to the next 1 KB multiple. For example, an item of 500 bytes consumes
the same throughput as a 1 KB item.
DynamoDB commits resources to your requested read and write capacity units, and, consequently, you
are expected to stay within your requested rates. Provisioned throughput also depends on the size of the
requested data. If your read or write request rate, combined with the cumulative size of the requested
data, exceeds the current reserved capacity, DynamoDB returns an error that indicates that the provisioned
throughput level has been exceeded.
Set your provisioned throughput using the ProvisionedThroughput parameter. For information about
setting the ProvisionedThroughput parameter, see CreateTable in the Amazon DynamoDB API
Reference.
For information about using provisioned throughput, see Guidelines for Working with Tables (p. 66).
Note
If you expect upcoming spikes in your workload (such as a new product launch) that will cause
your throughput to exceed the current provisioned throughput for your table, we advise that you
use the UpdateTable operation to increase the ProvisionedThroughput value. For the current
maximum Provisioned Throughput values per table or account, see Limits in DynamoDB (p. 664).
When you issue an UpdateTable request, the status of the table changes from AVAILABLE to
UPDATING. The table remains fully available for use while it is UPDATING. During this time,
DynamoDB allocates the necessary resources to support the new provisioned throughput levels.
When this process is completed, the table status changes from UPDATING to AVAILABLE.
Note
You can optimize the read capacity consumption by making individual items as small as possible.
The easiest way to do so is to minimize the length of the attribute names. You can also reduce
item size by storing less frequently accessed attributes in a separate table.
The size of an item is the sum of the lengths of its attribute names and values.
The size of a Null or Boolean attribute value is (length of the attribute name + one byte).
An attribute of type List or Map requires 3 bytes of overhead, regardless of its contents. The size of an
empty List or Map is (length of the attribute name + 3 bytes). If the attribute is non-empty, the size is
(length of the attribute name + sum (length of attribute values) + 3 bytes).
DynamoDB reads data in blocks of 4 KB. For GetItem, which reads only one item, DynamoDB rounds
the item size up to the next 4 KB. For example, if you get an item of 3.5 KB, DynamoDB rounds the items
size to 4 KB. If you get an item of 10 KB, DynamoDB rounds the item size to 12 KB.
DynamoDB writes data in blocks of 1 KB. For PutItem, UpdateItem, and DeleteItem, which write
only one item, DynamoDB rounds the item size up to the next 1 KB. For example, if you put or delete an
item of 1.6 KB, DynamoDB rounds the item size up to 2 KB.
If you perform a read operation on an item that does not exist, DynamoDB will still consume provisioned
read throughput: A strongly consistent read request consumes one read capacity unit, while an eventually
consistent read request consumes 0.5 of a read capacity unit.
Most write operations in DynamoDB allow conditional writes, where you specify one or more conditions
that must be met in order for the operation to succeed. Even if a conditional write fails, it still consumes
provisioned throughput. A failed conditional write of a 1 KB item would consume one write capacity unit;
if the item were twice that size, the failed conditional write would consume two write capacity units.
For BatchGetItem, each item in the batch is read separately, so DynamoDB first rounds up the size of
each item to the next 4 KB and then calculates the total size. The result is not necessarily the same as
the total size of all the items. For example, if BatchGetItem reads a 1.5 KB item and a 6.5 KB item,
DynamoDB will calculate the size as 12 KB (4 KB + 8 KB), not 8 KB (1.5 KB + 6.5 KB).
For Query, all items returned are treated as a single read operation. As a result, DynamoDB computes
the total size of all items and then rounds up to the next 4 KB boundary. For example, suppose your query
returns 10 items whose combined size is 40.8 KB. DynamoDB rounds the item size for the operation to
44 KB. If a query returns 1500 items of 64 bytes each, the cumulative size is 96 KB.
In the case of a Scan operation, DynamoDB considers the size of the items that are evaluated, not the
size of the items returned by the scan. For a scan request, DynamoDB evaluates up to 1 MB of items
and returns only the items that satisfy the scan condition.
Note
In computing the storage used by the table, DynamoDB adds 100 bytes of overhead to each
item for indexing purposes. The DescribeTable operation returns a table size that includes
this overhead. This overhead is also included when billing you for the storage costs. However,
this extra 100 bytes is not used in computing the capacity unit calculation. For more information
about pricing, go to DynamoDB Pricing.
For any operation that returns items, you can request a subset of attributes to retrieve; however, doing
so has no impact on the item size calculations. In addition, Query and Scan can return item counts instead
of attribute values. Getting the count of items uses the same quantity of read capacity units and is subject
to the same item size calculations, because DynamoDB has to read each item in order to increment the
count.
The PutItem operation adds an item to the table. If an item with the same primary key exists in the table,
the operation replaces the item. For calculating provisioned throughput consumption, the item size that
matters is the larger of the two.
For an UpdateItem operation, DynamoDB considers the size of the item as it appears before and after
the update. The provisioned throughput consumed reflects the larger of these item sizes. Even if you
update just a subset of the item's attributes, UpdateItem will still consume the full amount of provisioned
throughput (the larger of the "before" and "after" item sizes).
When you issue a DeleteItem request, DynamoDB uses the size of the deleted item to calculate
provisioned throughput consumption.
Note
If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB
might return a ResourceNotFoundException. This is because DescribeTable uses an
eventually consistent query, and the metadata for your table might not be available at that
moment. Wait for a few seconds, and then try the DescribeTable request again.
When it stores data, DynamoDB divides a table's items into multiple partitions, and distributes the data
primarily based upon the hash key element. The provisioned throughput associated with a table is also
divided evenly among the partitions, with no sharing of provisioned throughput across partitions.
Total Provisioned Throughput / Partitions = Throughput Per Partition
Consequently, to achieve the full amount of request throughput you have provisioned for a table, keep
your workload spread evenly across the hash key values. Distributing requests across hash key values
distributes the requests across partitions.
For example, if a table has a very small number of heavily accessed hash key elements, possibly even
a single very heavily used hash key element, request traffic is concentrated on a small number of partitions
potentially only one partition. If the workload is heavily unbalanced, meaning that it is disproportionately
focused on one or a few partitions, the requests will not achieve the overall provisioned throughput level.
To get the most out of DynamoDB throughput, create tables where the hash key element has a large
number of distinct values, and values are requested fairly uniformly, as randomly as possible.
This does not mean that you must access all of the hash keys to achieve your throughput level; nor does
it mean that the percentage of accessed hash keys needs to be high. However, do be aware that when
your workload accesses more distinct hash keys, those requests will be spread out across the partitioned
space in a manner that better utilizes your allocated throughput level. In general, you will utilize your
throughput more efficiently as the ratio of hash keys accessed to total hash keys in a table grows.
Uniformity
Good
Bad
Bad
Good
If a single table has only a very small number of hash key values, consider distributing your write operations
across more distinct hash values. In other words, structure the primary key elements to avoid one "hot"
(heavily requested) hash key value that slows overall performance.
For example, consider a table with a hash and range type primary key. The hash key represents the
item's creation date, rounded to the nearest day. The range key is an item identifier. On a given day, say
2014-07-09, all of the new items will be written to that same hash key value.
If the table will fit entirely into a single partition (taking into consideration growth of your data over time),
and if your application's read and write throughput requirements do not exceed the read and write
capabilities of a single partition, then your application should not encounter any unexpected throttling as
a result of partitioning.
However, if you anticipate scaling beyond a single partition, then you should architect your application
so that it can use more of the table's full provisioned throughput.
Number of partitions required, based solely on a table's provisioned read and write throughput
settings
numPartitionsthroughput = ( readCapacityUnits / 3000 ) + ( writeCapacityUnits / 1000 )
For example, suppose that you provisioned a table with 1000 read capacity units and 500 write capacity
units. In this case, numPartitionsthroughput would be:
( 1000 / 3000 ) + ( 500 / 1000 ) = 0.8333
Therefore, a single partition could accommodate all of the table's provisioned throughput requirements.
However, if you provisioned 1000 read capacity units and 1000 write capacity units, then
numPartitionsthroughput would exceed a single partition's throughput capacity:
( 1000 / 3000 ) + ( 1000 / 1000 ) = 1.333
In this case, the table would require two partitions, each with 500 read capacity units and 500 write capacity
units.
The total number of partitions allocated by DynamoDB is the larger of the table's size or its provisioned
throughput requirements:
Total number of partitions allocated by DynamoDB
numPartitionstotal = MAX ( numPartitionstableSize | numPartitionsthroughput )
A single partition can hold approximately 10 GB of data. If your table size grows beyond 10 GB, DynamoDB
will spread your data across additional partitions, and will also distribute your table's read and write
throughput accordingly. Therefore, as your table grows in size, less throughput will be provisioned per
partition.
Suppose that you have a table that has grown to 500 GB in size. This would mean that the table now
occupies approximately 50 partitions:
500 GB / 10 GB = 50 partitions
Now suppose that you have allocated 100,000 read capacity units to the table. You could determine the
amount of read capacity per partition as follows:
100,000 read capacity units / 50 partitions = 2000 read capacity units per
partition
Note
In the future, these details of partition sizes and throughput allocation per partition may change.
defined for your table. However, do not design your application so that it depends on burst capacity being
available at all times: DynamoDB can and does use burst capacity for background maintenance and other
tasks without prior notice.
Note
In the future, these details of burst capacity may change.
MessageID
U1
U1
U1
...
U1
... up to 100
U2
U2
U2
...
U2
... up to 200
The problem in this case is that you are not distributing your write requests to DynamoDB across your
hash key values. You are taking one hash key at a time and uploading all its items before going to the
next hash key items. Behind the scenes, DynamoDB is partitioning the data in your tables across multiple
servers. To fully utilize all of the throughput capacity that has been provisioned for your tables, you need
to distribute your workload across your hash keys. In this case, by directing an uneven amount of upload
work toward items all with the same hash key, you may not be able to fully utilize all of the resources
DynamoDB has provisioned for your table. You can distribute your upload work by uploading one item
from each hash key first. Then you repeat the pattern for the next set of range keys for all the items until
you upload all the data as shown in the example upload sequence in the following table:
UserID
MessageID
U1
U2
U3
...
....
U1
U2
UserID
MessageID
U3
...
...
Every upload in this sequence uses a different hash key, keeping more DynamoDB servers busy
simultaneously and improving your throughput performance.
A caching solution can mitigate the skewed read activity for popular items. In addition, since it reduces
the amount of read activity against the table, caching can help reduce your overall costs for using
DynamoDB.
might perform acceptably when there is not very much data in the table. However, as the table becomes
larger, there will be more partitions and less throughput per partition. You might discover that your
application is throttled when it attempts to use the same non-uniform access pattern that worked in the
past.
To avoid problems with "hot" keys when your table becomes larger, make sure that you test your application
design at scale. Consider the ratio of storage to throughput when running at scale, and how DynamoDB
will allocate partitions to the table. (For more information, see Understand Partition Behavior (p. 68).)
If it isn't possible for you to generate a large amount of test data, you can create a table that has very
high provisioned throughput settings. This will create a table with many partitions; you can then use
UpdateTable to reduce the settings, but keep the same ratio of storage to throughput that you determined
for running the application at scale. You now have a table that has the throughput-per-partition ratio that
you expect after it grows to scale. Test your application against this table using a realistic workload.
Tables that store time series data can grow in an unbounded manner, and can cause slower application
performance over time. With time series data, applications typically read and write the most recent items
in the table more frequently than older items. If you can remove older time series data from your real-time
table, and archive that data elsewhere, you can maintain a high ratio of throughput per partition.
For best practices with time series data, Understand Access Patterns for Time Series Data (p. 71).
Creating a Table
To create a table, you must provide the table name, its primary key, and the provisioned throughput
values. For more information, see Specifying Read and Write Requirements for Tables (p. 62). The
following Java code snippet creates an example table that uses a numeric type attribute Id as its primary
key.
The following are the steps to create a table using the AWS SDK for Java Document API.
1. Create an instance of the DynamoDB class.
2. Instantiate a CreateTableRequest to provide the request information.
You must provide the table name, attribute definitions, key schema, and provisioned throughput values.
3. Execute the createTable method by providing the request object as a parameter.
The table will not be ready for use until DynamoDB creates it and sets its status to ACTIVE. The
createTable request returns a Table object that you can use to obtain more information about the
table.
TableDescription tableDescription =
dynamoDB.getTable(tableName).describe();
System.out.printf("%s: %s \t ReadCapacityUnits: %d \t WriteCapacityUnits: %d",
tableDescription.getTableStatus(),
tableDescription.getTableName(),
tableDescription.getProvisionedThroughput().getReadCapacityUnits(),
tableDescription.getProvisionedThroughput().getWriteCapacityUnits());
You can call the describeTable method of the client to get table information at any time.
Updating a Table
You can update only the provisioned throughput values of an existing table. Depending on you application
requirements, you might need to update these values.
Note
You can increase the read capacity units and write capacity units anytime. However, you can
decrease these values only four times in a 24 hour period. For additional guidelines and limitations,
see Specifying Read and Write Requirements for Tables (p. 62).
The following are the steps to update a table using the AWS SDK for Java Document API.
1. Create an instance of the Table class.
2. Create an instance of the ProvisionedThroughput class to provide the new throughput values.
3. Execute the updateTable method by providing the ProvisionedThroughput instance as a
parameter.
The following Java code snippet demonstrates the preceding steps.
Deleting a Table
The following are the steps to delete a table.
1. Create an instance of the Table class.
2. Create an instance of the DeleteTableRequest class and provide the table name that you want to
delete.
3. Execute the deleteTable method by providing the Table instance as a parameter.
The following Java code snippet demonstrates the preceding steps.
Listing Tables
To list tables in your account, create an instance of DynamoDB and execute the listTables method.
The ListTables operation requires no parameters.
API Version 2012-08-10
75
com.amazonaws.auth.profile.ProfileCredentialsProvider;
com.amazonaws.services.dynamodbv2.AmazonDynamoDBClient;
com.amazonaws.services.dynamodbv2.document.DynamoDB;
com.amazonaws.services.dynamodbv2.document.Table;
com.amazonaws.services.dynamodbv2.document.TableCollection;
com.amazonaws.services.dynamodbv2.model.AttributeDefinition;
com.amazonaws.services.dynamodbv2.model.CreateTableRequest;
com.amazonaws.services.dynamodbv2.model.KeySchemaElement;
com.amazonaws.services.dynamodbv2.model.KeyType;
com.amazonaws.services.dynamodbv2.model.ListTablesResult;
com.amazonaws.services.dynamodbv2.model.ProvisionedThroughput;
com.amazonaws.services.dynamodbv2.model.TableDescription;
try {
table.updateTable(new ProvisionedThroughput()
.withReadCapacityUnits(6L).withWriteCapacityUnits(7L));
table.waitForActive();
} catch (Exception e) {
System.err.println("UpdateTable request failed for " + tableName);
System.err.println(e.getMessage());
}
}
static void deleteExampleTable() {
Table table = dynamoDB.getTable(tableName);
try {
System.out.println("Issuing DeleteTable request for " + tableName);
table.delete();
System.out.println("Waiting for " + tableName
+ " to be deleted...this may take a while...");
table.waitForDelete();
} catch (Exception e) {
System.err.println("DeleteTable request failed for " + tableName);
System.err.println(e.getMessage());
}
}
}
Creating a Table
To create a table, you must provide the table name, its primary key, and the provisioned throughput
values. For more information, see Specifying Read and Write Requirements for Tables (p. 62).
The following are the steps to create a table using the .NET low-level API.
1. Create an instance of the AmazonDynamoDBClient class.
2. Create an instance of the CreateTableRequest class to provide the request information.
You must provide the table name, primary key, and the provisioned throughput values.
3. Execute the AmazonDynamoDBClient.CreateTable method by providing the request object as a
parameter.
The following C# code snippet demonstrates the preceding steps. The sample creates a table
(ProductCatalog) that uses Id as the primary key and set of provisioned throughput values. Depending
on your application requirements, you can update the provisioned throughput values by using the
UpdateTable API.
AmazonDynamoDBClient client = new AmazonDynamoDBClient();
string tableName = "ProductCatalog";
var request = new CreateTableRequest
{
TableName = tableName,
AttributeDefinitions = new List<AttributeDefinition>()
{
new AttributeDefinition
{
AttributeName = "Id",
AttributeType = "N"
}
},
KeySchema = new List<KeySchemaElement>()
{
new KeySchemaElement
{
AttributeName = "Id",
KeyType = "HASH"
}
},
ProvisionedThroughput = new ProvisionedThroughput
{
ReadCapacityUnits = 10,
WriteCapacityUnits = 5
}
};
var response = client.CreateTable(request);
You must wait until DynamoDB creates the table and sets the table status to ACTIVE. The CreateTable
response includes the TableDescription property that provides the necessary table information.
var result = response.CreateTableResult;
var tableDescription = result.TableDescription;
Console.WriteLine("{1}: {0} \t ReadCapacityUnits: {2} \t WriteCapacityUnits:
{3}",
tableDescription.TableStatus,
tableDescription.TableName,
tableDescription.ProvisionedThroughput.ReadCapacityUnits,
tableDescription.ProvisionedThroughput.WriteCapacityUnits);
string status = tableDescription.TableStatus;
Console.WriteLine(tableName + " - " + status);
You can also call the DescribeTable method of the client to get table information at anytime.
var res = client.DescribeTable(new DescribeTableRequest{TableName = "Product
Catalog"});
Updating a Table
You can update only the provisioned throughput values of an existing table. Depending on you application
requirements, you might need to update these values.
Note
You can increase the read capacity units and write capacity units anytime.You can also decrease
read capacity units anytime. However, you can decrease write capacity units only four times in
a 24 hour period. Any change you make must be at least 10% different from the current values.
For additional guidelines and limitations, see Specifying Read and Write Requirements for
Tables (p. 62).
API Version 2012-08-10
80
The following are the steps to update a table using the .NET low-level API.
1. Create an instance of the AmazonDynamoDBClient class.
2. Create an instance of the UpdateTableRequest class to provide the request information.
You must provide the table name and the new provisioned throughput values.
3. Execute the AmazonDynamoDBClient.UpdateTable method by providing the request object as a
parameter.
The following C# code snippet demonstrates the preceding steps.
AmazonDynamoDBClient client = new AmazonDynamoDBClient();
string tableName = "ExampleTable";
var request = new UpdateTableRequest()
{
TableName = tableName,
ProvisionedThroughput = new ProvisionedThroughput()
{
// Provide new values.
ReadCapacityUnits = 20,
WriteCapacityUnits = 10
}
};
var response = client.UpdateTable(request);
Deleting a Table
The following are the steps to delete a table using the .NET low-level API.
1. Create an instance of the AmazonDynamoDBClient class.
2. Create an instance of the DeleteTableRequest class and provide the table name that you want to
delete.
3. Execute the AmazonDynamoDBClient.DeleteTable method by providing the request object as a
parameter.
The following C# code snippet demonstrates the preceding steps.
AmazonDynamoDBClient client = new AmazonDynamoDBClient();
string tableName = "ExampleTable";
var request = new DeleteTableRequest{ TableName = tableName };
var response = client.DeleteTable(request);
Listing Tables
To list tables in your account using the AWS SDK for .NET low-level API, create an instance of the
AmazonDynamoDBClient and execute the ListTables method. The ListTables operation requires no
parameters. However, you can specify optional parameters. For example, you can set the Limit parameter
if you want to use paging to limit the number of table names per page. This requires you to create a
ListTablesRequest object and provide optional parameters as shown in the following C# code snippet.
Along with the page size, the request sets the ExclusiveStartTableName parameter. Initially,
ExclusiveStartTableName is null, however, after fetching the first page of result, to retrieve the next
API Version 2012-08-10
81
page of result, you must set this parameter value to the LastEvaluatedTableName property of the
current result.
AmazonDynamoDBClient client = new AmazonDynamoDBClient();
// Initial value for the first page of table names.
string lastEvaluatedTableName = null;
do
{
// Create a request object to specify optional parameters.
var request = new ListTablesRequest
{
Limit = 10, // Page size.
ExclusiveStartTableName = lastEvaluatedTableName
};
var response = client.ListTables(request);
ListTablesResult result = response.ListTablesResult;
foreach (string name in result.TableNames)
Console.WriteLine(name);
lastEvaluatedTableName = result.LastEvaluatedTableName;
} while (lastEvaluatedTableName != null);
System;
System.Collections.Generic;
Amazon.DynamoDBv2;
Amazon.DynamoDBv2.Model;
Amazon.Runtime;
namespace com.amazonaws.codesamples
{
class LowLevelTableExample
{
private static AmazonDynamoDBClient client = new AmazonDynamoDBClient();
private static string tableName = "ExampleTable";
static void Main(string[] args)
{
try
{
CreateExampleTable();
ListMyTables();
GetTableInformation();
}
}
Creating a Table
To create a table, you must provide the table name, its primary key, and the provisioned throughput
values. For more information, see Specifying Read and Write Requirements for Tables (p. 62). The
following PHP code sample creates an ExampleTable that uses a numeric type attribute Id as its primary
key.
The following are the steps to create a table using the AWS SDK for PHP.
1. Create an instance of the DynamoDbClient class.
2. Provide the parameters for the createTable operation to the client instance.
You must provide the table name, its primary key, attribute type definitions, and the provisioned
throughput values.
3. Load the response into a local variable, such as $response, for use in your application.
The following PHP code snippet demonstrates the preceding steps. The code creates a table
(ProductCatalog) that uses Id as the primary key and set of provisioned throughput values. Depending
on your application requirements, you can update the provisioned throughput values by using the
updateTable method.
use Aws\DynamoDb\DynamoDbClient;
$client = DynamoDbClient::factory(array(
));
$tableName = 'ExampleTable';
echo "# Creating table $tableName..." . PHP_EOL;
$result = $client->createTable(array(
'TableName' => $tableName,
'AttributeDefinitions' => array(
array(
'AttributeName' => 'Id',
'AttributeType' => 'N'
)
),
'KeySchema' => array(
array(
'AttributeName' => 'Id',
'KeyType' => 'HASH'
)
),
'ProvisionedThroughput' => array(
'ReadCapacityUnits'
=> 5,
'WriteCapacityUnits' => 6
)
));
print_r($result->getPath('TableDescription'));
You must wait until DynamoDB creates the table and sets the table status to ACTIVE before you can put
data into the table. You can use the client's waitUntil function to wait until the table's status becomes
ACTIVE. For more information, see the DescribeTable operation.
The following code snippet demonstrates a sleep operation to wait for the table to be in the ACTIVE state.
$client->waitUntilTableExists(array('TableName' => $tableName));
echo "table $tableName has been created." . PHP_EOL;
Updating a Table
You can update the provisioned throughput values of an existing table. Depending on your application
requirements, you might need to update these values.
Note
You can increase the read capacity units and write capacity units anytime. However, you can
decrease these values only four times in a 24 hour period. For additional guidelines and limitations,
see Specifying Read and Write Requirements for Tables (p. 62).
The following are the steps to update a table using the AWS SDK for PHP API.
1. Create an instance of the DynamoDbClient class.
2. Provide the parameters for the updateTable operation to the client instance.
You must provide the table name and the new provisioned throughput values.
3. Load the response into a local variable, such as $response, for use in your application.
API Version 2012-08-10
87
Immediately after a successful request, the table will be in the UPDATING state until the new values
are set. The new provisioned throughput values are available when the table returns to the ACTIVE
state.
The following PHP code snippet demonstrates the preceding steps.
$tableName = 'ExampleTable';
echo "Updating provisioned throughput settings on $tableName..." . PHP_EOL;
$result = $client->updateTable(array(
'TableName' => $tableName,
'ProvisionedThroughput'
=> array(
'ReadCapacityUnits'
=> 6,
'WriteCapacityUnits' => 7
)
));
// Wait until update completes
$client->waitUntilTableExists(array('TableName' => $tableName));
echo "New provisioned throughput settings:" . PHP_EOL;
Deleting a Table
The following are the steps to delete a table using the AWS SDK for PHP.
1. Create an instance of the DynamoDbClient class.
2. Provide the parameters for the deleteTable operation to the client instance.
You must provide the table name for the table to delete.
3. Load the response into a local variable, such as $response, for use in your application.
Immediately after a successful request, the table will be in the DELETING state until the table and all
of the values in the table are removed from the server.
The following PHP code snippet demonstrates the preceding steps.
$tableName = 'ExampleTable';
echo "Deleting the table..." . PHP_EOL;
$result = $client->deleteTable(array(
'TableName' => $tableName
));
Listing Tables
To list tables in your account using the AWS SDK for PHP, create an instance of the DynamoDbClient
class and execute the list_tables operation. The ListTables operation requires no parameters.
However, you can specify optional parameters. For example, you can set the Limit parameter if you
want to use paging to limit the number of table names per page. You can also set the
ExclusiveStartTableName parameter. After fetching the first page of results, DynamoDB returns a
LastEvalutedTableName value. Use the LastEvalutedTableName value for the
ExclusiveStartTableName parameter to get the next page of results.
The following PHP code snippet demonstrates how to list all of the tables in your account by using the
LastEvalutedTableName value for the ExclusiveStartTableName parameter, using a Limit value
of 2 table names per page.
$tables = array();
// Walk through table names, two at a time
do {
$response = $client->listTables(array(
'Limit' => 2,
'ExclusiveStartTableName' => isset($response) ? $response['LastEvalu
atedTableName'] : null
));
foreach ($response['TableNames'] as $key => $value) {
echo "$value" . PHP_EOL;
}
$tables = array_merge($tables, $response['TableNames']);
}
while ($response['LastEvaluatedTableName']);
// Print total number of tables
echo "Total number of tables: ";
print_r(count($tables));
echo PHP_EOL;
Note
For step-by-step instructions to run the following code example, see Running PHP
Examples (p. 59).
<?php
use Aws\DynamoDb\DynamoDbClient;
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' // replace with your desired region
));
$tableName = 'ExampleTable';
echo "# Creating table $tableName..." . PHP_EOL;
$response = $client->createTable(array(
'TableName' => $tableName,
'AttributeDefinitions' => array(
array(
'AttributeName' => 'Id',
'AttributeType' => 'N'
)
),
'KeySchema' => array(
array(
'AttributeName' => 'Id',
'KeyType' => 'HASH'
)
),
'ProvisionedThroughput' => array(
'ReadCapacityUnits'
=> 5,
'WriteCapacityUnits' => 6
)
));
print_r($response->getPath('TableDescription'));
$client->waitUntilTableExists(array('TableName' => $tableName));
echo "table $tableName has been created." . PHP_EOL;
####################################################################
# Updating the table
echo "# Updating the provisioned throughput of table $tableName." . PHP_EOL;
$response = $client->updateTable(array(
'TableName' => $tableName,
'ProvisionedThroughput'
=> array(
'ReadCapacityUnits'
=> 6,
'WriteCapacityUnits' => 7
)
));
// Wait until update completes
$client->waitUntilTableExists(array('TableName' => $tableName));
Overview
An item consists of one or more attributes. Each attribute consists of a name, a data type, and a value.
When you read or write an item, the only attributes that are required are those that make up the primary
key.
Important
For the primary key, you must provide all of its attributes. For example, with a hash type primary
key, you only need to specify the hash attribute. For a hash-and-range type primary key, you
must specify both the hash attribute and the range attribute. For more information, see Primary
Key (p. 5).
Except for the primary key, there is no predefined schema for the items in a table. For example, to store
product information, you can create a ProductCatalog table and store various product items in it such as
books and bicycles. The following table shows two items, a book and a bicycle, that you can store in the
ProductCatalog table. Note that the example uses JSON-like syntax to show the attribute value.
Id (Primary Key)
101
Other Attributes
{
Title = "Book 101 Title"
ISBN = "111-1111111111"
Authors = "Author 1"
Price = "-2"
Dimensions = "8.5 x 11.0 x 0.5"
PageCount = "500"
InPublication = true
ProductCategory = "Book"
}
201
{
Title = "18-Bicycle 201"
Description = "201 description"
BicycleType = "Road"
Brand = "Brand-Company A"
Price = "100"
Gender = "M"
Color = [ "Red", "Black" ]
ProductCategory = "Bike"
}
An item can have any number of attributes, although there is a limit of 400 KB on the item size. An item
size is the sum of lengths of its attribute names and values (binary and UTF-8 lengths); it helps if you
keep the attribute names short. For more information about attributes and data types, see DynamoDB
Data Model (p. 3).
Reading an Item
To read an item from a DynamoDB table, use the GetItem operation. You must provide the name of the
table, along with the primary key of the item you want.
You need to specify the entire primary key, not just part of it. For example, if a table has a hash and range
type primary key, you must supply a value for the hash attribute and a value for the range attribute.
The following are the default behaviors for GetItem:
GetItem performs an eventually consistent read.
GetItem returns all of the item's attributes.
GetItem does not return any information about how many provisioned capacity units it consumes.
You can override these defaults using GetItem parameters. For more information, see GetItem in the
Amazon DynamoDB API Reference.
Read Consistency
DynamoDB maintains multiple copies of each item to ensure durability. For every successful write request,
DynamoDB ensures that the write is durable on multiple servers. However, it takes time for a write to
propagate to all copies. In DynamoDB, data is eventually consistent. This means that if you write an item
and then immediately try to read it, you might not see the results from the earlier write.
By default, a GetItem operation performs an eventually consistent read. You can optionally request a
strongly consistent read instead; this will consume additional read capacity units, but it will return the
most up-to-date version of the item.
An eventually consistent GetItem request consumes only half the read capacity units as a strongly
consistent request. Therefore, it is best to design applications so that they use eventually consistent reads
whenever possible. Consistency across all copies of the data is usually reached within one second.
Writing an Item
To create, update, and delete items in a DynamoDB table, use the following operations:
PutItem creates a new item. If an item with the same key already exists in the table, it is replaced
with the new item. You must provide the table name and the item that you want to write.
UpdateItem if the item does not already exist, this operation creates a new item; otherwise, it
modifies an existing item's attributes. You must specify the table name and the key of the item you
want to modify. For each of the attributes that you want to update, you must provide new values for
them.
DeleteItem deletes an item. You must specify the table name and the key of the item you want to
delete.
For each of these operations, you need to specify the entire primary key, not just part of it. For example,
if a table has a hash and range type primary key, you must supply a value for the hash attribute and a
value for the range attribute.
If you want to avoid accidentally overwriting or deleting an existing item, you can use a conditional
expression with any of these operations. A conditional expression lets you check whether a condition is
true (such as an item already existing in the table) before the operation can proceed. To write an item
only if it doesn't already exist, use PutItem with a conditional expression that uses the
attribute_not_exists function and the name of the table's HASH key, since any item that exists will
have a HASH key. For more information, see Conditional Write Operations (p. 115).
In some cases, you might want DynamoDB to display certain attribute values before or after you modify
them. For example, with an UpdateItem operation, you could request that attribute values be returned
as they appeared before the update occurs. PutItem, UpdateItem, and DeleteItem have a
ReturnValues parameter, which you can use to return the attribute values before or after they are
modified.
By default, none of these operations return any information about how many provisioned capacity units
they consume. You can use the ReturnConsumedCapacity parameter to obtain this information.
For detailed information about these operations, see PutItem, UpdateItem, and DeleteItem in the Amazon
DynamoDB API Reference.
Batch Operations
If your application needs to read multiple items, you can use the BatchGetItem API. A single
BatchGetItem request can retrieve up to 1 MB of data, which can contain as many as 100 items. In
addition, a single BatchGetItem request can retrieve items from multiple tables.
The BatchWriteItem operation lets you put or delete multiple items. BatchWriteItem can write up
to 16 MB of data, consisting of up to 25 put or delete requests. The maximum size of an individual item
is 400 KB in size. In addition, a singleBatchWriteItem request can put or delete items in multiple tables.
(Note that BatchWriteItem cannot update items. To update items, use the UpdateItem API.)
A batch consists of one or more requests. For each request, DynamoDB invokes the corresponding API
for that request. For example, if a BatchGetItem request contains five items, DynamoDB implicitly
performs five GetItem operations on your behalf. Similarly, if a BatchWriteItem request contains two
put requests and four delete requests, DynamoDB implicitly performs two PutItem and four DeleteItem
requests.
If an individual request in a batch should fail (for example, because you exceed the provisioned throughput
settings on a table), this does not cause the entire batch to fail. Instead, the batch operation returns the
keys and data from the individual failed request, so that you can retry the operation. In general, a batch
operation does not fail unless all of the requests in the batch fail.
For detailed information about batch operations, see BatchGetItem and BatchWriteItem in the Amazon
DynamoDB API Reference.
Atomic Counters
DynamoDB supports atomic counters, where you use the UpdateItem operation to increment or decrement
the value of an existing attribute without interfering with other write requests. (All write requests are applied
in the order in which they were received.) For example, a web application might want to maintain a counter
per visitor to their site. In this case, the application would need to increment this counter regardless of its
current value.
Atomic counter updates are not idempotent. This means that the counter will increment each time you
call UpdateItem. If you suspect that a previous request was unsuccessful, your application could retry
the UpdateItem operation; however, this would risk updating the counter twice. This might be acceptable
for a web site counter, because you can tolerate with slightly over- or under-counting the visitors. However,
in a banking application, it would be safer to use a conditional update rather than an atomic counter.
To update an atomic counter, use an UpdateItem operation with an attribute of type Number in the
UpdateExpression parameter, and SET as the update action to perform.You can increment the counter
using a positive number, or decrement it using a negative number. For more information, see Incrementing
and Decrementing Numeric Attributes (p. 112).
Conditional Writes
In a multi-user environment, multiple clients can access the same item and attempt to modify its attribute
values at the same time. However, each client might not realize that other clients might have modified
the item already. This is shown in the following illustration in which Client 1 and Client 2 have retrieved
a copy of an item (Id=1). Client 1 changes the price from $10 to $8. Later, Client 2 changes the same
item price to $12, and the previous change made by Client 1 is lost.
To help clients coordinate writes to data items, DynamoDB supports conditional writes for PutItem,
DeleteItem, and UpdateItem operations. With a conditional write, an operation succeeds only if the
item attributes meet one or more expected conditions; otherwise it returns an error. For example, the
following illustration shows both Client 1 and Client 2 retrieving a copy of an item (Id=1). Client 1 first
attempts to update the item price to $8, with the expectation that the existing item price on the server will
be $10. This operation succeeds because the expectation is met. Client 2 then attempts to update the
price to $12, with the expectation that the existing item price on the server will be $10. This expectation
cannot be met, because the price is now $8; therefore, Client 2's request fails.
Note that conditional writes are idempotent. This means that you can send the same conditional write
request multiple times, but it will have no further effect on the item after the first time DynamoDB performs
the specified update. For example, suppose you issue a request to update the price of a book item by
10%, with the expectation that the price is currently $20. However, before you get a response, a network
error occurs and you don't know whether your request was successful or not. Because a conditional
update is an idempotent operation, you can send the same request again. and DynamoDB will update
the price only if the current price is still $20.
To request a conditional PutItem, DeleteItem, or UpdateItem, you specify the condition(s) in the
ConditionExpression parameter. ConditionExpression is a string containing attribute names,
conditional operators and built-in functions. The entire expression must evaluate to true; otherwise the
operation will fail.
Tip
For more information, see Conditional Write Operations (p. 115).
If you specify the ReturnConsumedCapacity parameter, DynamoDB will return the number of write
capacity units that were consumed during the conditional write. (Note that write operations only consume
write capacity units; they never consume read capacity units.) Setting ReturnConsumedCapacity to
TOTAL returns the write capacity consumed for the table and all of its global secondary indexes; INDEXES
returns only the write capacity consumed by the global secondary indexes; NONE means that you do not
want any consumed capacity statistics returned.
If a ConditionExpression fails during a conditional write, DynamoDB will still consume one write
capacity unit from the table. A failed conditional write will return a ConditionalCheckFailedException
instead of the expected response from the write operation. For this reason, you will not receive any
information about the write capacity unit that was consumed. However, you can view the
ConsumedWriteCapacityUnits metric for the table in Amazon CloudWatch to determine the provisioned
write capacity that was consumed from the table. For more information, see DynamoDB Metrics (p. 579)
in Monitoring DynamoDB with CloudWatch (p. 577).
Note
Unlike a global secondary index, a local secondary index shares its provisioned throughput
capacity with its table. Read and write activity on a local secondary index consumes provisioned
throughput capacity from the table.
Note
For backward compatibility, DynamoDB also supports conditional parameters that do not use
expressions. For more information, see Legacy Conditional Parameters (p. 728).
New applications should use expressions rather than the legacy parameters.
Topics
Case Study: A ProductCatalog Item (p. 98)
Accessing Item Attributes with Projection Expressions (p. 99)
Using Placeholders for Attribute Names and Values (p. 101)
Performing Conditional Writes with Condition Expressions (p. 103)
Modifying Items and Attributes with Update Expressions (p. 110)
ProductReviews: {
FiveStar: [
"Excellent! Can't recommend it highly enough!
"Do yourself a favor and buy this."
],
OneStar: [
"Terrible product! Do not buy this."
]
}
Buy it!",
Note
The examples in the following sections are based on the ProductCatalog item from Case Study:
A ProductCatalog Item (p. 98).
Topics
Projection Expressions (p. 99)
Document Paths (p. 100)
Projection Expressions
A projection expression is a string that identifies the attributes you want. To retrieve a single attribute,
specify its name. For multiple attributes, the names must be comma-separated.
Following are some examples of projection expressions:
A single top-level attribute.
Title
Three top-level attributes. Note that DynamoDB will retrieve the entire Color set.
Title, Price, Color
Four top-level attributes. Note that DynamoDB will return the entire contents of RelatedItems and
ProductReviews.
Title, Description, RelatedItems, ProductReviews
You can use any attribute name in a projection expression, provided that the first character is a-z or A-Z
and the second character (if present) is a-z, A-Z, or 0-9. If an attribute name does not meet this
requirement, you will need to define an expression attribute name as a placeholder. For more information,
see Expression Attribute Names (p. 101).
Document Paths
In addition to top-level attributes, expressions can access individual elements in any document type
attribute. To do this, you must provide the element's location, or document path, within the item. The
document path tells DynamoDB where to find the attribute, even if it is deeply nested within multiple lists
and maps.
For a top-level attribute, the document path is simply the attribute name.
For a nested attribute, you construct the document path using dereference operators.
Note
The maximum depth for a document path is 32. Therefore, the number of dereferences in any
path cannot exceed this limit.
You can use any attribute name in a document path, provided that the first character is a-z or A-Z and
the second character (if present) is a-z, A-Z, or 0-9. If an attribute name does not meet this requirement,
you will need to define an expression attribute name as a placeholder. For more information, see Expression
Attribute Names (p. 101).
Tip
If an attribute name begins with a number or contains a space, a special character, or a reserved
word, then you must use an expression attribute name to replace that attribute's name in the
expression.
{
Id: 1234,
My.Scalar.Message: "Hello",
MyMap: {
MyKey: "My key value",
MyOtherKey: 10
}
}
Suppose that you wanted to access My.Scalar.Message using the following projection expression:
My.Scalar.Message
DynamoDB would return an empty result, rather than the expected Hello string. This is because
DynamoDB interprets a dot in an expression as a document path separator. In this case, you would need
to define an expression attribute name (such as #msm) as a substitute for My.Scalar.Message. You
could then use the following projection expression:
#msm
Tip
A dot in an expression represents a document path separator.
If an attribute name contains dot characters, define an expression attribute name for it. You can
then use that name in an expression.
Now suppose that you wanted to access the embedded attribute MyMap.MyKey, using the following
projection expression:
MyMap.MyKey
Tip
A dot in an expression attribute name represents a valid character within an attribute's name.
API Version 2012-08-10
102
To access a nested attribute, define an expression attribute name for each element in the
document path. You can then use these names in an expression, with each name separated by
a dot.
Expression attribute names are also helpful when you need to refer to the same attribute name repeatedly.
For example, consider the following expression for retrieving some of the reviews from a ProductCatalog
item:
ProductReviews.FiveStar, ProductReviews.ThreeStar, ProductReviews.OneStar
To make this more concise, you can replace ProductReviews with an expression attribute name such
as #pr. The revised expression would now look like this:
#pr.FiveStar, #pr.ThreeStar, #pr.OneStar
If you define an expression attribute name, you must use it consistently throughout the entire expression.
Also, you cannot omit the # symbol.
Note
The examples in this sections are based on the ProductCatalog item from Case Study: A
ProductCatalog Item (p. 98).
Topics
Condition Expressions
A condition expression represents restrictions to put in place when you read and write items in a table.
A condition expression is a free-form string that can contain attribute names, document paths, logical
operators, and functions. For a complete list of elements allowed in a condition expression, see Condition
Expression Reference (p. 104).
Following are some examples of condition expressions. Note that some of these expressions use
placeholders for attribute names and values. For more information, see Using Placeholders for Attribute
Names and Values (p. 101).
To prevent PutItem from overwriting an existing item, use a conditional expression that specifies that
the HASH attribute of the item does not exist. Since every item in the table must have a HASH attribute,
this will prevent any existing item from being overwritten. For example, if the HASH attribute is named
'town', you could use:
attribute_not_exists(town)
When this conditional expression is used with the PutItem, DynamoDB first looks for an item whose
primary key matches that of the item to be written. Only if the search returns nothing is there no HASH
attribute present in the result. Otherwise, the attribute_not_exists function above fails and the
write will be prevented.
All of the items that have a RearView picture.
attribute_exists(Pictures.RearView)
Only the items that don't have one-star reviews. The expression attribute name, #pr, is a substitute
for ProductReviews.
attribute_not_exists (#pr.OneStar)
For more information about the # character, see Expression Attribute Names (p. 101).
Simple scalar comparisons. :p represents a number and :bt represents a string.
Price <= :p
BicycleType = :bt
Two conditions that must both be true. #P and #PC are placeholders for Price and ProductCategory
attribute names. :lo and :hi represent values of type Number, and :cat1 and :cat2 represent
values of type String.
(#P between :lo and :hi) and (#PC in (:cat1, :cat2))
You can use any attribute name in a condition expression, provided that the first character is a-z or A-Z
and the second character (if present) is a-z, A-Z, or 0-9. If an attribute name does not meet this
requirement, you will need to define an expression attribute name as a placeholder. For more information,
see Expression Attribute Names (p. 101).
Note
The syntax for ConditionExpression is identical to that of the FilterExpression parameter.
FilterExpression is used for querying and scanning data; for more information, see Filtering
the Results from a Query or a Scan (p. 195).
Topics
Syntax for Condition Expressions (p. 105)
Making Comparisons (p. 105)
Functions (p. 106)
Logical Evaluations (p. 109)
Parentheses (p. 109)
Precedence in Conditions (p. 110)
condition-expression ::=
operand comparator operand
| operand BETWEEN operand AND operand
| operand IN ( operand (',' operand (, ...) ))
| function
| condition AND condition
| condition OR condition
| NOT condition
| ( condition )
comparator ::=
=
| <>
| <
| <=
| >
| >=
function ::=
attribute_exists (path)
| attribute_not_exists (path)
| attribute_type (path, type)
| begins_with (path, substr)
| contains (path, operand)
| size (path)
Making Comparisons
Use these comparators to compare an operand against a range of values, or an enumerated list of values:
a = b true if a is equal to b
a <> b true if a is not equal to b
a < b true if a is less than b
API Version 2012-08-10
105
Functions
Use the following functions to determine whether an attribute exists in an item, or to evaluate the value
of an attribute. These function names are case-sensitive. For a nested attribute, you must provide its full
path; for more information, see Document Paths (p. 100).
Function
Description
attribute_exists
(path)
attribute_not_exists
(path)
True if the attribute specified by path does not exist in the item.
Example: Check whether an item has a Manufacturer attribute
attribute_not_exists (Manufacturer)
Function
Description
attribute_type (path,
type)
True if the attribute at the specified path is of a particular data type. The
type parameter must be one of the following:
S String
SS String Set
N Number
NS Number Set
B Binary
BS Binary Set
BOOL Boolean
NULL Null
L List
M Map
You must use an expression attribute value for the type parameter.
Example: Check whether the QuantityOnHand attribute is of type List.
In this example, :v_sub is a placeholder for the string L.
attribute_type (ProductReviews.FiveStar, :v_sub)
You must use an expression attribute value for the second parameter.
begins_with (path,
substr)
Function
Description
Function
Description
size (path)
Logical Evaluations
Use the AND, OR and NOT keywords to perform logical evaluations. In the list following, a and b represent
conditions to be evaluated.
a AND b true if a and b are both true.
a OR b true if either a or b (or both) are true.
NOT a true if a is false; false if a is true.
Parentheses
Use parentheses to change the precedence of a logical evaluation. For example, suppose that conditions
a and b are true, and that condition c is false. The following expression evaluates to true:
API Version 2012-08-10
109
a OR b AND c
However, if you enclose a condition in parentheses, it is evaluated first. For example, the following
evaluates to false:
(a OR b) AND c
Note
You can nest parentheses in an expression. The innermost ones are evaluated first.
Precedence in Conditions
DynamoDB evaluates conditions from left to right using the following precedence rules:
= <> < <= > >=
IN
BETWEEN
attribute_exists attribute_not_exists begins_with contains
Parentheses
NOT
AND
OR
Note
The examples in the following sections are based on the ProductCatalog item from Case Study:
A ProductCatalog Item (p. 98).
Topics
Update Expressions (p. 111)
Conditional Write Operations (p. 115)
Return Values (p. 116)
Update Expressions
An update expression specifies the attributes you want to modify, along with new values for those attributes.
An update expression also specifies how to modify the attributesfor example, setting a scalar value, or
deleting elements in a list or a map. It is a free-form string that can contain attribute names, document
paths, operators and functions. It also contains keywords that indicate how to modify attributes.
The PutItem, UpdateItem and DeleteItem operations require a primary key value, and will only
modify the item with that key. If you want to perform a conditional update, you must provide an update
expression and a condition expression. The condition expression specifies the condition(s) that must be
met in order for the update to succeed. The following is a syntax summary for update expressions:
update-expression ::=
SET set-action , ...
| REMOVE remove-action , ...
| ADD add-action , ...
| DELETE delete-action , ...
An update expression consists of sections. Each section begins with a SET, REMOVE, ADD or DELETE
keyword. You can include any of these sections in an update expression in any order. However, each
section keyword can appear only once. You can modify multiple attributes at the same time. Following
are some examples of update expressions:
SET list[0] = :val1
REMOVE #m.nestedField1, #m.nestedField2
ADD aNumber :val2, anotherNumber :val3
DELETE aSet :val4
The following example shows a single update expression with multiple sections:
SET list[0] = :val1 REMOVE #m.nestedField1, #m.nestedField2 ADD aNumber :val2,
anotherNumber :val3 DELETE aSet :val4
You can use any attribute name in an update expression, provided that the first character is a-z or A-Z
and the second character (if present) is a-z, A-Z, or 0-9. If an attribute name does not meet this
requirement, you will need to define an expression attribute name as a placeholder. For more information,
see Expression Attribute Names (p. 101).
To specify a literal value in an update expression, you use expression attribute values. For more
information, see Expression Attribute Values (p. 103).
Topics
SET (p. 111)
REMOVE (p. 113)
ADD (p. 114)
DELETE (p. 115)
SET
Use the SET action in an update expression to add one or more attributes and values to an item. If any
of these attribute already exist, they are replaced by the new values. However, note that you can also
use SET to add or subtract from an attribute that is of type Number. To SET multiple attributes, separate
them by commas.
In the following syntax summary:
The path element is the document path to the item. For more information, see Document Paths (p. 100).
An operand element can be either a document path to an item, or a function. For more information,
see Functions for Updating Attributes (p. 113).
set-action ::=
path = value
value ::=
operand
| operand '+' operand
| operand '-' operand
operand ::=
path | function
Following are some examples of update expressions using the SET action.
The following example updates the Brand and Price attributes. The expression attribute value :b is a
string and :p is a number.
SET Brand = :b, Price = :p
The following example updates an attribute in the RelatedItems list. The expression attribute value :ri
is a number.
SET RelatedItems[0] = :ri
The following example updates some nested map attributes. The expression attribute name #pr is
ProductReviews; the attribute values :r1 and :r2 are strings.
SET #pr.FiveStar[0] = :r1, #pr.FiveStar[1] = :r2
If you add multiple elements in a single SET operation, the elements are sorted in order by element
number. For example, consider the following list:
MyNumbers: { ["Zero","One","Two","Three","Four"] }
The list contains elements [0], [1], [2], [3], [4]. Now, let's use the SET action to add two new
elements:
set MyNumbers[8]="Eight", MyNumbers[10] = "Ten"
The list now contains elements [0], [1], [2], [3], [4], [5], [6], with the following data at each
element:
MyNumbers: { ["Zero","One","Two","Three","Four","Eight","Ten"] }
Note
The new elements are added to the end of the list and will be assigned the next available element
numbers.
Important
These function names are case-sensitive.
Following are some examples of using the SET action with these functions.
If the attribute already exists, the following example does nothing; otherwise it sets the attribute to a
default value.
SET Price = if_not_exists(Price, 100)
The following example adds a new element to the FiveStar review list. The expression attribute name
#pr is ProductReviews; the attribute value :r is a one-element list. If the list previously had two
elements, [0] and [1], then the new element will be [2].
SET #pr.FiveStar = list_append(#pr.FiveStar, :r)
The following example adds another element to the FiveStar review list, but this time the element will
be appended to the start of the list at [0]. All of the other elements in the list will be shifted by one.
SET #pr.FiveStar = list_append(:r, #pr.FiveStar)
REMOVE
Use the REMOVE action in an update expression to remove one or more attributes from an item. To perform
multiple REMOVE operations, separate them by commas.
The following is a syntax summary for REMOVE in an update expression.The only operand is the document
path for the attribute you want to remove:
remove-action ::=
path
Following is an example of an update expression using the REMOVE action. Several attributes are removed
from the item:
REMOVE Title, RelatedItems[2], Pictures.RearView
Note
If you use REMOVE to delete a nonexistent item past the last element of the list, nothing happens:
There is no data to be deleted. For example, the following expression has no effect on the
MyNumbers list:
REMOVE MyNumbers[11]
ADD
Important
The ADD action only supports Number and set data types. In general, we recommend using SET
rather than ADD.
Use the ADD action in an update expression to do either of the following:
If the attribute does not already exist, add the new attribute and its value(s) to the item.
If the attribute already exists, then the behavior of ADD depends on the attribute's data type:
If the attribute is a number, and the value you are adding is also a number, then the value is
mathematically added to the existing attribute. (If the value is a negative number, then it is subtracted
from the existing attribute.)
If the attribute is a set, and the value you are adding is also a set, then the value is appended to the
existing set.
To perform multiple ADD operations, separate them by commas.
In the following syntax summary:
The path element is the document path to an attribute. The attribute must be either a Number or a set
data type.
The value element is a number that you want to add to the attribute (for Number data types), or a set
to append to the attribute (for set types).
add-action ::=
path value
Following are some examples of update expressions using the add action.
The following example increments a number. The expression attribute value :n is a number, and this
value will be added to Price.
ADD Price :n
The following example adds one or more values to the Color set. The expression attribute value :c is
a string set.
ADD Color :c
DELETE
Important
The DELETE action only supports set data types.
Use the DELETE action in an update expression to delete an element from a set. To perform multiple
DELETE operations, separate them by commas.
In the following syntax summary:
The path element is the document path to an attribute. The attribute must be a set data type.
The value element is the element(s) in the set that you want to delete.
delete-action ::=
path value
The following example deletes an element from the Color set using the DELETE action. The expression
attribute value :c is a string set.
DELETE Color :c
To perform a conditional update, use an UpdateItem operation with an update expression and a condition
expression.The condition expression must evaluate to true in order for the operation to succeed; otherwise,
the operation fails.
Suppose that you want to increase the price of an item, but only if the result does not exceed a maximum
price. You can use the following expressions to do this:
Condition expression: Price <= (:maxprice - :amt)
Update expression: SET Price = Price + :amt
Now suppose you want to set a front view picture for an item, but only if that item doesn't already have
such a pictureyou want to avoid overwriting any existing element.You can use the following expressions
to do this:
Update expression: SET Pictures.FrontView = :myURL
(Assume that :myURL is the location of a picture of the item, such as http://example.com/picture.jpg.)
Condition expression: attribute_not_exists(Pictures.FrontView)
Return Values
When you perform a DeleteItem or UpdateItem operation, DynamoDB can optionally return some or
all of the item in the response. To do this, you set the ReturnValues parameter. The default value for
ReturnValues is NONE, so no data will be returned. You can change this behavior as described below.
Deleting an Item
In a DeleteItem operation, you can set ReturnValues to ALL_OLD. Doing this will cause DynamoDB
to return the entire item, as it appeared before the delete operation occurred.
Updating an Item
In an UpdateItem operation, you can set ReturnValues to one of the following:
ALL_OLD The entire item is returned, as it appeared before the update occurred.
ALL_NEW The entire item is returned, as it appears after the update.
UPDATED_OLD Only the value(s) that you updated are returned, as they appear before the update
occurred.
UPDATED_NEW Only the value(s) that you updated are returned, as they appear after the update.
write capacity units. If the items that you are handling exceed the maximum item size, as described in
Limits in DynamoDB (p. 664), you need to consider how you will deal with the situation. This section offers
best practices for addressing these considerations.
Now suppose that price and availability information were stored in a ProductAvailability table instead. In
this case, updating the information would cost only one write capacity unit.
Note
For an explanation of capacity units, see Provisioned Throughput in Amazon DynamoDB (p. 11).
If your application also needed to store product data that is displayed less frequently, you could store this
information in a separate table called ExtendedProductCatalog. Such data might include product
dimensions, a track listing for music albums, or other attributes that are not accessed as often as the
basic product data. This way, the application would only consume throughput when displaying basic
product information to the users, and would only consume additional throughput if the user requests the
extended product details.
The following are example instances of the tables in the preceding discussion. Note that all the tables
have an Id attribute as the primary key.
ProductCatalog
Id
Title
Description
21
"Famous Book"
302
"Red Bicycle"
58
"Music Album"
Id
Price
QuantityOnHand
21
"$5.00 USD"
3750
302
"$125.00 USD"
58
"$5.00 USD"
Id
AverageCustomerRating
TrackListing
21
302
3.5
58
ProductAvailability
ExtendedProductCatalog
{"Track1#3:59", "Track2#2:34",
"Track3#5:21", ...}
Here are several advantages and considerations for splitting the attributes of an item into multiple items
in different tables:
The throughput cost of reading or writing these attributes is reduced. The cost of updating a single
attribute of an item is based on the full size of the item. If the items are smaller, you will incur less
throughput when you access each one.
If you keep your frequently accessed items small, your I/O workload will be distributed more evenly.
Retrieving a large item can consume a great deal of read capacity all at once, from the same partition
API Version 2012-08-10
118
of your table; this can make your workload uneven, which can cause throttling. For more information,
see Avoid Sudden Bursts of Read Activity (p. 200)
For single-item read operations, such as GetItem, throughput calculations are rounded up to the next
4 KB boundary. If your items are smaller than 4 KB and you retrieve the items by primary key only,
storing item attributes as separate items may not reduce throughput. Even so, the throughput cost of
range operations such as Query and Scan are calculated differently: the sizes of all returned items
are totaled, and that final total is rounded up to the next 4 KB boundary. For these operations, you
might still reduce your throughput cost by moving the large attributes into separate items. For more
information, see Capacity Units Calculations for Various Operations (p. 64).
schema table, and use batch API calls to read and write the chunks. This approach will help you to spread
your workload evenly across table partitions.
For example, consider the Forum, Thread and Reply tables described in the Creating Tables and Loading
Sample Data (p. 14) section. Items in the Reply table contain forum messages that were written by forum
users. Due to the 400 KB item size limit in DynamoDB, the length of each reply is also limited. For large
replies, instead of storing one item in the Reply table, break the reply message into chunks, and then
write each chunk into its own separate item in a new ReplyChunks hash schema table.
The primary key of each chunk would be a concatenation of the primary key of its "parent" reply item, a
version number, and a sequence number. The sequence number determines the order of the chunks.
The version number ensures that if a large reply is updated later, it will be updated atomically. In addition,
chunks that were created before the update will not be mixed with chunks that were created after the
update.
You would also need to update the "parent" reply item with the number of chunks, so that when you need
to retrieve all the chunks for a reply, you will know how many chunks to look for.
As an illustration, here is how these items might appear in the Reply and ReplyChunks tables:
Reply
Id
ReplyDateTime
"DynamoDB#Thread1"
"2012-0315T20:42:54.023Z"
"DynamoDB#Thread2"
"2012-0321T20:41:23.192Z"
Message
ChunkCount
-knuhC
- reV
no i s
3
"short message"
ReplyChunks
Id
Message
"DynamoDB#Thread1#2012-0315T20:42:54.023Z#1#1"
"DynamoDB#Thread1#2012-0315T20:42:54.023Z#1#3"
"DynamoDB#Thread1#2012-0315T20:42:54.023Z#1#2"
A workable, but less optimal, solution would be to store each chunk in a table with a hash and range key,
with the hash portion being the primary key of the "parent" item. With this design choice, an application
that retrieves all of the chunks of the same "parent" item would generate a nonuniform workload, with
uneven I/O distribution across partitions.
You can use the AWS SDK for Java Document API to perform typical create, read, update, and delete
(CRUD) operations on items in a table.
Note that the AWS SDK for Java also provides a high-level object persistence model, enabling you to
map your client-side classes to DynamoDB tables. This approach can reduce the amount of code you
have to write. For more information, see Java: Object Persistence Model.
Putting an Item
The putItem method stores an item in a table. If the item exists, it replaces the entire item. Instead of
replacing the entire item, if you want to update only specific attributes, you can use the updateItem
method. For more information, see Updating an Item (p. 128).
Follow these steps:
1. Create an instance of the DynamoDB class.
2. Create an instance of the Table class to represent the table you want to work with.
3. Create an instance of the Item class to represent the new item. You must specify the new item's
primary key and its attributes.
4. Call the putItem method of the Table object, using the Item that you created in the preceding step.
The following Java code snippet demonstrates the preceding tasks. The snippet writes a new bicycle
item to the ProductCatalog table. (This is the same item that is described in Case Study: A
ProductCatalog Item (p. 98).)
Buy it!");
In the preceding example, the item has attributes that are scalars (String, Number, Boolean, Null), sets
(String Set), and document types (List, Map).
A ConditionExpression that defines the conditions for the request. The snippet defines the condition
that the existing item that has the same primary key is replaced only if it has an ISBN attribute that
equals a specific value.
A map for ExpressionAttributeValues that will be used in the condition. In this case, there is only
one substitution required: The placeholder :val in the condition expression will be replaced at runtime
with the actual ISBN value to be checked.
The following example adds a new book item using these optional parameters.
Item item = new Item()
.withPrimaryKey("Id", 104)
.withString("Title", "Book 104 Title")
.withString("ISBN", "444-4444444444")
.withNumber("Price", 20)
.withStringSet("Authors",
new HashSet<String>(Arrays.asList("Author1", "Author2")));
Map<String, Object> expressionAttributeValues = new HashMap<String, Object>();
expressionAttributeValues.put(":val", "444-4444444444");
PutItemOutcome outcome = table.putItem(
item,
"ISBN = :val", // ConditionExpression parameter
null,
// ExpressionAttributeNames parameter - we're not using it
for this example
expressionAttributeValues);
You can use the withJSON method to store this in the ProductCatalog table, in a Map attribute named
VendorInfo. The following Java code snippet demonstrates how to do this.
Getting an Item
To retrieve a single item, use the getItem method of a Table object. Follow these steps:
1. Create an instance of the DynamoDB class.
2. Create an instance of the Table class to represent the table you want to work with.
3. Call the getItem method of the Table instance. You must specify the primary key of the item that
you want to retrieve.
The following Java code snippet demonstrates the preceding steps. The code snippet gets the item that
has the specified hash primary key.
You can use a ProjectionExpression to retrieve only specific attributes or elements, rather than an
entire item. A ProjectionExpression can specify top-level or nested attributes, using document paths.
For more information, see Projection Expressions (p. 99) and Document Paths (p. 100).
The parameters of the getItem method do not let you specify read consistency; however, you can create
a GetItemSpec, which provides full access to all of the low-level GetItem API inputs. The code example
below creates a GetItemSpec, and uses that spec as input to the getItem method.
Tip
To print an Item in a human-readable format, use the toJSONPretty method. The output from
the example above looks like this:
{
"RelatedItems" : [ 341 ],
"Reviews" : {
"FiveStar" : [ "Excellent! Can't recommend it highly enough!
it!", "Do yourself a favor and buy this" ]
},
"Id" : 206,
"Title" : "20-Bicycle 206"
}
Buy
Tip
You can use the toJSON method to convert any item (or its attributes) to a JSON-formatted
string. The following code snippet retrieves several top-level and nested attributes, and prints
the results as JSON:
For a working example, see Example: Batch Write Operation Using the AWS SDK for Java Document
API (p. 136).
"Amazon S3",
"Amazon DynamoDB");
TableKeysAndAttributes threadTableKeysAndAttributes = new TableKeysAndAttrib
utes(threadTableName);
threadTableKeysAndAttributes.addHashAndRangePrimaryKeys("ForumName", "Subject",
"Amazon DynamoDB","DynamoDB Thread 1",
"Amazon DynamoDB","DynamoDB Thread 2",
"Amazon S3","S3 Thread 1");
BatchGetItemOutcome outcome = dynamoDB.batchGetItem(
forumTableKeysAndAttributes, threadTableKeysAndAttributes);
for (String tableName : outcome.getTableItems().keySet()) {
System.out.println("Items in table " + tableName);
List<Item> items = outcome.getTableItems().get(tableName);
for (Item item : items) {
System.out.println(item);
}
}
Updating an Item
The updateItem method of a Table object can update existing attribute values, add new attributes, or
delete attributes from an existing item.
The updateItem method behaves as follows:
If an item does not exist (no item in the table with the specified primary key), updateItem adds a new
item to the table
If an item exists, updateItem performs the update as specified by the UpdateExpression parameter:
Note
It is also possible to "update" an item using putItem. For example, if you call putItem to add
an item to the table, but there is already an item with the specified primary key, putItem will
replace the entire item. If there are attributes in the existing item that are not specified in the
input, putItem will remove those attributes from the item.
In general, we recommend that you use updateItem whenever you want to modify any item
attributes. The updateItem method will only modify the item attributes that you specify in the
input, and the other attributes in the item will remain unchanged.
Follow these steps:
1. Create an instance of the Table class to represent the table you want to work with.
2. Call the updateTable method of the Table instance. You must specify the primary key of the item
that you want to retrieve, along with an UpdateExpression that describes the attributes to modify
and how to modify them.
The following Java code snippet demonstrates the preceding tasks. The snippet updates a book item in
the ProductCatalog table. It adds a new author to the Authors multi-valued attribute and deletes the
existing ISBN attribute. It also reduces the price by one.
An ExpressionAttributeValues map is used in the UpdateExpression. The placeholders :val1
and :val2 will be replaced at runtime with the actual values for Authors and Price.
Atomic Counter
You can use updateItem to implement an atomic counter, where you increment or decrement the value
of an existing attribute without interfering with other write requests. To increment an atomic counter, use
an UpdateExpression with a set action to add a numeric value to an existing attribute of type Number.
The following code snippet demonstrates this, incrementing the Quantity attribute by one. It also
demonstrates the use of the ExpressionAttributeNames parameter in an UpdateExpression.
Deleting an Item
The deleteItem method deletes an item from a table. You must provide the primary key of the item you
want to delete.
Follow these steps:
1. Create an instance of the DynamoDB client.
2. Call the deleteItem method by providing the key of the item you want to delete.
The following Java code snippet demonstrates these tasks.
Note
This section explains the AWS SDK for Java Document API.The AWS SDK for Java also provides
a high-level object persistence model, enabling you to map your client-side classes to DynamoDB
tables. This approach can reduce the amount of code you have to write. For more information,
see Java: Object Persistence Model.
For a code example that demonstrates CRUD operations using the object persistence model,
see Example: CRUD Operations (p. 431).
Note
This code example assumes that you have already loaded data into DynamoDB for your account
by following the instructions in the Creating Tables and Loading Sample Data (p. 14) section.
Alternatively, you can load the data programmatically using the instructions in the Creating
Example Tables and Uploading Data Using the AWS SDK for Java (p. 684) topic.
For step-by-step instructions to run the following example, see Running Java Examples for
DynamoDB (p. 55).
// Copyright 2012-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
// Licensed under the Apache License, Version 2.0.
package com.amazonaws.codesamples.document;
import
import
import
import
import
java.io.IOException;
java.util.Arrays;
java.util.HashMap;
java.util.HashSet;
java.util.Map;
import
import
import
import
import
import
import
import
import
import
import
import
com.amazonaws.auth.profile.ProfileCredentialsProvider;
com.amazonaws.services.dynamodbv2.AmazonDynamoDBClient;
com.amazonaws.services.dynamodbv2.document.DeleteItemOutcome;
com.amazonaws.services.dynamodbv2.document.DynamoDB;
com.amazonaws.services.dynamodbv2.document.Item;
com.amazonaws.services.dynamodbv2.document.Table;
com.amazonaws.services.dynamodbv2.document.UpdateItemOutcome;
com.amazonaws.services.dynamodbv2.document.spec.DeleteItemSpec;
com.amazonaws.services.dynamodbv2.document.spec.UpdateItemSpec;
com.amazonaws.services.dynamodbv2.document.utils.NameMap;
com.amazonaws.services.dynamodbv2.document.utils.ValueMap;
com.amazonaws.services.dynamodbv2.model.ReturnValue;
null);
System.out.println("Printing item after retrieving it....");
System.out.println(item.toJSONPretty());
} catch (Exception e) {
System.err.println("GetItem failed.");
System.err.println(e.getMessage());
}
}
private static void updateAddNewAttribute() {
Table table = dynamoDB.getTable(tableName);
try {
Map<String, String> expressionAttributeNames = new HashMap<String,
String>();
expressionAttributeNames.put("#na", "NewAttribute");
UpdateItemSpec updateItemSpec = new UpdateItemSpec()
.withPrimaryKey("Id", 121)
.withUpdateExpression("set #na = :val1")
.withNameMap(new NameMap()
.with("#na", "NewAttribute"))
.withValueMap(new ValueMap()
.withString(":val1", "Some value"))
.withReturnValues(ReturnValue.ALL_NEW);
UpdateItemOutcome outcome =
table.updateItem(updateItemSpec);
catch (Exception e) {
System.err.println("Failed to add new attribute in " + tableName);
System.err.println(e.getMessage());
}
}
private static void updateMultipleAttributes() {
Table table = dynamoDB.getTable(tableName);
try {
UpdateItemSpec updateItemSpec = new UpdateItemSpec()
.withPrimaryKey("Id", 120)
.withUpdateExpression("add #a :val1 set #na=:val2")
.withNameMap(new NameMap()
.with("#a", "Authors")
.with("#na", "NewAttribute"))
.withValueMap(new ValueMap()
.withStringSet(":val1", "Author YY", "Author ZZ")
.withString(":val2", "someValue"))
.withReturnValues(ReturnValue.ALL_NEW);
UpdateItemOutcome outcome = table.updateItem(updateItemSpec);
// Check the response.
System.out
.println("Printing item after multiple attribute update...");
System.out.println(outcome.getItem().toJSONPretty());
} catch (Exception e) {
System.err.println("Failed to update multiple attributes in "
+ tableName);
System.err.println(e.getMessage());
}
}
private static void updateExistingAttributeConditionally() {
Table table = dynamoDB.getTable(tableName);
try {
// Specify the desired price (25.00) and also the condition (price
=
// 20.00)
UpdateItemSpec updateItemSpec = new UpdateItemSpec()
.withPrimaryKey("Id", 120)
.withReturnValues(ReturnValue.ALL_NEW)
.withUpdateExpression("set #p = :val1")
.withConditionExpression("#p = :val2")
.withNameMap(new NameMap()
.with("#p", "Price"))
.withValueMap(new ValueMap()
.withNumber(":val1", 25)
.withNumber(":val2", 20));
UpdateItemOutcome outcome = table.updateItem(updateItemSpec);
// Check the response.
System.out
.println("Printing item after conditional update to new attrib
ute...");
System.out.println(outcome.getItem().toJSONPretty());
} catch (Exception e) {
System.err.println("Error updating item in " + tableName);
System.err.println(e.getMessage());
}
}
private static void deleteItem() {
Table table = dynamoDB.getTable(tableName);
try {
DeleteItemSpec deleteItemSpec = new DeleteItemSpec()
.withPrimaryKey("Id", 120)
.withConditionExpression("#ip = :val")
.withNameMap(new NameMap()
.with("#ip", "InPublication"))
.withValueMap(new ValueMap()
.withBoolean(":val", false))
.withReturnValues(ReturnValue.ALL_OLD);
DeleteItemOutcome outcome = table.deleteItem(deleteItemSpec);
// Check the response.
System.out.println("Printing item that was deleted...");
System.out.println(outcome.getItem().toJSONPretty());
} catch (Exception e) {
System.err.println("Error deleting item in " + tableName);
System.err.println(e.getMessage());
}
}
}
This section provides examples of batch write and batch get operations using the AWS SDK for Java
Document API.
Note
This section explains the AWS SDK for Java Document API.The AWS SDK for Java also provides
a high-level object persistence model, enabling you to map your client-side classes to DynamoDB
tables. This approach can reduce the amount of code you have to write. For more information,
see Java: Object Persistence Model.
For a code example that demonstrates batch write operations using the object persistence model,
see Example: Batch Write Operations (p. 433).
java.io.IOException;
java.util.Arrays;
java.util.HashSet;
java.util.List;
java.util.Map;
import
import
import
import
import
import
import
com.amazonaws.auth.profile.ProfileCredentialsProvider;
com.amazonaws.services.dynamodbv2.AmazonDynamoDBClient;
com.amazonaws.services.dynamodbv2.document.BatchWriteItemOutcome;
com.amazonaws.services.dynamodbv2.document.DynamoDB;
com.amazonaws.services.dynamodbv2.document.Item;
com.amazonaws.services.dynamodbv2.document.TableWriteItems;
com.amazonaws.services.dynamodbv2.model.WriteRequest;
new ProfileCredentialsProvider()));
static String forumTableName = "Forum";
static String threadTableName = "Thread";
public static void main(String[] args) throws IOException {
writeMultipleItemsBatchWrite();
}
private static void writeMultipleItemsBatchWrite() {
try {
// Add a new item to Forum
TableWriteItems forumTableWriteItems = new TableWriteItems(forumT
ableName) //Forum
.withItemsToPut(new Item()
.withPrimaryKey("Name", "Amazon RDS")
.withNumber("Threads", 0));
// Add a new item, and delete an existing item, from Thread
TableWriteItems threadTableWriteItems = new Table
WriteItems(threadTableName)
.withItemsToPut(new Item()
.withPrimaryKey("ForumName","Amazon RDS","Subject","Amazon RDS
Thread 1")
.withString("Message", "ElasticCache Thread 1 message")
.withStringSet("Tags", new HashSet<String>(
Arrays.asList("cache", "in-memory"))))
.withHashAndRangeKeysToDelete("ForumName","Subject", "Amazon S3",
"S3 Thread 100");
System.out.println("Making the request.");
BatchWriteItemOutcome outcome = dynamoDB.batchWriteItem(forumTable
WriteItems, threadTableWriteItems);
do {
// Check for unprocessed keys which could happen if you exceed
provisioned throughput
Map<String, List<WriteRequest>> unprocessedItems = outcome.ge
tUnprocessedItems();
if (outcome.getUnprocessedItems().size() == 0) {
System.out.println("No unprocessed items found");
} else {
System.out.println("Retrieving the unprocessed items");
outcome = dynamoDB.batchWriteItemUnprocessed(unpro
cessedItems);
}
} while (outcome.getUnprocessedItems().size() > 0);
}
catch (Exception e) {
System.err.println("Failed to retrieve items: ");
e.printStackTrace(System.err);
}
}
}
Example: Batch Get Operation Using the AWS SDK for Java
Document API
The following Java code example uses the batchGetItem method to retrieve multiple items from the
Forum and the Thread tables. The BatchGetItemRequest specifies the table names and item key list
for each item to get. The example processes the response by printing the items retrieved.
Note
This code example assumes that you have already loaded data into DynamoDB for your account
by following the instructions in the Creating Tables and Loading Sample Data (p. 14) section.
Alternatively, you can load the data programmatically using the instructions in the Creating
Example Tables and Uploading Data Using the AWS SDK for Java (p. 684) topic.
For step-by-step instructions to run the following example, see Running Java Examples for
DynamoDB (p. 55).
// Copyright 2012-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
// Licensed under the Apache License, Version 2.0.
package com.amazonaws.codesamples.document;
import
import
import
import
java.io.IOException;
java.util.HashMap;
java.util.List;
java.util.Map;
import
import
import
import
import
import
import
com.amazonaws.auth.profile.ProfileCredentialsProvider;
com.amazonaws.services.dynamodbv2.AmazonDynamoDBClient;
com.amazonaws.services.dynamodbv2.document.BatchGetItemOutcome;
com.amazonaws.services.dynamodbv2.document.DynamoDB;
com.amazonaws.services.dynamodbv2.document.Item;
com.amazonaws.services.dynamodbv2.document.TableKeysAndAttributes;
com.amazonaws.services.dynamodbv2.model.KeysAndAttributes;
catch (Exception e) {
System.err.println("Failed to retrieve items.");
System.err.println(e.getMessage());
}
}
Note
The AWS SDK for Java also provides a high-level object persistence model, enabling you to
map your client-side classes to DynamoDB tables. This approach can reduce the amount of
code you have to write. For more information, see Java: Object Persistence Model.
If you followed the Creating Tables and Loading Sample Data (p. 14) section, you should already have
created the Reply table. You can also create this tables programmatically. For more information, see
Creating Example Tables and Uploading Data Using the AWS SDK for Java (p. 684).
For step-by-step instructions to test the following sample, see Running Java Examples for
DynamoDB (p. 55).
// Copyright 2012-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
// Licensed under the Apache License, Version 2.0.
package com.amazonaws.codesamples.document;
import
import
import
import
import
import
import
import
import
java.io.ByteArrayInputStream;
java.io.ByteArrayOutputStream;
java.io.IOException;
java.nio.ByteBuffer;
java.text.SimpleDateFormat;
java.util.Date;
java.util.TimeZone;
java.util.zip.GZIPInputStream;
java.util.zip.GZIPOutputStream;
import
import
import
import
import
import
com.amazonaws.auth.profile.ProfileCredentialsProvider;
com.amazonaws.services.dynamodbv2.AmazonDynamoDBClient;
com.amazonaws.services.dynamodbv2.document.DynamoDB;
com.amazonaws.services.dynamodbv2.document.Item;
com.amazonaws.services.dynamodbv2.document.Table;
com.amazonaws.services.dynamodbv2.document.spec.GetItemSpec;
table.putItem(new Item()
.withPrimaryKey("Id", threadId)
.withString("ReplyDateTime", replyDateTime)
.withString("Message", "Long message follows")
.withBinary("ExtendedMessage", compressedMessage)
.withString("PostedBy", "User A"));
}
public static void retrieveItem(String threadId, String replyDateTime)
throws IOException {
Table table = dynamoDB.getTable(tableName);
GetItemSpec spec = new GetItemSpec()
.withPrimaryKey("Id", threadId, "ReplyDateTime", replyDateTime)
.withConsistentRead(true);
baos.write(buffer, 0, length);
}
return new String(baos.toByteArray(), "UTF-8");
}
}
You can use the AWS SDK for .NET low-level API (protocol-level API) to perform typical create, read,
update, and delete (CRUD) operations on an item in a table. The low-level API for item operations map
to the corresponding DynamoDB API (see Using the DynamoDB API (p. 513)).
Note that the .NET SDK also provides a set of document model classes (see .NET: Document
Model (p. 446)) that wrap some of the low-level API to simplify your coding tasks. The .NET SDK also
provides a high-level object persistence model (see .NET: Object Persistence Model (p. 477)), enabling
you to map your client-side classes to DynamoDB tables. These higher level APIs can reduce the amount
of code you have to write.
The following are the common steps you follow to perform data CRUD operations using the .NET low-level
API.
1. Create an instance of the AmazonDynamoDBClient class (the client).
2. Provide the operation specific required parameters in a corresponding request object.
For example, use the PutItemRequest request object when uploading an item and use the
GetItemRequest request object when retrieving an existing item.
You can use the request object to provide both the required and optional parameters.
3. Execute the appropriate method provided by the client by passing in the request object that you created
in the preceding step.
The AmazonDynamoDBClient client provides PutItem, GeItem, UpdateItem, and DeleteItem
methods for the CRUD operations.
Putting an Item
The PutItem method uploads an item to a table. If the item exists, it replaces the entire item.
Note
Instead of replacing the entire item, if you want to update only specific attributes, you can use
the UpdateItem method. For more information, see Updating an Item (p. 146).
The following are the steps to upload an item using the low-level .NET SDK API.
1. Create an instance of the AmazonDynamoDBClient class.
2. Provide the required parameters by creating an instance of the PutItemRequest class.
To put an item, you must provide the table name and the item.
3. Execute the PutItem method by providing the PutItemRequest object that you created in the
preceding step.
The following C# code snippet demonstrates the preceding steps. The example uploads an item to the
ProductCatalog table.
AmazonDynamoDBClient client = new AmazonDynamoDBClient();
string tableName = "ProductCatalog";
var request = new PutItemRequest
{
TableName = tableName,
Item = new Dictionary<string, AttributeValue>()
{
{ "Id", new AttributeValue { N = "201" }},
{ "Title", new AttributeValue { S = "Book 201 Title" }},
{ "ISBN", new AttributeValue { S = "11-11-11-11" }},
{ "Price", new AttributeValue { S = "20.00" }},
{
"Authors",
new AttributeValue
{ SS = new List<string>{"Author1", "Author2"}
}
}
}
};
client.PutItem(request);
In the preceding example, you upload a book item that has the Id, Title, ISBN, and Authors attributes.
Note that Id is a numeric type attribute and all other attributes are of the string type. Authors is a
multi-valued string attribute.
For more information about the parameters and the API, see PutItem.
Getting an Item
The GetItem method retrieves an item.
Note
To retrieve multiple items you can use the BatchGetItem method. For more information, see
Batch Get: Getting Multiple Items (p. 152).
The following are the steps to retrieve an existing item using the low-level .NET SDK API.
1. Create an instance of the AmazonDynamoDBClient class.
2. Provide the required parameters by creating an instance of the GetItemRequest class.
To get an item, you must provide the table name and primary key of the item.
3. Execute the GetItem method by providing the GetItemRequest object that you created in the
preceding step.
The following C# code snippet demonstrates the preceding steps. The example retrieves an item from
the ProductCatalog table.
AmazonDynamoDBClient client = new AmazonDynamoDBClient();
string tableName = "ProductCatalog";
var request = new GetItemRequest
{
TableName = tableName,
Key = new Dictionary<string,AttributeValue>() { { "Id", new AttributeValue
{ N = "202" } } },
};
var response = client.GetItem(request);
// Check the response.
var result = response.GetItemResult;
var attributeMap = result.Item; // Attribute list in the response.
For more information about the parameters and the API, see GetItem.
Updating an Item
The UpdateItem method updates an existing item if it is present.You can use the UpdateItem operation
to update existing attribute values, add new attributes, or delete attributes from the existing collection. If
the item that has the specified primary key is not found, it adds a new item.
The UpdateItem API uses the following guidelines:
If the item does not exist, the UpdateItem API adds a new item using the primary key that is specified
in the input.
If the item exists, the UpdateItem API applies the updates as follows:
Replaces the existing attribute values by the values in the update
If the attribute that you provide in the input does not exist, it adds a new attribute to the item.
If the input attribute is null, it deletes the attribute, if it is present.
If you use ADD for the Action, you can add values to an existing set (string or number set), or
mathematically add (use a positive number) or subtract (use a negative number) from the existing
numeric attribute value.
Note
The PutItem operation also can perform an update. For more information, see Putting an
Item (p. 144). For example, if you call PutItem to upload an item and the primary key exists, the
PutItem operation replaces the entire item. Note that, if there are attributes in the existing item
and those attributes are not specified in the input, the PutItem operation deletes those attributes.
However, the UpdateItem API only updates the specified input attributes, any other existing
attributes of that item remain unchanged.
The following are the steps to update an existing item using the low-level .NET SDK API.
1. Create an instance of the AmazonDynamoDBClient class.
2. Provide the required parameters by creating an instance of the UpdateItemRequest class.
This is the request object in which you describe all the updates, such as add attributes, update existing
attributes, or delete attributes. To delete an existing attribute, specify the attribute name with null value.
3. Execute the UpdateItem method by providing the UpdateItemRequest object that you created in
the preceding step.
The following C# code snippet demonstrates the preceding steps. The example updates a book item in
the ProductCatalog table. It adds a new author to the Authors collection, and deletes the existing ISBN
attribute. It also reduces the price by one.
AmazonDynamoDBClient client = new AmazonDynamoDBClient();
string tableName = "ProductCatalog";
var request = new UpdateItemRequest
{
TableName = tableName,
Key = new Dictionary<string,AttributeValue>() { { "Id", new AttributeValue
{ N = "202" } } },
ExpressionAttributeNames = new Dictionary<string,string>()
{
{"#A", "Authors"},
{"#P", "Price"},
{"#NA", "NewAttribute"},
{"#I", "ISBN"}
},
ExpressionAttributeValues = new Dictionary<string, AttributeValue>()
{
{":auth",new AttributeValue { SS = {"Author YY","Author ZZ"}}},
{":p",new AttributeValue {N = "1"}},
{":newattr",new AttributeValue {S = "someValue"}},
},
// This expression does the following:
// 1) Adds two new authors to the list
// 2) Reduces the price
// 3) Adds a new attribute to the item
// 4) Removes the ISBN attribute from the item
UpdateExpression = "ADD #A :auth SET #P = #P - :p, #NA = :newattr REMOVE
#I"
};
var response = client.UpdateItem(request);
For more information about the parameters and the API, see UpdateItem.
Atomic Counter
You can use updateItem to implement an atomic counter, where you increment or decrement the value
of an existing attribute without interfering with other write requests. To update an atomic counter, use
updateItem with an attribute of type Number in the UpdateExpression parameter, and ADD as the Action.
The following code snippet demonstrates this, incrementing the Quantity attribute by one.
AmazonDynamoDBClient client = new AmazonDynamoDBClient();
string tableName = "ProductCatalog";
var request = new UpdateItemRequest
{
Key = new Dictionary<string, AttributeValue>() { { "Id", new AttributeValue
{ N = "121" } } },
ExpressionAttributeNames = new Dictionary<string, string>()
{
{"#Q", "Quantity"}
},
ExpressionAttributeValues = new Dictionary<string, AttributeValue>()
{
{":incr",new AttributeValue {N = "1"}}
},
UpdateExpression = "SET #Q = #Q + :incr",
TableName = tableName
};
var response = client.UpdateItem(request);
Deleting an Item
The DeleteItem method deletes an item from a table.
The following are the steps to delete an item using the low-level .NET SDK API.
1. Create an instance of the AmazonDynamoDBClient class.
2. Provide the required parameters by creating an instance of the DeleteItemRequest class.
To delete an item, the table name and item's primary key are required.
3. Execute the DeleteItem method by providing the DeleteItemRequest object that you created in
the preceding step.
For more information about the parameters and the API, see DeleteItem.
{
{
table1Name, new List<WriteRequest>
{
new WriteRequest
{
PutRequest = new PutRequest
{
Item = new Dictionary<string,AttributeValue>
{
{ "Name", new AttributeValue { S = "Amazon S3 forum" } },
{ "Threads", new AttributeValue { N = "0" }}
}
}
}
}
} ,
{
table2Name, new List<WriteRequest>
{
new WriteRequest
{
PutRequest = new PutRequest
{
Item = new Dictionary<string,AttributeValue>
{
{ "ForumName", new AttributeValue { S = "Amazon S3 forum" }
},
{ "Subject", new AttributeValue { S = "My sample question" }
},
{ "Message", new AttributeValue { S = "Message Text." } },
{ "KeywordTags", new AttributeValue { SS = new List<string> {
"Amazon S3", "Bucket" } } }
}
}
},
new WriteRequest
{
DeleteRequest = new DeleteRequest
{
Key = new Dictionary<string,AttributeValue>()
{
{ "ForumName", new AttributeValue { S = "Some forum name" }
},
{ "Subject", new AttributeValue { S = "Some subject" } }
}
}
}
}
}
}
};
response = client.BatchWriteItem(request);
For a working example, see Example: Batch Operations Using AWS SDK for .NET Low-Level API (p. 162).
Note
To retrieve a single item you can use the GetItem method.
The following are the steps to retrieve multiple items using the low-level .NET SDK API.
1. Create an instance of the AmazonDynamoDBClient class.
2. Provide the required parameters by creating an instance of the BatchGetItemRequest class.
To retrieve multiple items, the table name and a list of primary key values are required.
3. Execute the BatchGetItem method by providing the BatchGetItemRequest object that you created
in the preceding step.
4. Process the response. You should check if there were any unprocessed keys, which could happen if
you reach the provisioned throughput limit or some other transient error.
The following C# code snippet demonstrates the preceding steps. The example retrieves items from two
tables, Forum and Thread. The request specifies two items in the Forum and three items in the Thread
table. The response includes items from both of the tables. The code shows how you can process the
response.
AmazonDynamoDBClient client = new AmazonDynamoDBClient();
string table1Name = "Forum";
string table2Name = "Thread";
var request = new BatchGetItemRequest
{
RequestItems = new Dictionary<string, KeysAndAttributes>()
{
{ table1Name,
new KeysAndAttributes
{
Keys = new List<Dictionary<string, AttributeValue>>()
{
new Dictionary<string, AttributeValue>()
{
{ "Name", new AttributeValue { S = "DynamoDB" } }
},
new Dictionary<string, AttributeValue>()
{
{ "Name", new AttributeValue { S = "Amazon S3" } }
}
}
}
},
{
table2Name,
new KeysAndAttributes
{
Keys = new List<Dictionary<string, AttributeValue>>()
{
new Dictionary<string, AttributeValue>()
{
Dictionary<string, AttributeValue>()
"ForumName", new AttributeValue { S = "DynamoDB" } },
"Subject", new AttributeValue { S = "DynamoDB Thread 2" } }
Dictionary<string, AttributeValue>()
"ForumName", new AttributeValue { S = "Amazon S3" } },
"Subject", new AttributeValue { S = "Amazon S3 Thread 1" } }
}
}
}
}
};
var response = client.BatchGetItem(request);
// Check the response.
var result = response.BatchGetItemResult;
var responses = result.Responses; // The attribute list in the response.
var table1Results = responses[table1Name];
Console.WriteLine("Items in table {0}" + table1Name);
foreach (var item1 in table1Results.Items)
{
PrintItem(item1);
}
var table2Results = responses[table2Name];
Console.WriteLine("Items in table {1}" + table2Name);
foreach (var item2 in table2Results.Items)
{
PrintItem(item2);
}
// Any unprocessed keys? could happen if you exceed ProvisionedThroughput or
some other error.
Dictionary<string, KeysAndAttributes> unprocessedKeys = result.UnprocessedKeys;
foreach (KeyValuePair<string, KeysAndAttributes> pair in unprocessedKeys)
{
Console.WriteLine(pair.Key, pair.Value);
}
For more information about the parameters and the API, see BatchGetItem.
Note
This section explains the .NET SDK low-level API.The .NET SDK also provides a set of document
model classes (see .NET: Document Model (p. 446)) that wrap some of the low-level API to
simplify your coding tasks. In addition, the .NET SDK also provides a high-level object persistence
model (see .NET: Object Persistence Model (p. 477)), enabling you to map your client-side classes
to DynamoDB tables. This approach can reduce the amount of code you have to write.
For a code example that demonstrates CRUD operations using the document model classes,
see Example: CRUD Operations Using the AWS SDK for .NET Document Model (p. 455). For a
code example that demonstrates CRUD operations using the object persistence model,
see Example: CRUD Operations Using the AWS SDK for .NET Object Persistence Model (p. 497).
For step-by-step instructions to test the following sample, see Using the AWS SDK for .NET (p. 56).
using System;
using System.Collections.Generic;
using Amazon.DynamoDBv2;
using Amazon.DynamoDBv2.Model;
using Amazon.Runtime;
using Amazon.SecurityToken;
namespace com.amazonaws.codesamples
{
class LowLevelItemCRUDExample
{
private static string tableName = "ProductCatalog";
private static AmazonDynamoDBClient client = new AmazonDynamoDBClient();
try
{
CreateItem();
RetrieveItem();
// Delete item.
DeleteItem();
Console.WriteLine("To continue, press Enter");
Console.ReadLine();
}
catch (Exception e)
{
Console.WriteLine(e.Message);
Console.WriteLine("To continue, press Enter");
Console.ReadLine();
}
}
},
// Perform the following updates:
// 1) Add two new authors to the list
// 1) Set a new attribute
// 2) Remove the ISBN attribute
ExpressionAttributeNames = new Dictionary<string,string>()
{
{"#A","Authors"},
{"#NA","NewAttribute"},
{"#I","ISBN"}
},
ExpressionAttributeValues = new Dictionary<string, Attribute
Value>()
{
{":auth",new AttributeValue {SS = {"Author YY", "Author
ZZ"}}},
{":new",new AttributeValue {S = "New Value"}}
},
TableName = tableName,
ReturnValues = "ALL_NEW" // Give me all attributes of the updated
item.
};
var response = client.UpdateItem(request);
TableName = tableName,
ReturnValues = "ALL_NEW" // Give me all attributes of the updated
item.
};
},
ConditionExpression = "#IP = :inpub"
};
{
string attributeName = kvp.Key;
AttributeValue value = kvp.Value;
Console.WriteLine(
attributeName + " " +
(value.S == null ? "" : "S=[" + value.S + "]") +
(value.N == null ? "" : "N=[" + value.N + "]") +
(value.SS == null ? "" : "SS=[" + string.Join(",",
value.SS.ToArray()) + "]") +
(value.NS == null ? "" : "NS=[" + string.Join(",",
value.NS.ToArray()) + "]")
);
}
Con
sole.WriteLine("************************************************");
}
}
}
Note
This section explains the .NET SDK low-level API.The .NET SDK also provides a set of document
model classes (see .NET: Document Model (p. 446)) that wrap some of the low-level API to
simplify your coding tasks. In addition, the .NET SDK also provides a high-level object persistence
model (see .NET: Object Persistence Model (p. 477)), enabling you to map your client-side classes
to DynamoDB tables.
For code examples that demonstrate batch operations using the object persistence model,
see Batch Operations Using AWS SDK for .NET Object Persistence Model (p. 493) and Example:
Batch Write Operation Using the AWS SDK for .NET Object Persistence Model (p. 500).
For more information, see Creating Example Tables and Uploading Data Using the AWS SDK for
.NET (p. 692).
For step-by-step instructions to test the following sample, see Using the AWS SDK for .NET (p. 56).
using System;
using System.Collections.Generic;
using Amazon.DynamoDBv2;
using Amazon.DynamoDBv2.Model;
using Amazon.Runtime;
namespace com.amazonaws.codesamples
{
class LowLevelBatchWrite
{
private static string table1Name = "Forum";
private static string table2Name = "Thread";
private static AmazonDynamoDBClient client = new AmazonDynamoDBClient();
try
{
TestBatchWrite();
}
catch (AmazonServiceException e) { Console.WriteLine(e.Message); }
{
PutRequest = new PutRequest
{
Item = new Dictionary<string, AttributeValue>
{
{ "ForumName", new AttributeValue { S = "S3 forum" } },
{ "Subject", new AttributeValue { S = "My sample question"
} },
{ "Message", new AttributeValue { S = "Message Text." }
},
{ "KeywordTags", new AttributeValue { SS = new List<string>
} }
{ "S3", "Bucket" }
}
}
},
new WriteRequest
{
// For the operation to delete an item, if you provide a primary
key value
// that does not exist in the table, there is no error, it is
just a no-op.
DeleteRequest = new DeleteRequest
{
Key = new Dictionary<string, AttributeValue>()
{
{ "ForumName",
value" } },
{ "Subject", new AttributeValue { S = "Some range attr
value" } }
}
}
}
}
}
}
};
CallBatchWriteTillCompletion(request);
}
int callCount = 0;
do
{
Console.WriteLine("Making request");
response = client.BatchWriteItem(request);
callCount++;
{
Console.WriteLine("{0} - {1}", tableConsumedCapacity.Table
Name, tableConsumedCapacity.CapacityUnits);
Console.WriteLine("Unprocessed");
foreach (var unp in unprocessed)
{
Console.WriteLine("{0} - {1}", unp.Key, unp.Value.Count);
}
Console.WriteLine();
Example: Batch Get Operation Using the AWS SDK for .NET
Low-Level API
The following C# code example uses the BatchGetItem method to retrieve multiple items from the
Forum and the Thread tables. The BatchGetItemRequest specifies the table names and a list of primary
keys for each table. The example processes the response by printing the items retrieved.
Note
This section explains the .NET SDK low-level API.The .NET SDK also provides a set of document
model classes (see .NET: Document Model (p. 446)) that wrap some of the low-level API to
simplify your coding tasks. In addition, the .NET SDK also provides a high-level object persistence
model (see .NET: Object Persistence Model (p. 477)), enabling you to map your client-side classes
to DynamoDB tables. The individual object instances then map to items in a table.
For code examples that demonstrate batch operations using the object persistence model,
see Batch Operations Using AWS SDK for .NET Object Persistence Model (p. 493) and Example:
Batch Write Operation Using the AWS SDK for .NET Object Persistence Model (p. 500).
If you followed the steps in Creating Tables and Loading Sample Data (p. 14), you already have these
tables created with sample data. You can also create these sample tables and upload sample data
programmatically. For more information, see Creating Example Tables and Uploading Data Using the
AWS SDK for .NET (p. 692).
For step-by-step instructions to test the following sample, see Using the AWS SDK for .NET (p. 56).
using System;
using System.Collections.Generic;
using Amazon.DynamoDBv2;
using Amazon.DynamoDBv2.Model;
using Amazon.Runtime;
namespace com.amazonaws.codesamples
{
class LowLevelBatchGet
{
private static string table1Name = "Forum";
private static string table2Name = "Thread";
private static AmazonDynamoDBClient client = new AmazonDynamoDBClient();
{
Keys = new List<Dictionary<string, AttributeValue>>()
{
new Dictionary<string, AttributeValue>()
{
{ "ForumName", new AttributeValue { S = "Amazon DynamoDB" }
},
{ "Subject", new AttributeValue { S = "DynamoDB Thread 1" }
}
},
new Dictionary<string, AttributeValue>()
{
{ "ForumName", new AttributeValue { S = "Amazon DynamoDB" }
},
{ "Subject", new AttributeValue { S = "DynamoDB Thread 2" }
}
},
new Dictionary<string, AttributeValue>()
{
{ "ForumName", new AttributeValue { S = "Amazon S3" } },
{ "Subject", new AttributeValue { S = "S3 Thread 1" } }
}
}
}
}
}
};
BatchGetItemResponse response;
do
{
Console.WriteLine("Making request");
response = client.BatchGetItem(request);
request.RequestItems = unprocessedKeys;
} while (response.UnprocessedKeys.Count > 0);
}
{
string attributeName = kvp.Key;
AttributeValue value = kvp.Value;
Console.WriteLine(
attributeName + " " +
(value.S == null ? "" : "S=[" + value.S + "]") +
(value.N == null ? "" : "N=[" + value.N + "]") +
(value.SS == null ? "" : "SS=[" + string.Join(",",
value.SS.ToArray()) + "]") +
(value.NS == null ? "" : "NS=[" + string.Join(",",
value.NS.ToArray()) + "]")
);
}
Con
sole.WriteLine("************************************************");
}
}
}
Note
This section explains the .NET SDK low-level API.The .NET SDK also provides a set of document
model classes (see .NET: Document Model (p. 446)) that wrap some of the low-level API to
simplify your coding tasks. In addition, the .NET SDK also provides a high-level object persistence
model (see .NET: Object Persistence Model (p. 477)), enabling you to map your client-side classes
to DynamoDB tables.
If you followed the steps in Creating Tables and Loading Sample Data (p. 14), you already have the Reply
table created. You can also create these sample tables programmatically. For more information, see
Creating Example Tables and Uploading Data Using the AWS SDK for .NET (p. 692).
For step-by-step instructions to test the following sample, see Using the AWS SDK for .NET (p. 56).
using System;
using System.Collections.Generic;
using System.IO;
using System.IO.Compression;
using Amazon.DynamoDBv2;
using Amazon.DynamoDBv2.Model;
using Amazon.Runtime;
namespace com.amazonaws.codesamples
{
class LowLevelItemBinaryExample
{
private static string tableName = "Reply";
private static AmazonDynamoDBClient client = new AmazonDynamoDBClient();
try
{
CreateItem(replyIdHashAttribute, replyDateTimeRangeAttribute);
RetrieveItem(replyIdHashAttribute, replyDateTimeRangeAttribute);
// Delete item.
DeleteItem(replyIdHashAttribute, replyDateTimeRangeAttribute);
PrintItem(attributeList);
}
{
string attributeName = kvp.Key;
AttributeValue value = kvp.Value;
Console.WriteLine(
{
return reader.ReadToEnd();
}
}
}
}
Putting an Item
The PHP putItem function uploads an item to a table. If the item exists, it replaces the entire item.
Instead of replacing the entire item, if you want to update only specific attributes, you can use the
updateItem function. For more information, see Updating an Item (p. 184).
The following are the steps to upload an item to DynamoDB using the AWS SDK for PHP.
API Version 2012-08-10
178
Note
This code example assumes that you have already loaded data into DynamoDB for your account
by following the instructions in the Creating Tables and Loading Sample Data (p. 14) section.
Alternatively, you can load the data programmatically using the instructions in the Creating
Example Tables and Uploading Data Using the AWS SDK for PHP (p. 710) topic.
For step-by-step instructions to run the following example, see Running PHP Examples (p. 59).
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' #replace with your desired region
));
$response = $client->putItem(array(
'TableName' => 'ProductCatalog',
'Item' => array(
'Id'
=> array('N'
'Title'
=> array('S'
'ISBN'
=> array('S'
'Price'
=> array('N'
'Authors' => array('SS' =>
)
));
=> 104
), // Primary Key
=> 'Book 104 Title' ),
=> '111-1111111111' ),
=> 25 ),
array('Author1', 'Author2') )
$client = DynamoDbClient::factory(array(
"profile" => "default",
"region" => "us-west-2" #replace with your desired region
));
$tableName = "ProductCatalog";
Getting an Item
The getItem function retrieves a single item. To retrieve multiple items, you can use the batchGetItem
method (see Batch Get: Getting Multiple Items (p. 183)).
The following are the steps to retrieve an item.
1. Create an instance of the DynamoDbClient class.
2. Provide the parameters for the getItem operation to the client instance.
You must provide the table name and primary key values.
3. Load the response into a local variable, such as $response to use in your application.
The following PHP code snippet demonstrates the preceding steps. The code gets the item that has the
specified hash primary key.
Note
This code example assumes that you have already loaded data into DynamoDB for your account
by following the instructions in the Creating Tables and Loading Sample Data (p. 14) section.
Alternatively, you can load the data programmatically using the instructions in the Creating
Example Tables and Uploading Data Using the AWS SDK for PHP (p. 710) topic.
For step-by-step instructions to run the following example, see Running PHP Examples (p. 59).
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' #replace with your desired region
));
$response = $client->getItem(array(
'TableName' => 'ProductCatalog',
'Key' => array(
'Id' => array( 'N' => 104 )
)
));
print_r ($response['Item']);
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' #replace with your desired region
));
$response = $client->getItem(array(
'TableName' => 'ProductCatalog',
'Key' => array(
'Id' => array('N' => 104 ),
),
'ProjectionExpression' => 'Id, Authors',
'ConsistentRead' => true
));
print_r ($response['Item']);
For more information about the parameters and the API, see GetItem.
The following are the common steps that you follow to get multiple items.
1. Create an instance of the DynamoDbClient class.
2. Execute the batchWriteItem operation by providing the associative array parameter with the list of
put and write requests.
The following PHP code snippet demonstrates the preceding steps. The code performs the following write
operations:
Put an item in the Forum table.
Put and delete an item from the Thread table.
Note that the key:value pair specified in the array parameter to the batchWriteItem uses syntax
required by the underlying DynamoDB API. For more information, see BatchWriteItem.
Note
This code example assumes that you have already loaded data into DynamoDB for your account
by following the instructions in the Creating Tables and Loading Sample Data (p. 14) section.
Alternatively, you can load the data programmatically using the instructions in the Creating
Example Tables and Uploading Data Using the AWS SDK for PHP (p. 710) topic.
For step-by-step instructions to run the following example, see Running PHP Examples (p. 59).
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' #replace with your desired region
));
$tableNameOne = "Forum";
$tableNameTwo = "Thread";
$response = $client->batchWriteItem(array(
"RequestItems" => array(
$tableNameOne => array(
array(
"PutRequest" => array(
"Item" => array(
"Name"
=> array('S' => "Amazon S3 Forum"),
"Threads" => array('N' => 0)
))
)
),
$tableNameTwo => array(
array(
"PutRequest" => array(
"Item" => array(
"ForumName"
=> array('S' => "Amazon S3 Forum"),
"Subject" => array('S' => "My sample question"),
"Message"=> array('S' => "Message Text."),
"KeywordTags"=>array('SS' => array("Amazon S3", "Buck
et"))
))
),
array(
"DeleteRequest" => array(
"Key" => array(
Note
This code example assumes that you have already loaded data into DynamoDB for your account
by following the instructions in the Creating Tables and Loading Sample Data (p. 14) section.
Alternatively, you can load the data programmatically using the instructions in the Creating
Example Tables and Uploading Data Using the AWS SDK for PHP (p. 710) topic.
For step-by-step instructions to run the following example, see Running PHP Examples (p. 59).
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' #replace with your desired region
));
date_default_timezone_set("UTC");
$sevenDaysAgo = date("Y-m-d H:i:s", strtotime("-7 days"));
$twentyOneDaysAgo = date("Y-m-d H:i:s", strtotime("-21 days"));
$response = $client->batchGetItem(array(
"RequestItems" => array(
"Forum" => array(
"Keys" => array(
array( // Key #2
"Name" => array( 'S' => "DynamoDB" )
)
)
),
"Reply" => array(
"Keys" => array(
array( // Key #1
"Id" => array( 'S' => "DynamoDB#DynamoDB Thread 2"),
"ReplyDateTime" => array( 'S' => $sevenDaysAgo),
),
array( // Key #2
"Id" => array( 'S' => "DynamoDB#DynamoDB Thread 2"),
"ReplyDateTime" => array( 'S' => $twentyOneDaysAgo),
),
)
)
)
));
print_r($response['Responses']);
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' #replace with your desired region
));
$response = $client->batchGetItem(array(
"RequestItems" => array(
"Forum" => array(
"Keys" => array(
array( // Key #1
"Name" => array( 'S' => "Amazon S3" )
),
array( // Key #2
"Name" => array( 'S' => "DynamoDB" )
)
),
"ProjectionExpression" => "Threads"
),
)
));
print_r($response);
For more information about the parameters and the API, see BatchGetItem.
Updating an Item
Use the updateItem function to update existing attribute values, add new attributes to the existing
collection, or delete attributes from the existing collection.
The updateItem function uses the following guidelines:
If an item does not exist, the updateItem function adds a new item using the primary key that is
specified in the input.
If an item exists, the updateItem function applies the updates as follows:
Replaces the existing attribute values with the values in the update.
If the attribute you provide in the input does not exist, it adds a new attribute to the item.
If you use ADD for the Action, you can add values to an existing set (string or number set), or
mathematically add (use a positive number) or subtract (use a negative number) from the existing
numeric attribute value.
Note
The putItem function (Putting an Item (p. 178)) also updates items. For example, if you use
putItem to upload an item and the primary key exists, the operation replaces the entire item.
If there are attributes in the existing item and those attributes are not specified in the input, the
putItem operation deletes those attributes. However, the updateItem API only updates the
specified input attributes so that any other existing attributes of that item remain unchanged.
The following are the steps to update an existing item using the AWS SDK for PHP.
1. Create an instance of the DynamoDbClient class.
2. Provide the parameters for the updateItem operation to the client instance as an UpdateExpression.
You must provide the table name, primary key, and attribute names and values to update.
3. Load the response into a local variable, such as $response to use in your application.
The following PHP code snippet demonstrates the preceding tasks. The example updates a book item
in the ProductCatalog table. It adds a new author to the Authors multi-valued attribute and deletes the
existing ISBN attribute. It also reduces the price by one.
Note
This code example assumes that you have already loaded data into DynamoDB for your account
by following the instructions in the Creating Tables and Loading Sample Data (p. 14) section.
Alternatively, you can load the data programmatically using the instructions in the Creating
Example Tables and Uploading Data Using the AWS SDK for PHP (p. 710) topic.
For step-by-step instructions to run the following example, see Running PHP Examples (p. 59).
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' #replace with your desired region
));
$response = $client->updateItem(array(
'TableName' => 'ProductCatalog',
'Key' => array(
'Id' => array(
'N' => 201
)
),
'ExpressionAttributeValues' => array (
':val1' => array(
'S' => 'Author YY',
'S' => 'Author ZZ'),
':val2' => array('N' => '1')
) ,
'UpdateExpression' => 'set Authors = :val1, Price = Price - :val2 remove
ISBN'
));
print_r($response);
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' #replace with your desired region
));
$response = $client->updateItem(array(
'TableName' => 'ProductCatalog',
'Key' => array(
'Id' => array(
'N' => 201
)
),
'ExpressionAttributeValues' => array (
':val1' => array('N' => 22),
':val2' => array('N' => 20)
) ,
'UpdateExpression' => 'set Price = :val1',
'ConditionExpression' => 'Price = :val2',
'ReturnValues' => 'ALL_NEW'
));
print_r($response);
For more information about the parameters and the API, see UpdateItem>.
Atomic Counter
You can use updateItem to implement an atomic counter, where you increment or decrement the value
of an existing attribute without interfering with other write requests. To update an atomic counter, use
updateItem with an appropriate UpdateExpression.
The following code snippet demonstrates this, incrementing the Quantity attribute by one.
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' #replace with your desired region
));
$response = $client->updateItem(array(
Deleting an Item
The deleteItem function deletes an item from a table.
The following are the common steps that you follow to delete an item using the AWS SDK for PHP.
1. Create an instance of the DynamoDbClient class (the client).
2. Provide the parameters for the deleteItem operation to the client instance.
You must provide the table name and primary key values.
3. Load the response into a local variable, such as $response to use in your application.
Note
This code example assumes that you have already loaded data into DynamoDB for your account
by following the instructions in the Creating Tables and Loading Sample Data (p. 14) section.
Alternatively, you can load the data programmatically using the instructions in the Creating
Example Tables and Uploading Data Using the AWS SDK for PHP (p. 710) topic.
For step-by-step instructions to run the following example, see Running PHP Examples (p. 59).
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' #replace with your desired region
));
$response = $client->deleteItem(array(
'TableName' => 'ProductCatalog',
'Key' => array(
'Id' => array(
'N' => 101
)
)
));
An Expected parameter specifying that the Book item with Id value "103" in the ProductCatalog table
be deleted only if the book is no longer in publication. Specifically, delete the book if the InPublication
attribute is false.
A RETURN_ALL_OLD enumeration value for the ReturnValues parameter requests that the response
include the item that was deleted and its attributes before the deletion.
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' #replace with your desired region
));
$tableName = "ProductCatalog";
$response = $client->deleteItem ( array (
'TableName' => $tableName,
'Key' => array (
'Id' => array (
'N' => 103
)
),
'ExpressionAttributeValues' => array(
':val1' => array('BOOL' => false)
),
'ConditionExpression' => 'InPublication = :val1',
'ReturnValues' => 'ALL_OLD'
) );
For more information about the parameters and the API, see DeleteItem.
Note
For step-by-step instructions to test the following code example, see Running PHP
Examples (p. 59).
<?php
use Aws\DynamoDb\DynamoDbClient;
$client = DynamoDbClient::factory(array(
"profile" => "default",
"region" => "us-west-2" // replace with your desired region
));
$tableName = "ProductCatalog";
// ###################################################################
// ###################################################################
// Updating item attributes
echo PHP_EOL . PHP_EOL;
echo "# Updating an item and returning the whole new item in table $tableName..."
. PHP_EOL;
$response = $client->updateItem ( array (
"TableName" => $tableName,
"Key" => array (
"Id" => array (
"N" => 120 //was 121
)
),
"ExpressionAttributeNames" => array (
"#NA" => "NewAttribute",
"#A" => "Authors"
),
"ExpressionAttributeValues" => array (
":val1" => array("S" => "Some Value"),
":val2" => array("SS" => array("Author YY","Author ZZ"))
) ,
"UpdateExpression" => "set #NA = :val1, #A = :val2",
"ReturnValues" => "ALL_NEW"
) );
print_r ( $response ["Attributes"] );
// ###################################################################
// Conditionally updating the Price attribute, only if it has not changed.
echo PHP_EOL . PHP_EOL;
echo "# Updating an item attribute only if it has not changed in table $table
Name..." . PHP_EOL;
$response = $client->updateItem ( array (
"TableName" => $tableName,
"Key" => array (
"Id" => array (
"N" => "121"
)
),
"ExpressionAttributeNames" => array (
"#P" => "Price"
),
"ExpressionAttributeValues" => array(
":val1" => array("N" => "25"),
":val2" => array("N" => "20"),
),
"UpdateExpression" => "set #P = :val1",
"ConditionExpression" => "#P = :val2",
"ReturnValues" => "ALL_NEW"
) );
print_r ( $response ["Attributes"] );
// ###################################################################
// Deleting an item
Note
For step-by-step instructions to test the following code example, see Running PHP
Examples (p. 59).
<?php
use Aws\DynamoDb\DynamoDbClient;
$client = DynamoDbClient::factory(array(
"profile" => "default",
"region" => "us-west-2" // replace with your desired region
));
$tableNameOne = "Forum";
$tableNameTwo = "Thread";
$response = $client->batchWriteItem(array(
Tip
You can query or scan a secondary index in the same way that you query a table. To do this,
you must provide IndexName and TableName as parameters to the Query or Scan API. For
more information, see Improving Data Access with Secondary Indexes in DynamoDB (p. 249).
Query
A Query operation finds items in a table or a secondary index using only primary key attribute values.
You must provide a hash key attribute name and a distinct value to search for. You can optionally provide
a range key attribute name and value, and use a comparison operator to refine the search results. By
default, a Query operation returns all of the data attributes for items with the specified primary key(s);
however, you can use the ProjectionExpression parameter so that the Query operation only returns
some of the attributes, rather than all of them.
In a Query operation, you use the KeyConditionExpression parameter to determine the items to be
read from the table or index. You must specify the hash key attribute name and value as an equality
condition.You can optionally provide a second condition for the range key attribute (if present). The range
key condition must use one of the following comparison operators:
a = b true if the attribute a is equal to the value b
a < b true if a is less than b
a <= b true if a is less than or equal to b
a > b true if a is greater than b
a >= b true if a is greater than or equal to b
a BETWEEN b AND c true if a is greater than or equal to b, and less than or equal to c.
The following function is also supported:
begins_with (a, substr) true if the value of attribute a begins with a particular substring.
Following are some examples of key condition expressions. Note that these expressions use placeholders
(such as :name and :subj) instead of actual values. For more information, see Expression Attribute
Names (p. 101) and Expression Attribute Values (p. 103).
Query the Thread table for a particular ForumName (hash key). All of the items with that ForumName
value will be read by the query, because the range key (Subject) is not included in
KeyConditionExpression.
ForumName = :name
Query the Thread table for a particular ForumName (hash key), but this time return only the items with
a given Subject (range key).
Forum = :name and Subject = :subj
Query the Reply table for a particular Id (hash key), but return only those items whose ReplyDateTime
(range key) begins with certain characters.
Id = :id and begins_with(ReplyDateTime, :dt)
You can use any attribute name in a key condition expression, provided that the first character is a-z or
A-Z and the second character (if present) is a-z, A-Z, or 0-9. In addition, the attribute name must not
be a DynamoDB reserved word. (For a complete list of these, see Reserved Words in DynamoDB (p. 718).)
If an attribute name does not meet these requirements, you will need to define an expression attribute
name as a placeholder. For more information, see Expression Attribute Names (p. 101).
For items with a given hash key, DynamoDB stores these items close together, in sorted order by range
key. In a Query operation, DynamoDB retrieves the items in sorted order, and then processes the items
using KeyConditionExpression and any FilterExpression that might be present. Only then are
the Query results sent back to the client.
A Query operation always returns a result set. If no matching items are found, the result set will be empty.
Query results are always sorted by the range key. If the data type of the range key is Number, the results
are returned in numeric order; otherwise, the results are returned in order of ASCII character code values.
By default, the sort order is ascending. To reverse the order, set the ScanIndexForward parameter to
false.
A single Query request can retrieve a maximum of 1 MB of data; DynamoDB can optionally apply a filter
expression to this data, narrowing the results before they are returned to the user. (For more information
on filters, see Filtering the Results from a Query or a Scan (p. 195).)
Scan
A Scan operation reads every item in a table or a secondary index. By default, a Scan operation returns
all of the data attributes for every item in the table or index. You can use the ProjectionExpression
parameter so that Scan only returns some of the attributes, rather than all of them.
Scan always returns a result set. If no matching items are found, the result set will be empty.
A single Scan request can retrieve a maximum of 1 MB of data; DynamoDB can optionally apply a filter
expression to this data, narrowing the results before they are returned to the user. (For more information
on filters, see Filtering the Results from a Query or a Scan (p. 195).)
Note that Views is a reserved word in DynamoDB (see Reserved Words in DynamoDB (p. 718)), so we
use an expression attribute name as a substitution.
Scan the Thread table and return only the items that were last posted to by a particular user.
LastPostedBy = :name
Note
The syntax for FilterExpression is identical to that of ConditionExpression. In addition,
FilterExpression uses the same comparators, functions, and logical operators as
ConditionExpression. For more information, see Condition Expression Reference (p. 104).
A single Query or Scan operation can retrieve a maximum of 1 MB of data. This limit applies before any
filter expression is applied to the results.
You can use Query and Scan operations on secondary indexes in the same way that you use these
operations on a table. If you use Query or Scan on a local secondary index, then capacity units are
consumed from the table's provisioned throughput. However, if you perform these operations on a global
secondary index, capacity units are consumed from the provisioned throughput of the index. This is
because a global secondary index has its own provisioned throughput settings, separate from those of
its table.
For more information about how DynamoDB computes the capacity units consumed by your operation,
see Capacity Units Calculations for Various Operations (p. 64).
Note
For Query and Scan operations, DynamoDB calculates the amount of consumed provisioned
throughput based on item size, not on the amount of data that is returned to an application. For
this reason, the number of capacity units consumed will be the same whether you request all of
the attributes (the default behavior) or just some of them using the ProjectionExpression
parameter.
The number of capacity units consumed will also be the same whether or not you specify a
FilterExpression operation.
Limit
The DynamoDB Query and Scan APIs allow a Limit value to restrict the size of the results.
In a request, set the Limit parameter to the number of items that you want DynamoDB to process before
returning results.
In a response, DynamoDB returns all the matching results within the scope of the Limit value. For
example, if you issue a Query or a Scan request with a Limit value of 6 and without a filter expression,
DynamoDB returns the first six items in the table that match the specified key conditions in the request
(or just the first six items in the case of a Scan with no filter). If you also supply a FilterExpression
value, DynamoDB will return the items in the first six that also match the filter requirements (the number
of results returned will be less than or equal to 6).
For either a Query or Scan operation, DynamoDB might return a LastEvaluatedKey value if the
operation did not return all matching items in the table. To get the full count of items that match, take the
LastEvaluatedKey value from the previous request and use it as the ExclusiveStartKey value in
the next request. Repeat this until DynamoDB no longer returns a LastEvaluatedKey value.
Read Consistency
Read Consistency for Query
A Query result is an eventually consistent read, but you can request a strongly consistent read instead.
An eventually consistent read might not reflect the results of a recently completed PutItem or UpdateItem
operation. For more information, see Data Read and Consistency Considerations (p. 10).
response times, design your tables and indexes so that your applications can use Query instead of Scan.
(For tables, you can also consider using the GetItem and BatchGetItem APIs.).
Alternatively, design your application to use Scan operations in a way that minimizes the impact on your
request rate. For more information, see Guidelines for Query and Scan (p. 199).
A Query operation searches for a specific range of keys that satisfy a given set of key conditions. If you
specify a filter expression, then DynamoDB must perform the extra step of removing data from the result
set. A Query operation seeks the specified composite primary key, or range of keys, until one of the
following events occurs:
The result set is exhausted.
The number of items retrieved reaches the value of the Limit parameter, if specified.
The amount of data retrieved reaches the maximum result set size limit of 1 MB.
Query performance depends on the amount of data retrieved, rather than the overall number of primary
keys in a table or secondary index. The parameters for a Query operation (and consequently the number
of matching keys) determine the performance of the query. For example, a query on a table that contains
a large set of range key elements for a single hash key element can be more efficient than a query on
another table that has fewer range key elements per hash key element, if the number of matching keys
in the first table is fewer than in the second. The total number of primary keys, in either table, does not
determine the efficiency of a Query operation. A filter expression can also have an impact on the efficiency
of a Query operation, because the items that don't match the filter must be removed from the result set.
Avoid using a Query operation on a large table or secondary index with a filter that removes many results,
if possible.
If a specific hash key element has a large range key element set, and the results cannot be retrieved in
a single Query request, the ExclusiveStartKey continuation parameter allows you to submit a new
query request from the last retrieved item without reprocessing the data already retrieved.
Parallel Scan
By default, the Scan operation processes data sequentially. DynamoDB returns data to the application
in 1 MB increments, and an application performs additional Scan operations to retrieve the next 1 MB of
data.
The larger the table or index being scanned, the more time the Scan will take to complete. In addition, a
sequential Scan might not always be able to fully utilize the provisioned read throughput capacity: Even
though DynamoDB distributes a large table's data across multiple physical partitions, a Scan operation
can only read one partition at a time. For this reason, the throughput of a Scan is constrained by the
maximum throughput of a single partition.
To address these issues, the Scan operation can logically divide a table or secondary index into multiple
segments, with multiple application workers scanning the segments in parallel. Each worker can be a
thread (in programming languages that support multithreading) or an operating system process. To
perform a parallel scan, each worker issues its own Scan request with the following parameters:
Segment A segment to be scanned by a particular worker. Each worker should use a different value
for Segment.
TotalSegments The total number of segments for the parallel scan. This value must be the same
as the number of workers that your application will use.
The following diagram shows how a multithreaded application performs a parallel Scan with three degrees
of parallelism:
In this diagram, the application spawns three threads and assigns each thread a number. (Segments are
zero-based, so the first number is always 0.) Each thread issues a Scan request, setting Segment to its
designated number and setting TotalSegments to 3. Each thread scans its designated segment, retrieving
data 1 MB at a time, and returns the data to the application's main thread.
The values for Segment and TotalSegments apply to individual Scan requests, and you can use different
values at any time. You might need to experiment with these values, and the number of workers you use,
until your application achieves its best performance.
Note
A parallel scan with a large number of workers can easily consume all of the provisioned
throughput for the table or index being scanned. It is best to avoid such scans if the table or
index is also incurring heavy read or write activity from other applications.
To control the amount of data returned per request, use the Limit parameter. This can help
prevent situations where one worker consumes all of the provisioned throughput, at the expense
of all other workers. For more information, see "Reduce Page Size" in Avoid Sudden Bursts of
Read Activity (p. 200).
Instead of using a large Scan operation, you can use the following techniques to minimize the impact of
a scan on a table's provisioned throughput.
Reduce Page Size
Because a Scan operation reads an entire page (by default, 1 MB), you can reduce the impact of the
scan operation by setting a smaller page size. The Scan operation provides a Limit parameter that you
can use to set the page size for your request. Each Scan or Query request that has a smaller page
size uses fewer read operations and creates a "pause" between each request. For example, if each
item is 4 KB and you set the page size to 40 items, then a Query request would consume only 40
strongly consistent read operations or 20 eventually consistent read operations. A larger number of
smaller Scan or Query operations would allow your other critical requests to succeed without throttling.
Isolate Scan Operations
DynamoDB is designed for easy scalability. As a result, an application can create tables for distinct
purposes, possibly even duplicating content across several tables. You want to perform scans on a
table that is not taking "mission-critical" traffic. Some applications handle this load by rotating traffic
hourly between two tables one for critical traffic, and one for bookkeeping. Other applications can do
this by performing every write on two tables: a "mission-critical" table, and a "shadow" table.
You should configure your application to retry any request that receives a response code that indicates
you have exceeded your provisioned throughput, or increase the provisioned throughput for your table
using the UpdateTable operation. If you have temporary spikes in your workload that cause your throughput
to exceed, occasionally, beyond the provisioned level, retry the request with exponential backoff. For
more information about implementing exponential backoff, see Error Retries and Exponential
Backoff (p. 523).
Choosing TotalSegments
The best setting for TotalSegments depends on your specific data, the table's provisioned throughput
settings, and your performance requirements. You will probably need to experiment to get it right. We
recommend that you begin with a simple ratio, such as one segment per 2 GB of data. For example, for
a 30 GB table, you could set TotalSegments to 15 (30 GB / 2 GB). Your application would then use
fifteen workers, with each worker scanning a different segment.
You can also choose a value for TotalSegments that is based on client resources. You can set
TotalSegments to any number from 1 to 1000000, and DynamoDB will allow you to scan that number
of segments. If, for example, your client limits the number of threads that can run concurrently, you can
gradually increase TotalSegments until you get the best Scan performance with your application.
You will need to monitor your parallel scans to optimize your provisioned throughput utilization, while also
making sure that your other applications aren't starved of resources. Increase the value for TotalSegments
if you do not consume all of your provisioned throughput but still experience throttling in your Scan
requests. Reduce the value for TotalSegments if the Scan requests consume more provisioned
throughput than you want to use.
Querying in DynamoDB
Topics
Querying Using the AWS SDK for Java Document API (p. 203)
Querying Using the AWS SDK for .NET Low-Level API (p. 209)
Querying Tables Using the AWS SDK for PHP Low-Level API (p. 220)
This section shows basic queries and their results.
Note
This section explains the AWS SDK for Java Document API.The AWS SDK for Java also provides
a high-level object persistence model, enabling you to map your client-side classes to DynamoDB
tables. This approach can reduce the amount of code you have to write. For more information,
see Java: Object Persistence Model.
The following are the steps to retrieve an item using the AWS SDK for Java Document API.
1. Create an instance of the DynamoDB class.
2. Create an instance of the Table class to represent the table you want to work with.
3. Call the query method of the Table instance. You must specify the hash key of the item(sK) that you
want to retrieve, along with any optional query parameters.
The response includes an ItemCollection object that provides all items returned by the query.
The following Java code snippet demonstrates the preceding tasks. The snippet assumes you have a
Reply table that stores replies for forum threads. For more information, see Example Tables and
Data (p. 678).
Reply ( Id, ReplyDateTime, ... )
Each forum thread has a unique ID and can have zero or more replies. Therefore, the Id attribute of the
Reply table is composed of both the forum name and forum subject. The Id and the ReplyDateTime make
up the composite hash-and-range primary key for the table.
The following query retrieves all replies for a specific thread subject. The query requires both the table
name and the Subject value.
You can also optionally limit the number of items per page by using the withMaxPageSize method.
When time you call the query method, you get an ItemCollection that contains the resulting items.
You can then step through the results, processing one page at a time, until there are no more pages.
The following Java code snippet modifies the query specification shown above. This time, the query spec
uses the withMaxPageSize method.The Page class provides an Iterator that allows the code to process
the items on each page.
spec.withMaxPageSize(10);
ItemCollection<QueryOutcome> items = table.query(spec);
// Process each page of results
int pageNum = 0;
for (Page<Item, QueryOutcome> page : items.pages()) {
System.out.println("\nPage: " + ++pageNum);
// Process each item on the current page
Iterator<Item> item = page.iterator();
while (item.hasNext()) {
System.out.println(item.next().toJSONPretty());
}
}
Note
This section explains the AWS SDK for Java Document API.The AWS SDK for Java also provides
a high-level object persistence model, enabling you to map your client-side classes to DynamoDB
tables. This approach can reduce the amount of code you have to write. For more information,
see Java: Object Persistence Model.
For a code example that demonstrates query operations using the object persistence model,
see Example: Query and Scan (p. 438).
Forum ( Name, ... )
Thread ( ForumName, Subject, Message, LastPostedBy, LastPostDateTime, ...)
Reply ( Id, ReplyDateTime, Message, PostedBy, ...)
In this Java code example, you execute variations of finding replies for a thread 'DynamoDB Thread 1'
in forum 'DynamoDB'.
Find replies for a thread.
Find replies for a thread, specifying a limit on the number of items per page of results. If the number
of items in the result set exceeds the page size, you get only the first page of results. This coding pattern
ensures your code processes all the pages in the query result.
Find replies in the last 15 days.
Find replies in a specific date range.
Both the preceding two queries shows how you can specify range key conditions to narrow the query
results and use other optional query parameters.
Note
This code example assumes that you have already loaded data into DynamoDB for your account
by following the instructions in the Creating Tables and Loading Sample Data (p. 14) section.
Alternatively, you can load the data programmatically using the instructions in the Creating
Example Tables and Uploading Data Using the AWS SDK for Java (p. 684) topic.
For step-by-step instructions to run the following example, see Running Java Examples for
DynamoDB (p. 55).
// Copyright 2012-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
// Licensed under the Apache License, Version 2.0.
package com.amazonaws.codesamples.document;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Iterator;
import
import
import
import
import
import
import
import
import
import
com.amazonaws.auth.profile.ProfileCredentialsProvider;
com.amazonaws.services.dynamodbv2.AmazonDynamoDBClient;
com.amazonaws.services.dynamodbv2.document.DynamoDB;
com.amazonaws.services.dynamodbv2.document.Item;
com.amazonaws.services.dynamodbv2.document.ItemCollection;
com.amazonaws.services.dynamodbv2.document.Page;
com.amazonaws.services.dynamodbv2.document.QueryOutcome;
com.amazonaws.services.dynamodbv2.document.Table;
com.amazonaws.services.dynamodbv2.document.spec.QuerySpec;
com.amazonaws.services.dynamodbv2.document.utils.ValueMap;
Subject) {
Table table = dynamoDB.getTable(tableName);
String replyId = forumName + "#" + threadSubject;
QuerySpec spec = new QuerySpec()
.withKeyConditionExpression("Id = :v_id")
.withValueMap(new ValueMap()
.withString(":v_id", replyId));
ItemCollection<QueryOutcome> items = table.query(spec);
System.out.println("\nfindRepliesForAThread results:");
Iterator<Item> iterator = items.iterator();
while (iterator.hasNext()) {
System.out.println(iterator.next().toJSONPretty());
}
}
private static void findRepliesForAThreadSpecifyOptionalLimit(String forum
Name, String threadSubject) {
Table table = dynamoDB.getTable(tableName);
String replyId = forumName + "#" + threadSubject;
QuerySpec spec = new QuerySpec()
.withKeyConditionExpression("Id = :v_id")
.withValueMap(new ValueMap()
.withString(":v_id", replyId))
.withMaxPageSize(1);
ItemCollection<QueryOutcome> items = table.query(spec);
System.out.println("\nfindRepliesForAThreadSpecifyOptionalLimit res
ults:");
// Process each page of results
int pageNum = 0;
for (Page<Item, QueryOutcome> page : items.pages()) {
System.out.println("\nPage: " + ++pageNum);
// Process each item on the current page
Iterator<Item> item = page.iterator();
while (item.hasNext()) {
System.out.println(item.next().toJSONPretty());
}
}
}
private static void findRepliesInLast15DaysWithConfig(String forumName,
String threadSubject) {
Table table = dynamoDB.getTable(tableName);
while (iterator.hasNext()) {
System.out.println(iterator.next().toJSONPretty());
}
}
private static void findRepliesUsingAFilterExpression(String forumName,
String threadSubject) {
Table table = dynamoDB.getTable(tableName);
String replyId = forumName + "#" + threadSubject;
QuerySpec spec = new QuerySpec()
.withProjectionExpression("Message, ReplyDateTime, PostedBy")
.withKeyConditionExpression("Id = :v_id")
.withFilterExpression("PostedBy = :v_postedby")
.withValueMap(new ValueMap()
.withString(":v_id", replyId)
.withString(":v_postedby", "User B"));
ItemCollection<QueryOutcome> items = table.query(spec);
System.out.println("\nfindRepliesUsingAFilterExpression results:");
Iterator<Item> iterator = items.iterator();
while (iterator.hasNext()) {
System.out.println(iterator.next().toJSONPretty());
}
}
}
Note
This section explains the .NET SDK low-level API.The .NET SDK also provides a set of document
model classes (see .NET: Document Model (p. 446)) that wrap some of the low-level API to
simplify your coding tasks. In addition, the .NET SDK also provides a high-level object persistence
model (see .NET: Object Persistence Model (p. 477)), enabling you to map your client-side classes
to DynamoDB tables.
The following are the steps to query a table using low-level .NET SDK API.
1. Create an instance of the AmazonDynamoDBClient class.
2. Create an instance of the QueryRequest class and provide query operation parameters.
3. Execute the Query method and provide the QueryRequest object that you created in the preceding
step.
The response includes the QueryResult object that provides all items returned by the query.
API Version 2012-08-10
209
The following C# code snippet demonstrates the preceding tasks. The snippet assumes you have a Reply
table stores replies for forum threads. For more information, see Example Tables and Data (p. 678).
Reply ( Id, ReplyDateTime, ... )
Each forum thread has a unique ID and can have zero or more replies. Therefore, the primary key is
composed of both the Id (hash attribute) and ReplyDateTime (range attribute).
The following query retrieves all replies for a specific thread subject. The query requires both the table
name and the Subject value.
AmazonDynamoDBClient client = new AmazonDynamoDBClient();
var request = new QueryRequest
{
TableName = "Reply",
KeyConditionExpression = "Id = :v_Id",
ExpressionAttributeValues = new Dictionary<string, AttributeValue> {
{":v_Id", new AttributeValue { S = "Amazon DynamoDB#DynamoDB Thread
1" }}}
};
var response = client.Query(request);
foreach (Dictionary<string, AttributeValue> item in response.Items)
{
// Process the result.
PrintItem(item);
}
TableName = "Reply",
KeyConditionExpression = "Id = :v_Id and ReplyDateTime > :v_twoWeeksAgo",
ExpressionAttributeValues = new Dictionary<string, AttributeValue> {
{":v_Id", new AttributeValue { S = "Amazon DynamoDB#DynamoDB Thread
2" }},
{":v_twoWeeksAgo", new AttributeValue { S = twoWeeksAgoString }}
},
ProjectionExpression = "Subject, ReplyDateTime, PostedBy",
ConsistentRead = true
};
var response = client.Query(request);
foreach (Dictionary<string, AttributeValue> item in response.Items)
{
// Process the result.
PrintItem(item);
}
You can also optionally limit the page size, or the number of items per page, by adding the optional Limit
parameter. Each time you execute the Query method, you get one page of results that has the specified
number of items. To fetch the next page, you execute the Query method again by providing the primary
key value of the last item in the previous page so that the method can return the next set of items. You
provide this information in the request by setting the ExclusiveStartKey property. Initially, this property
can be null. To retrieve subsequent pages, you must update this property value to the primary key of the
last item in the preceding page.
The following C# code snippet queries the Reply table. In the request, it specifies the Limit and
ExclusiveStartKey optional parameters. The do/while loop continues to scan one page at time until
the LastEvaluatedKey returns a null value.
lastKeyEvaluated = response.LastEvaluatedKey;
} while (lastKeyEvaluated != null && lastKeyEvaluated.Count != 0);
In this C# code example, you execute variations of "Find replies for a thread "DynamoDB Thread 1" in
forum "DynamoDB".
Find replies for a thread.
Find replies for a thread. Specify the Limit query parameter to set page size.
This function illustrate the use of pagination to process multipage result. Amazon DynamoDB has a
page size limit and if your result exceeds the page size, you get only the first page of results. This
coding pattern ensures your code processes all the pages in the query result.
Find replies in the last 15 days.
Find replies in a specific date range.
Both of the preceding two queries shows how you can specify range key conditions to narrow query
results and use other optional query parameters.
Note
This section explains the .NET SDK low-level API.The .NET SDK also provides a set of document
model classes (see .NET: Document Model (p. 446)) that wrap some of the low-level API to
simplify your coding tasks. In addition, the .NET SDK also provides a high-level object persistence
model (see .NET: Object Persistence Model (p. 477)), enabling you to map your client-side classes
to DynamoDB tables. The individual object instances then map to items in a table.
For a code example that demonstrates query operations using the document model,
see Table.Query Method in the AWS SDK for .NET (p. 465). For a code example that demonstrates
query operations using the object persistence model, see Example: Query and Scan in DynamoDB
Using the AWS SDK for .NET Object Persistence Model (p. 506).
For step-by-step instructions to test the following sample, see Using the AWS SDK for .NET (p. 56).
using System;
using System.Collections.Generic;
using Amazon.DynamoDBv2;
using Amazon.DynamoDBv2.Model;
using Amazon.Runtime;
using Amazon.Util;
namespace com.amazonaws.codesamples
{
class LowLevelQuery
{
private static AmazonDynamoDBClient client = new AmazonDynamoDBClient();
try
{
// Query a specific forum and thread.
string forumName = "Amazon DynamoDB";
string threadSubject = "DynamoDB Thread 1";
FindRepliesForAThread(forumName, threadSubject);
FindRepliesForAThreadSpecifyOptionalLimit(forumName,
threadSubject);
FindRepliesInLast15DaysWithConfig(forumName, threadSubject);
FindRepliesPostedWithinTimePeriod(forumName, threadSubject);
string twoWeeksAgoString =
twoWeeksAgoDate.ToString(AWSSDKUtils.ISO8601DateFormat);
// Optional parameter.
ProjectionExpression = "Id, ReplyDateTime, PostedBy",
// Optional parameter.
ConsistentRead = true
};
lastKeyEvaluated = response.LastEvaluatedKey;
Console.ReadLine();
}
response.ConsumedCapacity.CapacityUnits);
foreach (Dictionary<string, AttributeValue> item in response.Items)
{
PrintItem(item);
}
Console.WriteLine("To continue, press Enter");
Console.ReadLine();
}
{
string attributeName = kvp.Key;
AttributeValue value = kvp.Value;
Console.WriteLine(
attributeName + " " +
(value.S == null ? "" : "S=[" + value.S + "]") +
(value.N == null ? "" : "N=[" + value.N + "]") +
(value.SS == null ? "" : "SS=[" + string.Join(",",
value.SS.ToArray()) + "]") +
(value.NS == null ? "" : "NS=[" + string.Join(",",
value.NS.ToArray()) + "]")
);
}
Con
sole.WriteLine("************************************************");
}
}
Each forum thread has a unique ID and can have zero or more replies. Therefore, the primary key is
made of both the Id (hash attribute) and ReplyDateTime (range attribute).
The following query retrieves all replies for a specific thread subject. The query requires the table name
and the Subject value.
Note
This code example assumes that you have already loaded data into DynamoDB for your account
by following the instructions in the Creating Tables and Loading Sample Data (p. 14) section.
Alternatively, you can load the data programmatically using the instructions in the Creating
Example Tables and Uploading Data Using the AWS SDK for PHP (p. 710) topic.
For step-by-step instructions to run the following example, see Running PHP Examples (p. 59).
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' #replace with your desired region
));
$response = $client->query(array(
'TableName' => 'Reply',
'KeyConditionExpression' => 'Id = :v_id',
'ExpressionAttributeValues' => array (
':v_id' => array('S' => 'Amazon DynamoDB#DynamoDB Thread 1')
)
));
print_r($response['Items']);
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' #replace with your desired region
));
date_default_timezone_set("UTC");
$sevenDaysAgo = date('Y-m-d H:i:s', strtotime('-7 days'));
$response = $client->query(array(
'TableName' => 'Reply',
'KeyConditionExpression' => 'Id = :v_id and ReplyDateTime >= :v_reply_dt',
'ExpressionAttributeValues' => array (
':v_id' => array('S' => 'Amazon DynamoDB#DynamoDB Thread 2'),
':v_reply_dt' => array('S' => $sevenDaysAgo)
),
// optional parameters
'ProjectionExpression' => 'Subject, ReplyDateTime, PostedBy',
'ConsistentRead' => true
));
print_r($response['Items']);
You can also optionally limit the page size, the number of items per page, by adding the Limit parameter.
Each time you execute the query function, you get one page of results with the specified number of
items. To fetch the next page you execute the query function again by providing primary key value of
the last item in the previous page so the method can return the next set of items. You provide this
information in the request by setting the ExclusiveStartKey property. Initially this property can be null.
For retrieving subsequent pages you must update this property value to the primary key of the last item
in the preceding page.
The following PHP example queries the Reply table for entries that are more than 14 days old. In the
request it specifies the Limit and ExclusiveStartKey optional parameters.
<?php
use Aws\DynamoDb\DynamoDbClient;
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' // replace with your desired region
));
date_default_timezone_set('UTC');
$fourteenDaysAgo = date('Y-m-d H:i:s', strtotime('-14 days'));
$tableName = 'Reply';
# The Query API is paginated. Issue the Query request multiple times.
do {
echo "Querying table $tableName" . PHP_EOL;
$request = array(
'TableName' => $tableName,
'KeyConditionExpression' => 'Id = :v_id and ReplyDateTime >=
:v_reply_dt',
'ExpressionAttributeValues' => array (
':v_id' => array('S' => 'Amazon DynamoDB#DynamoDB Thread 2'),
':v_reply_dt' => array('S' => $fourteenDaysAgo)
),
'ProjectionExpression' => 'Id, ReplyDateTime, Message, PostedBy',
'ConsistentRead' => true,
'Limit' => 1
);
# Add the ExclusiveStartKey if we got one back in the previous response
if(isset($response) && isset($response['LastEvaluatedKey'])) {
$request['ExclusiveStartKey'] = $response['LastEvaluatedKey'];
}
$response = $client->query($request);
foreach ($response['Items'] as $key => $value) {
echo 'Id: ' . $value['Id']['S'] .
PHP_EOL;
echo 'ReplyDateTime: ' . $value['ReplyDateTime']['S'] . PHP_EOL;
echo 'Message: ' . $value['Message']['S'] . PHP_EOL;
echo 'PostedBy: ' . $value['PostedBy']['S'] . PHP_EOL;
echo PHP_EOL;
}
# If there is no LastEvaluatedKey in the response, then
Scanning in DynamoDB
Topics
Scanning Using the AWS SDK for Java Document API (p. 223)
Scanning Using the AWS SDK for .NET Low-Level API (p. 231)
Scanning Using the AWS SDK for PHP Low-Level API (p. 241)
This section shows basic scans and their results.
Note
This section explains the AWS SDK for Java Document API.The AWS SDK for Java also provides
a high-level object persistence model, enabling you to map your client-side classes to DynamoDB
tables. This approach can reduce the amount of code you have to write. For more information,
see Java: Object Persistence Model.
The following are the steps to scan a table using the AWS SDK for Java Document API.
1. Create an instance of the AmazonDynamoDBClient class.
2. Create an instance of the ScanRequest class and provide scan parameter.
The only required parameter is the table name.
3. Execute the scan method and provide the ScanRequest object that you created in the preceding
step.
The following Reply table stores replies for forum threads.
The table maintains all the replies for various forum threads. Therefore, the primary key is composed of
both the Id (hash attribute) and ReplyDateTime (range attribute). The following Java code snippet scans
the entire table. The ScanRequest instance specifies the name of the table to scan.
You can also optionally limit the page size, or the number of items per page, by using the withLimit
method of the scan request. Each time you execute the scan method, you get one page of results that
has the specified number of items. To fetch the next page, you execute the scan method again by
providing the primary key value of the last item in the previous page so that the scan method can return
the next set of items.You provide this information in the request by using the withExclusiveStartKey
method. Initially, the parameter of this method can be null. To retrieve subsequent pages, you must update
this property value to the primary key of the last item in the preceding page.
The following Java code snippet scans the ProductCatalog table. In the request, the withLimit and
withExclusiveStartKey methods are used. The do/while loop continues to scan one page at time
until the getLastEvaluatedKey method of the result returns a value of null.
.withExclusiveStartKey(lastKeyEvaluated);
ScanResult result = client.scan(scanRequest);
for (Map<String, AttributeValue> item : result.getItems()){
printItem(item);
}
lastKeyEvaluated = result.getLastEvaluatedKey();
} while (lastKeyEvaluated != null);
Note
This section explains the AWS SDK for Java Document API.The AWS SDK for Java also provides
a high-level object persistence model, enabling you to map your client-side classes to DynamoDB
tables. This approach can reduce the amount of code you have to write. For more information,
see Java: Object Persistence Model.
For a code example that demonstrates scan operations using the object persistence model, see
Example: Query and Scan (p. 438).
Note
This code example assumes that you have already loaded data into DynamoDB for your account
by following the instructions in the Creating Tables and Loading Sample Data (p. 14) section.
Alternatively, you can load the data programmatically using the instructions in the Creating
Example Tables and Uploading Data Using the AWS SDK for Java (p. 684) topic.
For step-by-step instructions to run the following example, see Running Java Examples for
DynamoDB (p. 55).
// Copyright 2012-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
// Licensed under the Apache License, Version 2.0.
package com.amazonaws.codesamples.document;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import
import
import
import
import
import
import
com.amazonaws.auth.profile.ProfileCredentialsProvider;
com.amazonaws.services.dynamodbv2.AmazonDynamoDBClient;
com.amazonaws.services.dynamodbv2.document.DynamoDB;
com.amazonaws.services.dynamodbv2.document.Item;
com.amazonaws.services.dynamodbv2.document.ItemCollection;
com.amazonaws.services.dynamodbv2.document.ScanOutcome;
com.amazonaws.services.dynamodbv2.document.Table;
Note
This section explains the AWS SDK for Java Document API.The AWS SDK for Java also provides
a high-level object persistence model, enabling you to map your client-side classes to DynamoDB
tables. This approach can reduce the amount of code you have to write. For more information,
see Java: Object Persistence Model.
Note
This code example assumes that you have already loaded data into DynamoDB for your account
by following the instructions in the Creating Tables and Loading Sample Data (p. 14) section.
Alternatively, you can load the data programmatically using the instructions in the Creating
Example Tables and Uploading Data Using the AWS SDK for Java (p. 684) topic.
For step-by-step instructions to run the following example, see Running Java Examples for
DynamoDB (p. 55).
// Copyright 2012-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
// Licensed under the Apache License, Version 2.0.
package com.amazonaws.codesamples.document;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashSet;
import
import
import
import
import
java.util.Iterator;
java.util.List;
java.util.concurrent.ExecutorService;
java.util.concurrent.Executors;
java.util.concurrent.TimeUnit;
import
import
import
import
import
import
import
import
import
import
import
import
import
com.amazonaws.AmazonServiceException;
com.amazonaws.auth.profile.ProfileCredentialsProvider;
com.amazonaws.services.dynamodbv2.AmazonDynamoDBClient;
com.amazonaws.services.dynamodbv2.document.DynamoDB;
com.amazonaws.services.dynamodbv2.document.Item;
com.amazonaws.services.dynamodbv2.document.ItemCollection;
com.amazonaws.services.dynamodbv2.document.ScanOutcome;
com.amazonaws.services.dynamodbv2.document.Table;
com.amazonaws.services.dynamodbv2.document.spec.ScanSpec;
com.amazonaws.services.dynamodbv2.model.AttributeDefinition;
com.amazonaws.services.dynamodbv2.model.KeySchemaElement;
com.amazonaws.services.dynamodbv2.model.KeyType;
com.amazonaws.services.dynamodbv2.model.ProvisionedThroughput;
catch (Exception e) {
} catch (Exception e) {
System.err.println("Failed to create table " + tableName);
e.printStackTrace(System.err);
}
}
private static void shutDownExecutorService(ExecutorService executor) {
executor.shutdown();
try {
if (!executor.awaitTermination(10, TimeUnit.SECONDS)) {
executor.shutdownNow();
}
} catch (InterruptedException e) {
executor.shutdownNow();
// Preserve interrupt status
Thread.currentThread().interrupt();
}
}
}
Note
This section explains the .NET SDK low-level API.The .NET SDK also provides a set of document
model classes (see .NET: Document Model (p. 446)) that wrap some of the low-level API to
simplify your coding tasks. In addition, the .NET SDK also provides a high-level object persistence
model (see .NET: Object Persistence Model (p. 477)), enabling you to map your client-side classes
to DynamoDB tables.
The following are the steps to scan a table using the AWS SDK for NET low-level API:
1. Create an instance of the AmazonDynamoDBClient class.
2. Create an instance of the ScanRequest class and provide scan operation parameters.
The only required parameter is the table name.
3. Execute the Scan method and provide the QueryRequest object that you created in the preceding
step.
The table maintains all the replies for various forum threads. Therefore, the primary key is composed of
both the Id (hash attribute) and ReplyDateTime (range attribute). The following C# code snippet scans
the entire table. The ScanRequest instance specifies the name of the table to scan.
AmazonDynamoDBClient client = new AmazonDynamoDBClient();
var request = new ScanRequest
{
TableName = "Reply",
};
var response = client.Scan(request);
var result = response.ScanResult;
foreach (Dictionary<string, AttributeValue> item in response.ScanResult.Items)
{
// Process the result.
PrintItem(item);
}
You can also optionally limit the page size, or the number of items per page, by adding the optional Limit
parameter. Each time you execute the Scan method, you get one page of results that has the specified
number of items. To fetch the next page, you execute the Scan method again by providing the primary
key value of the last item in the previous page so that the Scan method can return the next set of items.
You provide this information in the request by setting the ExclusiveStartKey property. Initially, this
property can be null. To retrieve subsequent pages, you must update this property value to the primary
key of the last item in the preceding page.
The following C# code snippet scans the ProductCatalog table. In the request, it specifies the Limit and
ExclusiveStartKey optional parameters. The do/while loop continues to scan one page at time until
the LastEvaluatedKey returns a null value.
Dictionary<string, AttributeValue> lastKeyEvaluated = null;
do
{
var request = new ScanRequest
{
TableName = "ProductCatalog",
Limit = 10,
ExclusiveStartKey = lastKeyEvaluated
};
var response = client.Scan(request);
foreach (Dictionary<string, AttributeValue> item
in response.Items)
{
PrintItem(item);
}
lastKeyEvaluated = response.LastEvaluatedKey;
} while (lastKeyEvaluated != null && lastKeyEvaluated.Count != 0);
Note
This section explains the .NET SDK low-level API.The .NET SDK also provides a set of document
model classes (see .NET: Document Model (p. 446)) that wrap some of the low-level API to
simplify your coding tasks. In addition, the .NET SDK also provides a high-level object persistence
model (see .NET: Object Persistence Model (p. 477)), enabling you to map your client-side classes
to DynamoDB tables. The individual object instances then map to items in a table.
For a code example that demonstrates scan operations using the document model classes,
see Example: Scan using the Table.Scan method (p. 474). For a code example that demonstrates
scan operations using the object persistence model, see Example: Query and Scan in DynamoDB
Using the AWS SDK for .NET Object Persistence Model (p. 506).
For step-by-step instructions to test the following sample, see Using the AWS SDK for .NET (p. 56).
using System;
using System.Collections.Generic;
using Amazon.DynamoDBv2;
using Amazon.DynamoDBv2.Model;
using Amazon.Runtime;
namespace com.amazonaws.codesamples
{
class LowLevelScan
{
private static AmazonDynamoDBClient client = new AmazonDynamoDBClient();
Console.ReadLine();
}
catch (Exception e) {
Console.WriteLine(e.Message);
Console.WriteLine("To continue, press Enter");
Console.ReadLine();
}
}
{
TableName = "ProductCatalog",
Limit = 2,
ExclusiveStartKey = lastKeyEvaluated,
ExpressionAttributeValues = new Dictionary<string,Attribute
Value> {
{":val", new AttributeValue { N = "0" }}
},
FilterExpression = "Price < :val",
{
string attributeName = kvp.Key;
AttributeValue value = kvp.Value;
Console.WriteLine(
attributeName + " " +
(value.S == null ? "" : "S=[" + value.S + "]") +
(value.N == null ? "" : "N=[" + value.N + "]") +
(value.SS == null ? "" : "SS=[" + string.Join(",",
value.SS.ToArray()) + "]") +
(value.NS == null ? "" : "NS=[" + string.Join(",",
value.NS.ToArray()) + "]")
);
}
Con
sole.WriteLine("************************************************");
}
}
}
Note
This section explains the .NET SDK low-level API.The .NET SDK also provides a set of document
model classes (see .NET: Document Model (p. 446)) that wrap some of the low-level API to
simplify your coding tasks. In addition, the .NET SDK also provides a high-level object persistence
model (see .NET: Object Persistence Model (p. 477)), enabling you to map your client-side classes
to DynamoDB tables. The individual object instances then map to items in a table.
For step-by-step instructions to test the following sample, see Using the AWS SDK for .NET (p. 56).
using
using
using
using
using
using
using
System;
System.Collections.Generic;
System.Threading;
System.Threading.Tasks;
Amazon.DynamoDBv2;
Amazon.DynamoDBv2.Model;
Amazon.Runtime;
namespace com.amazonaws.codesamples
{
class LowLevelParallelScan
{
private static AmazonDynamoDBClient client = new AmazonDynamoDBClient();
private
private
private
private
static
static
static
static
}
Console.WriteLine("All scan tasks are created, waiting for them to
complete.");
Task.WaitAll(tasks);
Console.WriteLine("All scan tasks are completed.");
}
private static void ScanSegment(int totalSegments, int segment)
{
Console.WriteLine("*** Starting to Scan Segment {0} of {1} out of
{2} total segments ***", segment, tableName, totalSegments);
Dictionary<string, AttributeValue> lastEvaluatedKey = null;
int totalScannedItemCount = 0;
int totalScanRequestCount = 0;
do
{
var request = new ScanRequest
{
TableName = tableName,
Limit = scanItemLimit,
ExclusiveStartKey = lastEvaluatedKey,
Segment = segment,
TotalSegments = totalSegments
};
var response = client.Scan(request);
lastEvaluatedKey = response.LastEvaluatedKey;
totalScanRequestCount++;
totalScannedItemCount += response.ScannedCount;
foreach (var item in response.Items)
{
Console.WriteLine("Segment: {0}, Scanned Item with Title:
{1}", segment, item["Title"].S);
}
} while (lastEvaluatedKey.Count != 0);
Console.WriteLine("*** Completed Scan Segment {0} of {1}. TotalScan
RequestCount: {2}, TotalScannedItemCount: {3} ***", segment, tableName,
totalScanRequestCount, totalScannedItemCount);
}
private static void UploadExampleData()
{
Console.WriteLine("\n*** Uploading {0} Example Items to {1}
Table***", exampleItemCount, tableName);
Console.Write("Uploading Items: ");
for (int itemIndex = 0; itemIndex < exampleItemCount; itemIndex++)
{
Console.Write("{0}, ", itemIndex);
CreateItem(itemIndex.ToString());
}
Console.WriteLine();
}
private static void CreateItem(string itemIndex)
{
var request = new PutItemRequest
{
TableName = tableName,
Item = new Dictionary<string, AttributeValue>()
{
{ "Id", new AttributeValue { N = itemIndex }},
{ "Title", new AttributeValue { S = "Book " + itemIndex + "
Title" }},
{ "ISBN", new AttributeValue { S = "11-11-11-11" }},
{ "Authors", new AttributeValue { SS = new List<string>{"Au
thor1", "Author2" }}},
{ "Price", new AttributeValue { N = "20.00" }},
{ "Dimensions", new AttributeValue { S = "8.5x11.0x.75" }},
{ "InPublication", new AttributeValue { BOOL = false } }
}
};
client.PutItem(request);
}
private static void CreateExampleTable()
{
Console.WriteLine("\n*** Creating {0} Table ***", tableName);
var request = new CreateTableRequest
{
AttributeDefinitions = new List<AttributeDefinition>()
{
new AttributeDefinition
{
AttributeName = "Id",
AttributeType = "N"
}
},
KeySchema = new List<KeySchemaElement>
{
new KeySchemaElement
{
AttributeName = "Id",
KeyType = "HASH"
}
},
ProvisionedThroughput = new ProvisionedThroughput
{
ReadCapacityUnits = 5,
WriteCapacityUnits = 6
},
TableName = tableName
};
var response = client.CreateTable(request);
var result = response;
var tableDescription = result.TableDescription;
Console.WriteLine("{1}: {0} \t ReadsPerSec: {2} \t WritesPerSec:
{3}",
tableDescription.TableStatus,
tableDescription.TableName,
tableDescription.ProvisionedThroughput.ReadCapacity
Units,
tableDescription.ProvisionedThroughput.WriteCapa
cityUnits);
string status = tableDescription.TableStatus;
Console.WriteLine(tableName + " - " + status);
WaitUntilTableReady(tableName);
}
private static void DeleteExampleTable()
{
try
{
Console.WriteLine("\n*** Deleting {0} Table ***", tableName);
var request = new DeleteTableRequest
{
TableName = tableName
};
var response = client.DeleteTable(request);
var result = response;
Console.WriteLine("{0} is being deleted...", tableName);
WaitUntilTableDeleted(tableName);
}
catch (ResourceNotFoundException)
{
Console.WriteLine("{0} Table delete failed: Table does not ex
ist", tableName);
}
}
private static void WaitUntilTableReady(string tableName)
{
string status = null;
// Let us wait until table is created. Call DescribeTable.
do
{
System.Threading.Thread.Sleep(5000); // Wait 5 seconds.
try
{
var res = client.DescribeTable(new DescribeTableRequest
{
TableName = tableName
});
Console.WriteLine("Table name: {0}, status: {1}",
res.Table.TableName,
res.Table.TableStatus);
status = res.Table.TableStatus;
}
catch (ResourceNotFoundException)
{
// DescribeTable is eventually consistent. So you might
// get resource not found. So we handle the potential excep
tion.
}
The table maintains all the replies for various forum threads. Therefore, the primary key is made of both
the Id (hash attribute) and ReplyDateTime (range attribute). The following PHP code snippet scans the
table.
Note
This code example assumes that you have already loaded data into DynamoDB for your account
by following the instructions in the Creating Tables and Loading Sample Data (p. 14) section.
Alternatively, you can load the data programmatically using the instructions in the Creating
Example Tables and Uploading Data Using the AWS SDK for PHP (p. 710) topic.
For step-by-step instructions to run the following example, see Running PHP Examples (p. 59).
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' #replace with your desired region
));
$response = $client->scan(array(
'TableName' => 'Reply'
));
foreach ($response['Items'] as $key => $value) {
echo 'Id: ' . $value['Id']['S'] .
PHP_EOL;
echo 'ReplyDateTime: ' . $value['ReplyDateTime']['S'] . PHP_EOL;
echo 'Message: ' . $value['Message']['S'] . PHP_EOL;
echo 'PostedBy: ' . $value['PostedBy']['S'] . PHP_EOL;
echo PHP_EOL;
}
The scan operation response is a Guzzle\Service\Resource\Model object. You can perform operations
on the object contents. For example, the following code snippet scans the ProductCatalog table, and
prints the product Id and Title values.
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' #replace with your desired region
));
$response = $client->scan(array(
"TableName" => "ProductCatalog"
));
foreach ($response['Items'] as $key => $value) {
echo "<p><strong>Item Number:</strong>". $value['Id']['N'] . "</p>";
echo "<br><strong>Item Name: </strong>". $value['Title']['S'] ."</p>";
}
FilterExpression to retrieve only the items priced less than 0 (error condition).
ProjectionExpression to specify the attributes to retrieve for items in the query results
The following PHP code snippet scans the ProductCatalog table to find all items priced less than 0.
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' #replace with your desired region
));
$response = $client->scan(array(
'TableName' => 'ProductCatalog',
'ProjectionExpression' => 'Id, Price',
'ExpressionAttributeValues' => array (
':val1' => array('N' => '0')) ,
'FilterExpression' => 'Price < :val1',
));
foreach ($response['Items'] as $key => $value) {
echo 'Id: ' . $value['Id']['N'] . ' Price: ' . $value['Price']['N'] . PHP_EOL;
echo PHP_EOL;
}
You can also optionally limit the page size, the number of items per page, by adding the optional Limit
parameter. Each time you execute the scan function, you get one page of results with a specified number
of items. To fetch the next page you execute the scan function again by providing primary key value of
the last item in the previous page so the scan function can return the next set of items. You provide this
information in the request by setting the ExclusiveStartKey property. Initially this property can be null.
For retrieving subsequent pages you must update this property value to the primary key of the last item
in the preceding page.
The following PHP code snippet scans the ProductCatalog table. In the request it specifies the Limit
and ExclusiveStartKey optional parameters.
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' #replace with your desired region
));
$tableName = 'ProductCatalog';
# The Scan API is paginated. Issue the Scan request multiple times.
do {
echo "Scanning table $tableName" . PHP_EOL;
$request = array(
'TableName' => $tableName,
'ExpressionAttributeValues' => array (
':val1' => array('N' => '201')
) ,
'FilterExpression' => 'Price < :val1',
'Limit' => 2
);
Note
For step-by-step instructions to run these code examples, see Running PHP Examples (p. 59).
<?php
use Aws\DynamoDb\DynamoDbClient;
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' // replace with your desired region
));
$tableName = 'ProductCatalog';
// Delete an old DynamoDB table
echo "Deleting the table...\n";
$response = $client->deleteTable(array(
'TableName' => $tableName
));
$client->waitUntilTableNotExists(array('TableName' => $tableName));
echo "The table {$tableName} has been deleted.\n";
// Create a new DynamoDB table
echo "# Creating table $tableName..." . PHP_EOL;
$response = $client->createTable(array(
'TableName' => $tableName,
'AttributeDefinitions' => array(
array(
'AttributeName' => 'Id',
'AttributeType' => 'N'
)
),
'KeySchema' => array(
array(
'AttributeName' => 'Id',
'KeyType'
=> 'HASH'
)
),
'ProvisionedThroughput' => array(
'ReadCapacityUnits' => 5,
'WriteCapacityUnits' => 6
)
));
$client->waitUntilTableExists(array('TableName' => $tableName));
echo "Table {$tableName} has been created.\n";
// Populate DynamoDB table
echo "# Populating Items to $tableName...\n";
for ($i = 1; $i <= 100; $i++) {
$response = $client->putItem(array(
'TableName' => $tableName,
'Item' => array(
'Id'
=> array( 'N'
'Title'
=> array( 'S'
'ISBN'
=> array( 'S'
'Price'
=> array( 'N'
'Authors' => array( 'SS' =>
)
));
$response = $client->getItem(array(
'TableName' => 'ProductCatalog',
'Key' => array(
'Id' => array( 'N' => $i )
)
));
echo "Item populated: {$response['Item']['Title']['S']}\n";
sleep(1);
}
echo "{$tableName} is populated with items.\n";
?>
Note
Before you run this program, you will need to populate the ProductTable with data. For more
details, see Example - Loading Data Using PHP (p. 244).
For step-by-step instructions to run these code examples, see Running PHP Examples (p. 59).
<?php
use Aws\DynamoDb\DynamoDbClient;
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' // replace with your desired region
));
$tableName = 'ProductCatalog';
$params = array (
'TableName' => $tableName,
'ExpressionAttributeValues' => array (
':val1' => array('S' => 'Book')
) ,
'FilterExpression' => 'contains (Title, :val1)',
'Limit' => 10
);
// Execute scan operations until the entire table is scanned
$count = 0;
do {
$response = $client->scan ( $params );
$items = $response->get ( 'Items' );
$count = $count + count ( $items );
// Do something with the $items
foreach ( $items as $item ) {
echo "Scanned item with Title \"{$item['Title']['S']}\".\n";
}
// Set parameters for next scan
$params ['ExclusiveStartKey'] = $response ['LastEvaluatedKey'];
} while ( $params ['ExclusiveStartKey'] );
echo "{$tableName} table scanned completely. {$count} items found.\n";
?>
Note
Before you run this program, you will need to populate the ProductTable with data. For more
details, see Example - Loading Data Using PHP (p. 244).
For step-by-step instructions to run these code examples, see Running PHP Examples (p. 59).
<?php
use Aws\DynamoDb\DynamoDbClient;
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' // replace with your desired region
));
$tableName = 'ProductCatalog';
$totalSegments = 5;
$params = array(
'TableName' => $tableName,
'ExpressionAttributeValues' => array (
':val1' => array('S' => 'Book')
) ,
'FilterExpression' => 'contains (Title, :val1)',
'Limit' => 10,
'TotalSegments' => $totalSegments
);
// Create initial scan commands for each segment
$pendingScanCommands = array();
for ($segment = 0; $segment < $totalSegments; $segment++) {
$params['Segment'] = $segment;
$pendingScanCommands[] = $client->getCommand('Scan', $params);
}
// Execute scan operations in parallel until the entire table is scanned
while(count($pendingScanCommands) > 0) {
// Executes the 5 scan operations in parallel using cURL multi handles
$completedScanCommands = $client->execute($pendingScanCommands);
$pendingScanCommands = array();
// Process responses of each scan command
foreach ($completedScanCommands as $scanCommand) {
$response = $scanCommand->getResult();
$segment = $scanCommand->getPath('Segment');
$items = $response->get('Items');
// Do something with the items
foreach($items as $item) {
echo "Scanned item with Title \"{$item['Title']['S']}\" and Segment
\"{$segment}\".\n";
}
// If LastEvaluatedKey is present we should continue scanning this
segment
// Otherwise we've reached to end of this segment
if ($response['LastEvaluatedKey']) {
echo "LastEvaluatedKey found creating new scan command for Segment:
{$segment}.\n";
$params['Segment'] = $segment;
$params['ExclusiveStartKey'] = $response['LastEvaluatedKey'];
$pendingScanCommands[] = $client->getCommand('Scan', $params);
} else {
echo "Segment: {$segment} scanned completely!\n";
}
}
}
echo "Table {$tableName} scanned completely.\n";
?>
You should consider your application's requirements when you determine which type of index to use. The
following table shows the main differences between a global secondary index and a local secondary
index:
Characteristic
Key Schema
- coL
l a
- ceS
- dno
yra
-n I
x ed
Characteristic
Key Attributes
The index hash key and range key (if present) can
e hT
be any scalar table attributes.
hsah
yek
f o
eh t
-n i
x ed
s i
eh t
ema s
- ta
-bi r t
etu
s a
eh t
hsah
yek
f o
eh t
.elbat
e hT
egnar
yek
na c
e b
y na
- lacs
r a
elbat
- ta
-bi r t
. etu
- coL
l a
- ceS
- dno
yra
-n I
x ed
Characteristic
- coL
l a
- ceS
- dno
yra
-n I
x ed
Characteristic
- coL
l a
- ceS
- dno
yra
-n I
x ed
Characteristic
- coL
l a
- ceS
- dno
yra
-n I
x ed
- coL
l a
- ces
- dno
yra
-n i
sexed
era
-er c
de t a
t a
eh t
ema s
emi t
taht
uo y
-er c
eta
a
.elbat
uoY
- nac
t on
dda
a
-co l
l a
- ces
- dno
yra
-n i
x ed
o t
n a
- xe
- tsi
gn i
,elbat
r on
na c
uo y
- ed
ete l
y na
-co l
l a
- ces
- dno
yra
Characteristic
- coL
l a
- ceS
- dno
yra
-n I
x ed
-n i
sexed
taht
- ruc
yl tner
- xe
. tsi
Characteristic
- coL
l a
- ceS
- dno
yra
-n I
x ed
Read Consistency
n e hW
uo y
yreuq
a
-co l
l a
- ces
- dno
yra
-n i
, xed
uo y
na c
esoohc
reht ie
-neve
-u t
l a
- noc
- tsis
ycne
r o
gnor ts
- noc
- tsis
. ycne
Characteristic
Every global secondary index has its own provisioned throughput settings for read and write
activity. Queries or scans on a global secondary
index consume capacity units from the index, not
from the table. The same holds true for global
secondary index updates due to table writes.
- coL
l a
- ceS
- dno
yra
-n I
x ed
Characteristic
- coL
l a
- ceS
- dno
yra
-n I
x ed
- reuQ
se i
r o
snacs
n o
a
-co l
l a
- ces
- dno
yra
-n i
x ed
- noc
emu s
dae r
- ac
- ap
yt i c
st inu
mo r f
eh t
.elbat
n e hW
uo y
et i rw
o t
a
,elbat
st i
-co l
l a
- ces
- dno
yra
-n i
sexed
era
os l a
- pu
;detad
eseht
- pu
setad
- noc
emu s
et i rw
- ac
- ap
Characteristic
- coL
l a
- ceS
- dno
yra
-n I
x ed
yt i c
st inu
mo r f
eh t
.elbat
Characteristic
Projected Attributes
- coL
l a
- ceS
- dno
yra
-n I
x ed
If you want to create more than one table with secondary indexes, you must do so sequentially. For
example, you would create the first table and wait for it to become ACTIVE, create the next table and wait
for it to become ACTIVE, and so on. If you attempt to concurrently create more than one table with a
secondary index, DynamoDB will return a LimitExceededException.
For each secondary index, you must specify the following:
The type of index to be created either a global secondary index or a local secondary index.
A name for the index. The naming rules for indexes are the same as those for tables, as listed in Limits
in DynamoDB (p. 664). The name must be unique for the table it is associated with, but you can use the
same name for indexes that are associated with different tables.
The key schema for the index. Every attribute in the index key schema must be a top-level attribute of
type String, Number, or Binary. Nested attributes and multi-valued sets are not allowed. Other
requirements for the key schema depend on the type of index:
For a global secondary index, the hash key can be any table attribute. A range key is optional, and
it too can be any table attribute.
For a local secondary index, the hash key must be the same as the table's hash key, and the range
key must be a non-key table attribute.
Additional attributes, if any, to project from the table into the index. These attributes are in addition to
the table key attributes, which are automatically projected into every index. You can project attributes
of any data type, including scalar data types and multi-valued sets.
The provisioned throughput settings for the index, if necessary:
For a global secondary index, you must specify read and write capacity unit settings.These provisioned
throughput settings are independent of the table's settings.
For a local secondary index, you do not need to specify read and write capacity unit settings. Any
read and write operations on a local secondary index draw from the provisioned throughput settings
of its parent table.
For maximum query flexibility, you can create up to 5 global secondary indexes and up to 5 local secondary
indexes per table.
To get a detailed listing of secondary indexes on a table, use the DescribeTable action. DescribeTable
will return the name, storage size and item counts for every secondary index on the table. These values
are not updated in real time, but they are refreshed approximately every six hours.
You can access the data in a secondary index using either the Query or Scan operation.You must specify
the name of the table and the name of the index that you want to use, the attributes to be returned in the
results, and any condition expressions or filters that you want to apply. DynamoDB can return the results
in ascending or descending order.
When you delete the table, all of the indexes associated with that table are also deleted.
Now suppose that you wanted to write a leaderboard application to display top scores for each game. A
query that specified the key attributes (UserId and GameTitle) would be very efficient; however, if the
application needed to retrieve data from GameScores based on GameTitle only, it would need to use a
Scan operation. As more items are added to the table, scans of all the data would become slow and
inefficient, making it difficult to answer questions such as these:
What is the top score ever recorded for the game Meteor Blasters?
Which user had the highest score for Galaxy Invaders?
What was the highest ratio of wins vs. losses?
To speed up queries on non-key attributes, you can create a global secondary index. A global secondary
index contains a selection of attributes from the table, but they are organized by a primary key that is
different from that of the table. The index key does not need to have any of the key attributes from the
table; it doesn't even need to have the same key schema as a table.
For example, you could create a global secondary index named GameTitleIndex, with a hash key of
GameTitle and a range key of TopScore. Since the table's primary key attributes are always projected
into an index, the UserId attribute is also present. The following diagram shows what GameTitleIndex
index would look like:
Now you can query GameTitleIndex and easily obtain the scores for Meteor Blasters. The results are
ordered by the range key, TopScore. If you set the ScanIndexForward parameter to false, the results
are returned in descending order, so the highest score is returned first.
Every global secondary index must have a hash key, and can have an optional range key. The index key
schema can be different from the table schema; you could have a table with a hash type primary key,
and create a global secondary index with a hash-and-range index key or vice-versa. The index key
attributes can consist of any attributes from the table, as long as the data types are scalar rather than
multi-value sets.
You can project other table attributes into the index if you want. When you query the index, DynamoDB
can retrieve these projected attributes efficiently; however, global secondary index queries cannot fetch
attributes from the parent table. For example, if you queried GameTitleIndex, as shown in the diagram
above, the query would not be able to access any attributes other than GameTitle and TopScore.
In a DynamoDB table, each key value must be unique. However, the key values in a global secondary
index do not need to be unique. To illustrate, suppose that a game named Comet Quest is especially
difficult, with many new users trying but failing to get a score above zero. Here is some data that we could
use to represent this:
UserId
GameTitle
TopScore
123
Comet Quest
201
Comet Quest
301
Comet Quest
When this data is added to the GameScores table, DynamoDB will propagate it to GameTitleIndex. If we
then query the index using Comet Quest for GameTitle and 0 for TopScore, the following data is returned:
Only the items with the specified key values appear in the response; within that set of data, the items are
in no particular order.
A global secondary index only keeps track of data items where its key attribute(s) actually exist. For
example, suppose that you added another new item to the GameScores table, but only provided the
required primary key attributes:
UserId
GameTitle
400
Comet Quest
Because you didn't specify the TopScore attribute, DynamoDB would not propagate this item to
GameTitleIndex. Thus, if you queried GameScores for all the Comet Quest items, you would get the
following four items:
A similar query on GameTitleIndex would still return three items, rather than four. This is because the
item with the nonexistent TopScore is not propagated to the index:
Attribute Projections
A projection is the set of attributes that is copied from a table into a secondary index. The hash and range
keys of the table are always projected into the index; you can project other attributes to support your
application's query requirements. When you query an index, Amazon DynamoDB can access any attribute
in the projection as if those attributes were in a table of their own.
When you create a secondary index, you need to specify the attributes that will be projected into the
index. DynamoDB provides three different options for this:
KEYS_ONLY Each item in the index consists only of the table hash and range key values, plus the
index key values. The KEYS_ONLY option results in the smallest possible secondary index.
API Version 2012-08-10
264
INCLUDE In addition to the attributes described in KEYS_ONLY, the secondary index will include other
non-key attributes that you specify.
ALL The secondary index includes all of the attributes from the source table. Because all of the table
data is duplicated in the index, an ALL projection results in the largest possible secondary index.
In the diagram above, GameTitleIndex does not have any additional projected attributes. An application
can use GameTitle and TopScore in queries; however, it is not possible to efficiently determine which
user has the highest score for a particular game, or the highest ratio of wins vs. losses. The most efficient
way to support queries on this data would be to project these attributes from the table into the global
secondary index, as shown in this diagram:
Because the non-key attributes Wins and Losses are projected into the index, an application can determine
the wins vs. losses ratio for any game, or for any combination of game and user ID.
When you choose the attributes to project into a global secondary index, you must consider the tradeoff
between provisioned throughput costs and storage costs:
If you need to access just a few attributes with the lowest possible latency, consider projecting only
those attributes into a global secondary index. The smaller the index, the less that it will cost to store
it, and the less your write costs will be.
If your application will frequently access some non-key attributes, you should consider projecting those
attributes into a global secondary index. The additional storage costs for the global secondary index
will offset the cost of performing frequent table scans.
If you need to access most of the non-key attributes on a frequent basis, you can project these
attributesor even the entire source table into a global secondary index. This will give you maximum
flexibility; however, your storage cost would increase, or even double.
If your application needs to query a table infrequently, but must perform many writes or updates against
the data in the table, consider projecting KEYS_ONLY. The global secondary index would be of minimal
size, but would still be available when needed for query activity.
{
"TableName": "GameScores",
"IndexName": "GameTitleIndex",
"KeyConditionExpression": "GameTitle = :v_title",
"ExpressionAttributeValues": {
":v_title": {"S": "Meteor Blasters"}
},
"ProjectionExpression": "UserId, TopScore",
"ScanIndexForward": false
}
In this query:
DynamoDB accesses GameTitleIndex, using the GameTitle hash key to locate the index items for
Meteor Blasters. All of the index items with this key are stored adjacent to each other for rapid retrieval.
Within this game, DynamoDB uses the index to access all of the user IDs and top scores for this game.
The results are returned, sorted in descending order because the ScanIndexForward parameter is
set to false.
When you put or delete items in a table, the global secondary indexes on that table are updated in an
eventually consistent fashion. Changes to the table data are propagated to the global secondary indexes
within a fraction of a second, under normal conditions. However, in some unlikely failure scenarios, longer
propagation delays might occur. Because of this, your applications need to anticipate and handle situations
where a query on a global secondary index returns results that are not up-to-date.
If you write an item to a table, you don't have to specify the attributes for any global secondary index
range key. Using GameTitleIndex as an example, you would not need to specify a value for the TopScore
attribute in order to write a new item to the GameScores table. In this case, Amazon DynamoDB does
not write any data to the index for this particular item.
A table with many global secondary indexes will incur higher costs for write activity than tables with fewer
indexes. For more information, see Provisioned Throughput Considerations for Global Secondary
Indexes (p. 267).
If a table contains an item where a particular attribute is not defined, but that attribute is defined as an
index hash key or range key, then DynamoDB does not write any data for that item to the index.
Note
You cannot cancel an in-flight global secondary index creation.
Note
During the backfilling phase, some writes of violating items may succeed while others will
be rejected. After backfilling, all writes to items that violate the new index's key schema will
be rejected. We recommend that you run the Violation Detector tool after the backfill phase
completes, to detect and resolve any key violations that may have occurred. For more
information, see Detecting and Correcting Index Key Violations (p. 272).
While the resource allocation and backfilling phases are in progress, the index is in the CREATING state.
During this time, DynamoDB performs read operations on the table; you will not be charged for this read
activity.
When the index build is complete, its status changes to ACTIVE. You will not be able to Query or Scan
the index until it is ACTIVE.
Note
In some cases, DynamoDB will not be able to write data from the table to the index due to index
key violations. This can occur if the data type of an attribute value does not match the data type
of an index key schema data type, or if the size of an attribute exceeds the maximum length for
an index key attribute. Index key violations do not interfere with global secondary index creation;
however, when the index becomes ACTIVE, the violating keys will not be present in the index.
DynamoDB provides a standalone tool for finding and resolving these issues. For more
information, see Detecting and Correcting Index Key Violations (p. 272).
If you are adding a global secondary index to a very large table, it might take a long time for the creation
process to complete. To monitor progress and determine whether the index has sufficient write capacity,
consult the following Amazon CloudWatch metrics:
OnlineIndexPercentageProgress
OnlineIndexConsumedWriteCapacity
OnlineIndexThrottleEvents
Note
For more information on CloudWatch metrics related to DynamoDB, see DynamoDB
Metrics (p. 579).
If the provisioned write throughput setting on the index is too low, the index build will take longer to
complete. To shorten the time it takes to build a new global secondary index, you can increase its
provisioned write capacity temporarily.
Note
As a general rule, we recommend setting the provisioned write capacity of the index to 1.5 times
the write capacity of the table. This is a good setting for many use cases; however, your actual
requirements may be higher or lower.
While an index is being backfilled, DynamoDB uses internal system capacity to read from the table. This
is to minimize the impact of the index creation and to assure that your table does not run out of read
capacity.
However, it is possible that the volume of incoming write activity might exceed the provisioned write
capacity of the index. This is a bottleneck scenario, in which the index creation takes more time because
the write activity to the index is throttled. During the index build, we recommend that you monitor the
Amazon CloudWatch metrics for the index to determine whether its consumed write capacity is exceeding
its provisioned capacity. In a bottleneck scenario, you should increase the provisioned write capacity on
the index to avoid write throttling during the backfill phase.
After the index has been created, you should set its provisioned write capacity to reflect the normal usage
of your application.
Note
For indexes that were created as part of a CreateTable operation, the Backfilling attribute
does not appear in the DescribeTable output. For more information, see Phases of Index
Creation (p. 270).
Note
When you delete a table using the DeleteTable action, all of the global secondary indexes on
that table are also deleted.
There is a data type mismatch between an attribute value and the index key schema data type. For
example, suppose one of the items in the GameScores table had a TopScore value of type String. If
you added a global secondary index with a hash key of TopScore, of type Number, the item from the
table would violate the index key.
An attribute value from the table exceeds the maximum length for an index key attribute. The maximum
length of a hash key is 2048 bytes, and the maximum length of a range key is 1024 bytes. If any of the
corresponding attribute values in the table exceed these limits, the item from the table would violate
the index key.
If an index key violation occurs, the backfill phase continues without interruption; however, any violating
items are not included in the index. After the backfill phase completes, all writes to items that violate the
new index's key schema will be rejected.
To identify and fix attribute values in a table that violate an index key, use the Violation Detector tool. To
run Violation Detector, you create a configuration file that specifies the name of a table to be scanned,
the names and data types of the global secondary index hash and range keys, and what actions to take
if any index key violations are found. Violation Detector can run in one of two different modes:
Detection modedetect index key violations. Use detection mode to report the items in the table that
would cause key violations in a global secondary index. (You can optionally request that these violating
table items be deleted immediately when they are found.) The output from detection mode is written
to a file, which you can use for further analysis.
Correction mode correct index key violations. In correction mode, Violation Detector reads an input
file with the same format as the output file from detection mode. Correction mode reads the records
from the input file and, for each record, it either deletes or updates the corresponding items in the table.
(Note that if you choose to update the items, you must edit the input file and set appropriate values for
these updates.)
Description
- eR
?der iuq
awsCredentialsFile
dynamoDBRegion
tableName
gsiHashKeyName
seY
gsiHashKeyType
The data type of the index hash key attributeString, Number, or Binary:
seY
S | N | B
gsiRangeKeyName
gsiRangeKeyType
The data type of the index range key attributeString, Number, or Binary:
o N
S | N | B
recordGsiValueInViolationRecord
Parameter Name
Description
- eR
?der iuq
detectionOutputPath
numOfViolations
numOfRecords
readWriteIOPSPercent
Parameter Name
Description
- eR
?der iuq
correctionInputPath
correctionOutputPath
Detection
To detect index key violations, use Violation Detector with the --detect command line option. To show
how this option works, consider the ProductCatalog table shown in Example Tables and Data (p. 678).
The following is a list of items in the table; only the primary key (Id) and the Price attribute are shown.
Id (Primary Key)
Price
101
-2
102
20
103
200
201
100
202
200
203
300
204
400
205
500
Note that all of the values for Price are of type Number. However, because DynamoDB is schemaless,
it is possible to add an item with a non-numeric Price. For example, suppose that we add another item
to the ProductCatalog table:
Id (Primary Key)
Price
999
"Hello"
If the recordDetails config parameter is set to true, then Violation Detector writes details of each
violation to the output file, as in the following example:
Table Hash Key,GSI Hash Key Value,GSI Hash Key Violation Type,GSI Hash Key Vi
olation Description,GSI Hash Key Update Value(FOR USER),Delete Blank Attributes
When Updating?(Y/N)
999,"{""S"":""Hello""}",Type Violation,Expected: N Found: S,,
The output file is in comma-separated value format (CSV). The first line in the file is a header, followed
by one record per item that violates the index key. The fields of these violation records are as follows:
Table Hash Keythe hash key value of the item in the table.
Table Range Keythe range key value of the item in the table.
GSI Hash Key Valuethe hash key value of the global secondary index
GSI Hash Key Violation Typeeither Type Violation or Size Violation.
GSI Hash Key Violation Descriptionthe cause of the violation.
GSI Hash Key Update Value(FOR USER)in correction mode, a new user-supplied value for the
attribute.
GSI Range Key Valuethe range key value of the global secondary index
GSI Range Key Violation Typeeither Type Violation or Size Violation.
GSI Range Key Violation Descriptionthe cause of the violation.
GSI Range Key Update Value(FOR USER)in correction mode, a new user-supplied value for the
attribute.
Delete Blank Attribute When Updating(Y/N)in correction mode, determines whether to delete (Y)
or keep (N) the violating item in the tablebut only if either of the following fields are blank:
GSI Hash Key Update Value(FOR USER)
GSI Range Key Update Value(FOR USER)
If either of these fields are non-blank, then Delete Blank Attribute When Updating(Y/N) has
no effect.
Note
The output format might vary, depending on the configuration file and command line options.
For example, if the table does not have a range key attribute, no range key fields will be present
in the output.
The violation records in the file might not be in sorted order.
Correction
To correct index key violations, use Violation Detector with the --correct command line option. In
correction mode, Violation Detector reads the input file specified by the correctionInputPath parameter.
This file has the same format as the detectionOutputPath file, so that you can use the output from
detection as input for correction.
Violation Detector provides two different ways to correct index key violations:
Delete violationsdelete the table items that have violating attribute values.
Update violationsupdate the table items, replacing the violating attributes with non-violating values.
In either case, you can use the output file from detection mode as input for correction mode.
Continuing with our ProductCatalog example, suppose that we want to delete the violating item from
the table. To do this, we use the following command line:
$
At this point, you are asked to confirm whether you want to delete the violating items.
Now both ProductCatalog and PriceIndex have the same number of items.
have earned a particular achievement for a game - such as "Champ" - but most players have not. Rather
than scanning the entire GameScores table for Champs, you could create a global secondary index with
a hash key of Champ and a range key of UserId. This would make it easy to find all the Champs by
querying the index instead of scanning the table.
Such a query can be very efficient, because the number of items in the index will be significantly fewer
than the number of items in the table. In addition, the fewer table attributes you project into the index, the
fewer read capacity units you will consume from the index.
.withAttributeType("S"));
attributeDefinitions.add(new AttributeDefinition()
.withAttributeName("Precipitation")
.withAttributeType("N"));
// Table key schema
ArrayList<KeySchemaElement> tableKeySchema = new ArrayList<KeySchemaElement>();
tableKeySchema.add(new KeySchemaElement()
.withAttributeName("Location")
.withKeyType(KeyType.HASH));
tableKeySchema.add(new KeySchemaElement()
.withAttributeName("Date")
.withKeyType(KeyType.RANGE));
// PrecipIndex
GlobalSecondaryIndex precipIndex = new GlobalSecondaryIndex()
.withIndexName("PrecipIndex")
.withProvisionedThroughput(new ProvisionedThroughput()
.withReadCapacityUnits((long) 10)
.withWriteCapacityUnits((long) 1))
.withProjection(new Projection().withProjectionType(ProjectionType.ALL));
ArrayList<KeySchemaElement> indexKeySchema = new ArrayList<KeySchemaElement>();
indexKeySchema.add(new KeySchemaElement()
.withAttributeName("Date")
.withKeyType(KeyType.HASH));
indexKeySchema.add(new KeySchemaElement()
.withAttributeName("Precipitation")
.withKeyType(KeyType.RANGE));
precipIndex.setKeySchema(indexKeySchema);
CreateTableRequest createTableRequest = new CreateTableRequest()
.withTableName("WeatherData")
.withProvisionedThroughput(new ProvisionedThroughput()
.withReadCapacityUnits((long) 5)
.withWriteCapacityUnits((long) 1))
.withAttributeDefinitions(attributeDefinitions)
.withKeySchema(tableKeySchema)
.withGlobalSecondaryIndexes(precipIndex);
Table table = dynamoDB.createTable(createTableRequest);
System.out.println(table.getDescription());
You must wait until DynamoDB creates the table and sets the table status to ACTIVE. After that, you can
begin putting data items into the table.
After the Issues table is created, the program loads the table with data representing software bug reports,
and then queries the data using the global secondary indexes. Finally, the program deletes the Issues
table.
For step-by-step instructions to test the following sample, see Running Java Examples for
DynamoDB (p. 55).
// Copyright 2012-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
// Licensed under the Apache License, Version 2.0.
package com.amazonaws.codesamples.document;
import java.util.ArrayList;
import java.util.Iterator;
import
import
import
import
com.amazonaws.auth.profile.ProfileCredentialsProvider;
com.amazonaws.services.dynamodbv2.AmazonDynamoDBClient;
com.amazonaws.services.dynamodbv2.document.DynamoDB;
com.amazonaws.services.dynamodbv2.document.Index;
import
import
import
import
import
import
import
import
import
import
import
import
import
com.amazonaws.services.dynamodbv2.document.Item;
com.amazonaws.services.dynamodbv2.document.ItemCollection;
com.amazonaws.services.dynamodbv2.document.QueryOutcome;
com.amazonaws.services.dynamodbv2.document.Table;
com.amazonaws.services.dynamodbv2.document.spec.QuerySpec;
com.amazonaws.services.dynamodbv2.document.utils.ValueMap;
com.amazonaws.services.dynamodbv2.model.AttributeDefinition;
com.amazonaws.services.dynamodbv2.model.CreateTableRequest;
com.amazonaws.services.dynamodbv2.model.GlobalSecondaryIndex;
com.amazonaws.services.dynamodbv2.model.KeySchemaElement;
com.amazonaws.services.dynamodbv2.model.KeyType;
com.amazonaws.services.dynamodbv2.model.Projection;
com.amazonaws.services.dynamodbv2.model.ProvisionedThroughput;
tableKeySchema.add(new KeySchemaElement()
.withAttributeName("IssueId")
.withKeyType(KeyType.HASH));
tableKeySchema.add(new KeySchemaElement()
.withAttributeName("Title")
.withKeyType(KeyType.RANGE));
// Initial provisioned throughput settings for the indexes
ProvisionedThroughput ptIndex = new ProvisionedThroughput()
.withReadCapacityUnits(1L)
.withWriteCapacityUnits(1L);
// CreateDateIndex
GlobalSecondaryIndex createDateIndex = new GlobalSecondaryIndex()
.withIndexName("CreateDateIndex")
.withProvisionedThroughput(ptIndex)
.withKeySchema( new KeySchemaElement()
.withAttributeName("CreateDate")
.withKeyType(
KeyType.HASH),
new KeySchemaElement()
.withAttributeName("IssueId")
.withKeyType(KeyType.RANGE))
.withProjection(new Projection()
.withProjectionType("INCLUDE")
.withNonKeyAttributes("Description", "Status"));
// TitleIndex
GlobalSecondaryIndex titleIndex = new GlobalSecondaryIndex()
.withIndexName("TitleIndex")
.withProvisionedThroughput(ptIndex)
.withKeySchema(new KeySchemaElement()
.withAttributeName("Title")
.withKeyType(KeyType.HASH),
new KeySchemaElement()
.withAttributeName("IssueId")
.withKeyType(KeyType.RANGE))
.withProjection(new Projection()
.withProjectionType("KEYS_ONLY"));
// DueDateIndex
GlobalSecondaryIndex dueDateIndex = new GlobalSecondaryIndex()
.withIndexName("DueDateIndex")
.withProvisionedThroughput(ptIndex)
.withKeySchema( new KeySchemaElement()
.withAttributeName("DueDate")
.withKeyType(KeyType.HASH))
.withProjection(new Projection()
.withProjectionType("ALL"));
CreateTableRequest createTableRequest = new CreateTableRequest()
.withTableName(tableName)
.withProvisionedThroughput( new ProvisionedThroughput()
.withReadCapacityUnits( (long) 1)
.withWriteCapacityUnits( (long) 1))
.withAttributeDefinitions(attributeDefinitions)
.withKeySchema(tableKeySchema)
.withGlobalSecondaryIndexes(createDateIndex, titleIndex, dueDateIn
dex);
System.out.println("Creating table " + tableName + "...");
dynamoDB.createTable(createTableRequest);
// Wait for table to become active
System.out.println("Waiting for " + tableName + " to become ACTIVE...");
try {
Table table = dynamoDB.getTable(tableName);
table.waitForActive();
} catch (InterruptedException e) {
e.printStackTrace();
}
}
public static void queryIndex(String indexName) {
Table table = dynamoDB.getTable(tableName);
System.out.println
("\n***********************************************************\n");
System.out.print("Querying index " + indexName + "...");
Index index = table.getIndex(indexName);
ItemCollection<QueryOutcome> items = null;
QuerySpec querySpec = new QuerySpec();
if (indexName == "CreateDateIndex") {
System.out.println("Issues filed on 2013-11-01");
querySpec.withKeyConditionExpression("CreateDate = :v_date and be
gins_with(IssueId, :v_issue)")
.withValueMap(new ValueMap()
.withString(":v_date","2013-11-01")
.withString(":v_issue","A-"));
items = index.query(querySpec);
} else if (indexName == "TitleIndex") {
System.out.println("Compilation errors");
querySpec.withKeyConditionExpression("Title = :v_title and be
gins_with(IssueId, :v_issue)")
.withValueMap(new ValueMap()
.withString(":v_title","Compilation error")
.withString(":v_issue","A-"));
items = index.query(querySpec);
} else if (indexName == "DueDateIndex") {
System.out.println("Items that are due on 2013-11-30");
querySpec.withKeyConditionExpression("DueDate = :v_date")
.withValueMap(new ValueMap()
.withString(":v_date","2013-11-30"));
items = index.query(querySpec);
} else {
System.out.println("\nNo valid index name provided");
return;
}
Iterator<Item> iterator = items.iterator();
}
public static void deleteTable(String tableName) {
System.out.println("Deleting table " + tableName + "...");
Table table = dynamoDB.getTable(tableName);
table.delete();
// Wait for table to be deleted
System.out.println("Waiting for " + tableName + " to be deleted...");
try {
table.waitForDelete();
} catch (InterruptedException e) {
e.printStackTrace();
}
}
public static void loadData() {
System.out.println("Loading data into table " + tableName + "...");
//
//
//
//
IssueId, Title,
Description,
CreateDate, LastUpdateDate, DueDate,
Priority, Status
putItem("A-101","Compilation error",
"Can't compile Project X - bad version number. What does this mean?",
"2013-11-01", "2013-11-02", "2013-11-10",
1, "Assigned");
putItem("A-102","Can't read data file",
"The main data file is missing, or the permissions are incorrect",
"2013-11-01", "2013-11-04", "2013-11-30",
2, "In progress");
putItem("A-103", "Test failure",
"Functional test of Project X produces errors",
"2013-11-01", "2013-11-02", "2013-11-10",
1, "In progress");
putItem("A-104", "Compilation error",
"Variable 'messageCount' was not initialized.",
"2013-11-15", "2013-11-16", "2013-11-30",
3, "Assigned");
putItem("A-105", "Network issue",
// PrecipIndex
var precipIndex = new GlobalSecondaryIndex
{
IndexName = "PrecipIndex",
ProvisionedThroughput = new ProvisionedThroughput
{
ReadCapacityUnits = (long)10,
WriteCapacityUnits = (long)1
},
Projection = new Projection { ProjectionType = "ALL" }
};
var indexKeySchema = new List<KeySchemaElement> {
{new KeySchemaElement { AttributeName = "Date", KeyType = "HASH"}},
{new KeySchemaElement{AttributeName = "Precipitation",KeyType = "RANGE"}}
};
precipIndex.KeySchema = indexKeySchema;
CreateTableRequest createTableRequest = new CreateTableRequest
{
TableName = tableName,
ProvisionedThroughput = new ProvisionedThroughput
{
ReadCapacityUnits = (long)5,
WriteCapacityUnits = (long)1
},
AttributeDefinitions = attributeDefinitions,
KeySchema = tableKeySchema,
GlobalSecondaryIndexes = { precipIndex }
};
CreateTableResponse response = client.CreateTable(createTableRequest);
Console.WriteLine(response.CreateTableResult.TableDescription.TableName);
Console.WriteLine(response.CreateTableResult.TableDescription.TableStatus);
You must wait until DynamoDB creates the table and sets the table status to ACTIVE. After that, you can
begin putting data items into the table.
TableName = "WeatherData",
IndexName = "PrecipIndex",
KeyConditionExpression = "#dt = :v_date and Precipitation > :v_precip",
ExpressionAttributeNames = new Dictionary<String, String> {
{"#dt", "Date"}
},
ExpressionAttributeValues = new Dictionary<string, AttributeValue> {
{":v_date", new AttributeValue { S = "2013-08-01" }},
{":v_precip", new AttributeValue { N = "0" }}
},
ScanIndexForward = true
};
var result = client.Query(queryRequest);
var items = result.Items;
foreach (var currentItem in items)
{
foreach (string attr in currentItem.Keys)
{
Console.Write(attr + "---> ");
if (attr == "Precipitation")
{
Console.WriteLine(currentItem[attr].N);
}
else
{
Console.WriteLine(currentItem[attr].S);
}
}
Console.WriteLine();
}
After the Issues table is created, the program loads the table with data representing software bug reports,
and then queries the data using the global secondary indexes. Finally, the program deletes the Issues
table.
For step-by-step instructions to test the following sample, see Running .NET Examples for
DynamoDB (p. 57).
API Version 2012-08-10
293
using
using
using
using
using
using
using
using
using
System;
System.Collections.Generic;
System.Linq;
Amazon.DynamoDBv2;
Amazon.DynamoDBv2.DataModel;
Amazon.DynamoDBv2.DocumentModel;
Amazon.DynamoDBv2.Model;
Amazon.Runtime;
Amazon.SecurityToken;
namespace com.amazonaws.codesamples
{
class LowLevelGlobalSecondaryIndexExample
{
private static AmazonDynamoDBClient client = new AmazonDynamoDBClient();
public static String tableName = "Issues";
public static void Main(string[] args)
{
CreateTable();
LoadData();
QueryIndex("CreateDateIndex");
QueryIndex("TitleIndex");
QueryIndex("DueDateIndex");
DeleteTable(tableName);
Console.WriteLine("To continue, press enter");
Console.Read();
}
private static void CreateTable()
{
// Attribute definitions
var attributeDefinitions = new List<AttributeDefinition>()
{
{new AttributeDefinition {AttributeName = "IssueId", Attribute
Type = "S"}},
{new AttributeDefinition {AttributeName = "Title", AttributeType
= "S"}},
{new AttributeDefinition {AttributeName = "CreateDate", Attrib
uteType = "S"}},
{new AttributeDefinition {AttributeName = "DueDate", Attribute
Type = "S"}}
};
// Key schema for table
var tableKeySchema = new List<KeySchemaElement>() {
{
new KeySchemaElement {
AttributeName= "IssueId",
KeyType = "HASH"
}
},
{
new KeySchemaElement {
AttributeName = "Title",
KeyType = "RANGE"
}
}
};
// Initial provisioned throughput settings for the indexes
var ptIndex = new ProvisionedThroughput
{
ReadCapacityUnits = 1L,
WriteCapacityUnits = 1L
};
// CreateDateIndex
var createDateIndex = new GlobalSecondaryIndex()
{
IndexName = "CreateDateIndex",
ProvisionedThroughput = ptIndex,
KeySchema = {
new KeySchemaElement {
AttributeName = "CreateDate", KeyType = "HASH"
},
new KeySchemaElement {
AttributeName = "IssueId", KeyType = "RANGE"
}
},
Projection = new Projection
{
ProjectionType = "INCLUDE",
NonKeyAttributes = { "Description", "Status" }
}
};
// TitleIndex
var titleIndex = new GlobalSecondaryIndex()
{
IndexName = "TitleIndex",
ProvisionedThroughput = ptIndex,
KeySchema = {
new KeySchemaElement {
AttributeName = "Title", KeyType = "HASH"
},
new KeySchemaElement {
AttributeName = "IssueId", KeyType = "RANGE"
}
},
Projection = new Projection
{
ProjectionType = "KEYS_ONLY"
}
};
// DueDateIndex
var dueDateIndex = new GlobalSecondaryIndex()
{
IndexName = "DueDateIndex",
ProvisionedThroughput = ptIndex,
KeySchema = {
new KeySchemaElement {
AttributeName = "DueDate",
KeyType = "HASH"
}
},
Projection = new Projection
{
ProjectionType = "ALL"
}
};
//
//
//
//
IssueId, Title,
Description,
CreateDate, LastUpdateDate, DueDate,
Priority, Status
2, "In progress");
putItem("A-103", "Test failure",
"Functional test of Project X produces errors",
"2013-11-01", "2013-11-02", "2013-11-10",
1, "In progress");
putItem("A-104", "Compilation error",
"Variable 'messageCount' was not initialized.",
"2013-11-15", "2013-11-16", "2013-11-30",
3, "Assigned");
putItem("A-105", "Network issue",
"Can't ping IP address 127.0.0.1. Please fix this.",
"2013-11-15", "2013-11-16", "2013-11-19",
5, "Assigned");
}
private static void putItem(
String issueId, String title,
String description,
String createDate, String lastUpdateDate, String dueDate,
Int32 priority, String status)
{
Dictionary<String, AttributeValue> item = new Dictionary<string,
AttributeValue>();
item.Add("IssueId", new AttributeValue { S = issueId });
item.Add("Title", new AttributeValue { S = title });
item.Add("Description", new AttributeValue { S = description });
item.Add("CreateDate", new AttributeValue { S = createDate });
item.Add("LastUpdateDate", new AttributeValue { S = lastUpdateDate
});
item.Add("DueDate", new AttributeValue { S = dueDate });
item.Add("Priority", new AttributeValue { N = priority.ToString()
});
item.Add("Status", new AttributeValue { S = status });
try
{
client.PutItem(new PutItemRequest
{
TableName = tableName,
Item = item
});
}
catch (Exception e)
{
Console.WriteLine(e.ToString());
}
}
private static void QueryIndex(string indexName)
{
Console.WriteLine
("\n***********************************************************\n");
Console.WriteLine("Querying index " + indexName + "...");
QueryRequest queryRequest = new QueryRequest
{
TableName = tableName,
IndexName = indexName,
ScanIndexForward = true
};
String keyConditionExpression;
Dictionary<string, AttributeValue> expressionAttributeValues = new
Dictionary<string, AttributeValue>();
if (indexName == "CreateDateIndex")
{
Console.WriteLine("Issues filed on 2013-11-01\n");
keyConditionExpression = "CreateDate = :v_date and begins_with(Is
sueId, :v_issue)";
expressionAttributeValues.Add(":v_date", new AttributeValue {
S = "2013-11-01" });
expressionAttributeValues.Add(":v_issue", new AttributeValue {
S = "A-" });
}
else if (indexName == "TitleIndex")
{
Console.WriteLine("Compilation errors\n");
keyConditionExpression = "Title = :v_title and begins_with(Is
sueId, :v_issue)";
expressionAttributeValues.Add(":v_title", new AttributeValue {
S = "Compilation error" });
expressionAttributeValues.Add(":v_issue", new AttributeValue {
S = "A-" });
// Select
queryRequest.Select = "ALL_PROJECTED_ATTRIBUTES";
}
else if (indexName == "DueDateIndex")
{
Console.WriteLine("Items that are due on 2013-11-30\n");
keyConditionExpression = "DueDate = :v_date";
expressionAttributeValues.Add(":v_date", new AttributeValue {
S = "2013-11-30" });
// Select
queryRequest.Select = "ALL_PROJECTED_ATTRIBUTES";
}
else
{
Console.WriteLine("\nNo valid index name provided");
return;
}
queryRequest.KeyConditionExpression = keyConditionExpression;
queryRequest.ExpressionAttributeValues = expressionAttributeValues;
}
}
Console.WriteLine();
}
}
private static void DeleteTable(string tableName)
{
Console.WriteLine("Deleting table " + tableName + "...");
client.DeleteTable(new DeleteTableRequest { TableName = tableName
});
WaitForTableToBeDeleted(tableName);
}
private static void WaitUntilTableReady(string tableName)
{
string status = null;
// Let us wait until table is created. Call DescribeTable.
do
{
System.Threading.Thread.Sleep(5000); // Wait 5 seconds.
try
{
var res = client.DescribeTable(new DescribeTableRequest
{
TableName = tableName
});
Console.WriteLine("Table name: {0}, status: {1}",
res.Table.TableName,
res.Table.TableStatus);
status = res.Table.TableStatus;
}
catch (ResourceNotFoundException)
{
// DescribeTable is eventually consistent. So you might
// get resource not found. So we handle the potential excep
tion.
}
} while (status != "ACTIVE");
}
private static void WaitForTableToBeDeleted(string tableName)
{
bool tablePresent = true;
while (tablePresent)
{
System.Threading.Thread.Sleep(5000); // Wait 5 seconds.
try
{
var res = client.DescribeTable(new DescribeTableRequest
{
TableName = tableName
});
Console.WriteLine("Table name: {0}, status: {1}",
res.Table.TableName,
res.Table.TableStatus);
}
catch (ResourceNotFoundException)
{
tablePresent = false;
}
}
}
}
}
2. Provide the parameters for the query operation to the client instance.
You must provide the table name, index name, any desired item's primary key values, and any optional
query parameters. You can set up a condition as part of the query if you want to find a range of values
that meet specific comparison results. You can limit the results to a subset to provide pagination of the
results. Read results from a global secondary index are always eventually consistent.
3. Load the response into a local variable, such as $response, for use in your application.
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' #replace with your desired region
));
$tableName = 'WeatherData';
$result = $client->createTable(array(
'TableName' => $tableName,
'AttributeDefinitions' => array(
array(
'AttributeName' => 'Location',
'AttributeType' => 'S'
),
array(
'AttributeName' => 'Date',
'AttributeType' => 'S'
),
array(
'AttributeName' => 'Precipitation',
'AttributeType' => 'N'
)
),
'KeySchema' => array(
array(
'AttributeName' => 'Location',
'KeyType' => 'HASH'
),
array(
'AttributeName' => 'Date',
'KeyType' => 'RANGE'
)
),
'GlobalSecondaryIndexes' => array(
array(
'IndexName' => 'PrecipIndex',
'ProvisionedThroughput' => array (
'ReadCapacityUnits' => 5,
'WriteCapacityUnits' => 5
),
'KeySchema' => array(
array(
'AttributeName' => 'Date',
'KeyType' => 'HASH'
),
array(
'AttributeName' => 'Precipitation',
'KeyType' => 'RANGE'
)
),
'Projection' => array(
'ProjectionType' => 'ALL'
)
)
),
'ProvisionedThroughput' => array(
'ReadCapacityUnits' => 5,
'WriteCapacityUnits' => 5
)
));
You must wait until DynamoDB creates the table and sets the table status to ACTIVE. After that, you can
begin putting data items into the table.
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' #replace with your desired region
));
$tableName = 'WeatherData';
$result = $client->describeTable(array(
'TableName' => $tableName
));
foreach ($result['Table']['GlobalSecondaryIndexes'] as $key => $value) {
echo "Info for index " . $value['IndexName'] . ':' . PHP_EOL;
foreach ($value['KeySchema'] as $attribute => $keyschema) {
echo "\t" .
$value['KeySchema'][$attribute]['AttributeName'] . ': ' .
$value['KeySchema'][$attribute]['KeyType'] . PHP_EOL;
}
echo "\tThe projection type is: " . $value['Projection']['ProjectionType']
. PHP_EOL;
}
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' #replace with your desired region
));
$tableName = 'WeatherData';
$response = $client->query(array(
'TableName' => $tableName,
'IndexName' => 'PrecipIndex',
'KeyConditionExpression' => '#dt = :v_dt and Precipitation > :v_precip',
After the Issues table is created, the program loads the table with data representing software bug reports,
and then queries the data using the global secondary indexes. Finally, the program deletes the Issues
table.
<?php
use Aws\DynamoDb\DynamoDbClient;
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' // replace with your desired region
));
$tableName = 'Issues';
echo "# Creating table $tableName..." . PHP_EOL;
$response = $client->createTable ( array (
'TableName' => $tableName,
'AttributeDefinitions' => array (
array (
'AttributeName' => 'IssueId',
'AttributeType'
),
array (
'AttributeName'
'AttributeType'
),
array (
'AttributeName'
'AttributeType'
),
array (
'AttributeName'
'AttributeType'
)
=> 'S'
=> 'Title',
=> 'S'
=> 'CreateDate',
=> 'S'
=> 'DueDate',
=> 'S'
),
'KeySchema' => array (
array (
'AttributeName' => 'IssueId',
'KeyType' => 'HASH'
),
array (
'AttributeName' => 'Title',
'KeyType' => 'RANGE'
)
),
'GlobalSecondaryIndexes' => array (
array (
'IndexName' => 'CreateDateIndex',
'KeySchema' => array (
array (
'AttributeName' => 'CreateDate',
'KeyType' => 'HASH'
),
array (
'AttributeName' => 'IssueId',
'KeyType' => 'RANGE'
)
),
'Projection' => array (
'ProjectionType' => 'INCLUDE',
'NonKeyAttributes' => array (
'Description',
'Status'
)
),
'ProvisionedThroughput' => array (
'ReadCapacityUnits' => 1,
'WriteCapacityUnits' => 1
)
),
array (
'IndexName' => 'TitleIndex',
'KeySchema' => array (
array (
'AttributeName' => 'Title',
'KeyType' => 'HASH'
),
array (
),
'CreateDate' => array (
'S' => '2014-11-01'
),
'LastUpdateDate' => array (
'S' => '2014-11-02'
),
'DueDate' => array (
'S' => '2014-11-10'
),
'Priority' => array (
'N' => '1'
),
'Status' => array (
'S' => 'Assigned'
)
)
) );
$response = $client->putItem ( array (
'TableName' => $tableName,
'Item' => array (
'IssueId' => array (
'S' => 'A-102'
),
'Title' => array (
'S' => 'Can\'t read data file'
),
'Description' => array (
'S' => 'The main data file is missing, or the permissions are incor
rect'
),
'CreateDate' => array (
'S' => '2014-11-01'
),
'LastUpdateDate' => array (
'S' => '2014-11-04'
),
'DueDate' => array (
'S' => '2014-11-30'
),
'Priority' => array (
'N' => '2'
),
'Status' => array (
'S' => 'In progress'
)
)
) );
$response = $client->putItem ( array (
'TableName' => $tableName,
'Item' => array (
'IssueId' => array (
'S' => 'A-103'
),
'Title' => array (
'S' => 'Test failure'
),
'Description' => array (
'S' => 'Functional test of Project X produces errors.'
),
'CreateDate' => array (
'S' => '2014-11-01'
),
'LastUpdateDate' => array (
'S' => '2014-11-02'
),
'DueDate' => array (
'S' => '2014-11-10'
),
'Priority' => array (
'N' => '1'
),
'Status' => array (
'S' => 'In progress'
)
)
) );
$response = $client->putItem ( array (
'TableName' => $tableName,
'Item' => array (
'IssueId' => array (
'S' => 'A-104'
),
'Title' => array (
'S' => 'Compilation error'
),
'Description' => array (
'S' => 'Variable "messageCount" was not initialized.'
),
'CreateDate' => array (
'S' => '2014-11-15'
),
'LastUpdateDate' => array (
'S' => '2014-11-16'
),
'DueDate' => array (
'S' => '2014-11-30'
),
'Priority' => array (
'N' => '3'
),
'Status' => array (
'S' => 'Assigned'
)
)
) );
$response = $client->putItem ( array (
'TableName' => $tableName,
'Item' => array (
'IssueId' => array (
'S' => 'A-105'
),
)
));
echo '# Query for issues that are compilation errors: ' . PHP_EOL;
foreach ( $response ['Items'] as $item ) {
echo ' - ' . $item ['Title'] ['S'] . ' ' . $item ['IssueId'] ['S'] . PHP_EOL;
}
print PHP_EOL;
// ########################################
// Query for items that are due on 2014-11-30
$response = $client->query ( array (
'TableName' => $tableName,
'IndexName' => 'DueDateIndex',
'KeyConditionExpression' => 'DueDate = :v_dt',
'ExpressionAttributeValues' => array (
':v_dt' => array('S' => '2014-11-30')
)
));
echo '# Querying for items that are due on 2014-11-30:' . PHP_EOL;
foreach ( $response ['Items'] as $item ) {
echo ' - ' . $item ['DueDate'] ['S'] . ' ' . $item ['IssueId'] ['S'] . ' '
.
$item ['Title'] ['S'] . ' ' . $item ['Description'] ['S'] . ' ' .
$item ['CreateDate'] ['S'] . ' ' . $item ['LastUpdateDate'] ['S'] . ' ' .
$item ['Priority'] ['N'] . ' ' . $item ['Status'] ['S'] . PHP_EOL;
}
print PHP_EOL;
// ########################################
// Delete the table
echo "# Deleting table $tableName..." . PHP_EOL;
$client->deleteTable ( array (
'TableName' => $tableName
) );
$client->waitUntilTableNotExists ( array (
'TableName' => $tableName
) );
echo " Deleted table $tableName" . PHP_EOL;
?>
DynamoDB stores all of the items with the same hash key contiguously. In this example, given a particular
ForumName, a Query operation could immediately locate all of the threads for that forum. Within a group
of items with the same hash key, the items are sorted by range key. If the range key (Subject) is also
provided in the query, DynamoDB can narrow down the results that are returnedfor example, returning
all of the threads in the "S3" forum that have a Subject beginning with the letter "a".
Some requests might require more complex data access patterns. For example:
Which forum threads get the most views and replies?
Which thread in a particular forum has the largest number of messages?
How many threads were posted in a particular forum within a particular time period?
To answer these questions, the Query action would not be sufficient. Instead, you would have to Scan
the entire table. For a table with millions of items, this would consume a large amount of provisioned read
throughput and take a long time to complete.
However, you can specify one or more local secondary indexes on non-key attributes, such as Replies
or LastPostDateTime.
A local secondary index maintains an alternate range key for a given hash key. A local secondary index
also contains a copy of some or all of the attributes from the table; you specify which attributes are
projected into the local secondary index when you create the table. The data in a local secondary index
is organized by the same hash key as the table, but with a different range key. This lets you access data
items efficiently across this different dimension. For greater query or scan flexibility, you can create up
to five local secondary indexes per table.
Suppose that an application needs to find all of the threads that have been posted within the last three
months. Without a local secondary index, the application would have to Scan the entire Thread table and
discard any posts that were not within the specified time frame. With a local secondary index, a Query
operation could use LastPostDateTime as a range key and find the data quickly.
The following diagram shows a local secondary index named LastPostIndex. Note that the hash key is
the same as that of the Thread table, but the range key is LastPostDateTime.
Every local secondary index automatically contains the hash and range attributes from its parent table;
you can optionally project non-key attributes into the index. When you query the index, DynamoDB can
retrieve these projected attributes efficiently. When you query a local secondary index, the query can
also retrieve attributes that are not projected into the index. DynamoDB will automatically fetch these
attributes from the table, but at a greater latency and with higher provisioned throughput costs.
For any local secondary index, you can store up to 10 GB of data per distinct hash key value. This figure
includes all of the items in the table, plus all of the items in the indexes, that have the same hash key.
For more information, see Item Collections (p. 318).
Attribute Projections
With LastPostIndex, an application could use ForumName and LastPostDateTime as query criteria;
however, to retrieve any additional attributes, DynamoDB would need to perform additional read operations
against the Thread table. These extra reads are known as fetches, and they can increase the total amount
of provisioned throughput required for a query.
Suppose that you wanted to populate a web page with a list of all the threads in "S3" and the number of
replies for each thread, sorted by the last reply date/time beginning with the most recent reply. To populate
this list, you would need the following attributes:
Subject
Replies
LastPostDateTime
The most efficient way to query this data, and to avoid fetch operations, would be to project the Replies
attribute from the table into the local secondary index, as shown in this diagram:
A projection is the set of attributes that is copied from a table into a secondary index. The hash and range
keys of the table are always projected into the index; you can project other attributes to support your
application's query requirements. When you query an index, Amazon DynamoDB can access any attribute
in the projection as if those attributes were in a table of their own.
When you create a secondary index, you need to specify the attributes that will be projected into the
index. DynamoDB provides three different options for this:
KEYS_ONLY Each item in the index consists only of the table hash and range key values, plus the
index key values. The KEYS_ONLY option results in the smallest possible secondary index.
INCLUDE In addition to the attributes described in KEYS_ONLY, the secondary index will include other
non-key attributes that you specify.
ALL The secondary index includes all of the attributes from the source table. Because all of the table
data is duplicated in the index, an ALL projection results in the largest possible secondary index.
In the previous diagram, the non-key attribute Replies is projected into LastPostIndex. An application can
query LastPostIndex instead of the full Thread table to populate a web page with Subject, Replies and
LastPostDateTime. If any other non-key attributes are requested, DynamoDB would need to fetch those
attributes from the Thread table.
From an application's point of view, fetching additional attributes from the table is automatic and transparent,
so there is no need to rewrite any application logic. However, note that such fetching can greatly reduce
the performance advantage of using a local secondary index.
When you choose the attributes to project into a local secondary index, you must consider the tradeoff
between provisioned throughput costs and storage costs:
If you need to access just a few attributes with the lowest possible latency, consider projecting only
those attributes into a local secondary index. The smaller the index, the less that it will cost to store it,
and the less your write costs will be. If there are attributes that you occasionally need to fetch, the cost
for provisioned throughput may well outweigh the longer-term cost of storing those attributes.
If your application will frequently access some non-key attributes, you should consider projecting those
attributes into a local secondary index. The additional storage costs for the local secondary index will
offset the cost of performing frequent table scans.
If you need to access most of the non-key attributes on a frequent basis, you can project these
attributesor even the entire source table into a local secondary index. This will give you maximum
flexibility and lowest provisioned throughput consumption, because no fetching would be required;
however, your storage cost would increase, or even double if you are projecting all attributes.
If your application needs to query a table infrequently, but must perform many writes or updates against
the data in the table, consider projecting KEYS_ONLY. The local secondary index would be of minimal
size, but would still be available when needed for query activity.
Important
For tables with local secondary indexes, there is a 10 GB size limit per hash key. A table with
local secondary indexes can store any number of items, as long as the total size for any one
hash key does not exceed 10 GB. For more information, see Item Collection Size Limit (p. 320).
You can project attributes of any data type into a local secondary index. This includes scalar data types
and multi-valued sets. For a complete list of data types, see DynamoDB Data Types (p. 6).
For an example CreateTable request that includes a local secondary index, see CreateTable in the
Amazon DynamoDB API Reference.
Example
Consider the following data returned from a Query that requests data from the discussion threads in a
particular forum:
{
"TableName": "Thread",
"IndexName": "LastPostIndex",
"ConsistentRead": false,
"ProjectionExpression": "Subject, LastPostDateTime, Replies, Tags",
"KeyConditionExpression":
"ForumName = :v_forum and LastPostDateTime between :v_start and :v_end",
"ExpressionAttributeValues": {
":v_start": {"S": "2012-08-31T00:00:00.000Z"},
":v_end": {"S": "2012-11-31T00:00:00.000Z"},
":v_forum": {"S": "EC2"}
}
}
In this query:
DynamoDB accesses LastPostIndex, using the ForumName hash key to locate the index items for
"EC2". All of the index items with this key are stored adjacent to each other for rapid retrieval.
Within this forum, DynamoDB uses the index to look up the keys that match the specified
LastPostDateTime condition.
Because the Replies attribute is projected into the index, DynamoDB can retrieve this attribute without
consuming any additional provisioned throughput.
The Tags attribute is not projected into the index, so DynamoDB must access the Thread table and
fetch this attribute.
The results are returned, sorted by LastPostDateTime. The index entries are sorted by hash key and
then by range key, and Query returns them in the order they are stored. (You can use the
ScanIndexForward parameter to return the results in descending order.)
Because the Tags attribute is not projected into the local secondary index, DynamoDB must consume
additional read capacity units to fetch this attribute from the table. If you need to run this query often, you
should project Tags into LastPostIndex to avoid fetching from the table; however, if you needed to access
Tags only occasionally, then the additional storage cost for projecting Tags into the index might not be
worthwhile.
Important
For tables with local secondary indexes, there is a 10 GB size limit per hash key. A table with
local secondary indexes can store any number of items, as long as the total size for any one
hash key does not exceed 10 GB. For more information, see Item Collection Size Limit (p. 320).
unit; an eventually consistent read consumes only half of that. Thus, by choosing eventually consistent
reads, you can reduce your read capacity unit charges.
For index queries that request only index keys and projected attributes, DynamoDB calculates the
provisioned read activity in the same way as it does for queries against tables. The only difference is that
the calculation is based on the sizes of the index entries, rather than the size of the item in the table. The
number of read capacity units is the sum of all projected attribute sizes across all of the items returned;
the result is then rounded up to the next 4 KB boundary. For more information on how DynamoDB
calculates provisioned throughput usage, see Specifying Read and Write Requirements for Tables (p. 62).
For index queries that read attributes that are not projected into the local secondary index, DynamoDB
will need to fetch those attributes from the table, in addition to reading the projected attributes from the
index. These fetches occur when you include any non-projected attributes in the Select or
ProjectionExpression parameters of the Query operation. Fetching causes additional latency in
query responses, and it also incurs a higher provisioned throughput cost: In addition to the reads from
the local secondary index described above, you are charged for read capacity units for every table item
fetched. This charge is for reading each entire item from the table, not just the requested attributes.
The maximum size of the results returned by a Query operation is 1 MB; this includes the sizes of all the
attribute names and values across all of the items returned. However, if a Query against a local secondary
index causes DynamoDB to fetch item attributes from the table, the maximum size of the data in the
results might be lower. In this case, the result size is the sum of:
The size of the matching items in the index, rounded up to the next 4 KB.
The size of each matching item in the table, with each item individually rounded up to the next 4 KB.
Using this formula, the maximum size of the results returned by a Query operation is still 1 MB.
For example, consider a table where the size of each item is 300 bytes. There is a local secondary index
on that table, but only 200 bytes of each item is projected into the index. Now suppose that you Query
this index, that the query requires table fetches for each item, and that the query returns 4 items.
DynamoDB sums up the following:
The size of the matching items in the index: 200 bytes 4 items = 800 bytes; this is then rounded up
to 4 KB.
The size of each matching item in the table: (300 bytes, rounded up to 4 KB) 4 items = 16 KB.
The total size of the data in the result is therefore 20 KB.
If an item is not present in the index before or after the item is updated, there is no additional write cost
for the index.
All of these factors assume that the size of each item in the index is less than or equal to the 1 KB item
size for calculating write capacity units. Larger index entries will require additional write capacity units.
You can minimize your write costs by considering which attributes your queries will need to return and
projecting only those attributes into the index.
The size in bytes of the table primary key (hash and range key attributes)
The size in bytes of the index key attribute
The size in bytes of the projected attributes (if any)
100 bytes of overhead per index item
To estimate the storage requirements for a local secondary index, you can estimate the average size of
an item in the index and then multiply by the number of items in the table.
If a table contains an item where a particular attribute is not defined, but that attribute is defined as an
index range key, then DynamoDB does not write any data for that item to the index. For more information
about this behavior, see Take Advantage of Sparse Indexes (p. 322).
Item Collections
Note
The following section pertains only to tables that have local secondary indexes.
In DynamoDB, an item collection is any group of items that have the same hash key, in a table and all of
its local secondary indexes. In the examples used throughout this section, the hash key for the Thread
table is ForumName, and the hash key for LastPostIndex is also ForumName. All the table and index
items with the same ForumName are part of the same item collection. For example, in the Thread table
and the LastPostIndex local secondary index, there is an item collection for forum EC2 and a different
item collection for forum RDS.
The following diagram shows the item collection for forum S3:
In this diagram, the item collection consists of all the items in Thread and LastPostIndex where the
ForumName hash key is "S3". If there were other local secondary indexes on the table, then any items
in those indexes with ForumName equal to "S3" would also be part of the item collection.
You can use any of the following operations in DynamoDB to return information about item collections:
BatchWriteItem
DeleteItem
PutItem
UpdateItem
Each of these operations support the ReturnItemCollectionMetrics parameter. When you set this
parameter to SIZE, you can view information about the size of each item collection in the index.
Example
Here is a snippet from the output of an UpdateItem operation on the Thread table, with
ReturnItemCollectionMetrics set to SIZE. The item that was updated had a ForumName value of
"EC2", so the output includes information about that item collection.
{
ItemCollectionMetrics: {
ItemCollectionKey: {
ForumName: "EC2"
},
SizeEstimateRangeGB: [0.0, 1.0]
}
}
The SizeEstimateRangeGB object shows that the size of this item collection is between 0 and 1 gigabyte.
DynamoDB periodically updates this size estimate, so the numbers might be different next time the item
is modified.
the same partition. The "S3" item collection would be stored on one partition, "EC2" in another partition,
and "RDS" in a third partition.
You should design your applications so that table data is evenly distributed across distinct hash key
values. For tables with local secondary indexes, your applications should not create "hot spots" of read
and write activity within a single item collection on a single partition.
If you cannot avoid creating the index, then you will need to anticipate the item collection size limit and
take action before you exceed it. For strategies on working within the limit and taking corrective action,
see Item Collection Size Limit (p. 320).
You must wait until DynamoDB creates the table and sets the table status to ACTIVE. After that, you can
begin putting data items into the table.
The only attributes returned are those that have been projected into the index. You could modify this
query to select non-key attributes too, but this would require table fetch activity that is relatively expensive.
For more information about table fetches, see Attribute Projections (p. 313).
The following are the steps to query a local secondary index using the AWS SDK for Java Document
API.
1. Create an instance of the DynamoDB class.
2. Create an instance of the Table class. You must provide the table name.
3. Create an instance of the Index class. You must provide the index name.
4. Call the query method of the Index class.
The following Java code snippet demonstrates the preceding steps.
After the CustomerOrders table is created, the program loads the table with data representing customer
orders, and then queries the data using the local secondary indexes. Finally, the program deletes the
CustomerOrders table.
For step-by-step instructions to test the following sample, see Running Java Examples for
DynamoDB (p. 55).
// Copyright 2012-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
// Licensed under the Apache License, Version 2.0.
package com.amazonaws.codesamples.document;
import java.util.ArrayList;
import java.util.Iterator;
import
import
import
import
import
import
import
import
import
import
import
import
import
import
import
import
import
import
import
import
import
com.amazonaws.auth.profile.ProfileCredentialsProvider;
com.amazonaws.services.dynamodbv2.AmazonDynamoDBClient;
com.amazonaws.services.dynamodbv2.document.DynamoDB;
com.amazonaws.services.dynamodbv2.document.Index;
com.amazonaws.services.dynamodbv2.document.Item;
com.amazonaws.services.dynamodbv2.document.ItemCollection;
com.amazonaws.services.dynamodbv2.document.PutItemOutcome;
com.amazonaws.services.dynamodbv2.document.QueryOutcome;
com.amazonaws.services.dynamodbv2.document.Table;
com.amazonaws.services.dynamodbv2.document.spec.QuerySpec;
com.amazonaws.services.dynamodbv2.document.utils.ValueMap;
com.amazonaws.services.dynamodbv2.model.AttributeDefinition;
com.amazonaws.services.dynamodbv2.model.CreateTableRequest;
com.amazonaws.services.dynamodbv2.model.KeySchemaElement;
com.amazonaws.services.dynamodbv2.model.KeyType;
com.amazonaws.services.dynamodbv2.model.LocalSecondaryIndex;
com.amazonaws.services.dynamodbv2.model.Projection;
com.amazonaws.services.dynamodbv2.model.ProjectionType;
com.amazonaws.services.dynamodbv2.model.ProvisionedThroughput;
com.amazonaws.services.dynamodbv2.model.ReturnConsumedCapacity;
com.amazonaws.services.dynamodbv2.model.Select;
.println("\n***********************************************************\n");
System.out.println("Querying table " + tableName + "...");
QuerySpec querySpec = new QuerySpec()
.withConsistentRead(true)
.withScanIndexForward(true)
.withReturnConsumedCapacity(ReturnConsumedCapacity.TOTAL);
if (indexName == "IsOpenIndex") {
System.out.println("\nUsing index: '" + indexName
+ "': Bob's orders that are open.");
System.out.println(
"Only a user-specified list of attributes are returned\n");
Index index = table.getIndex(indexName);
querySpec.withKeyConditionExpression("CustomerId = :v_custid and
IsOpen = :v_isopen")
.withValueMap(new ValueMap()
.withString(":v_custid", "[email protected]")
.withNumber(":v_isopen", 1));
querySpec.withProjectionExpression(
"OrderCreationDate, ProductCategory, ProductName, OrderStatus");
} else {
System.out.println("\nNo index: All of Bob's orders, by OrderId:\n");
querySpec.withKeyConditionExpression("CustomerId = :v_custid")
.withValueMap(new ValueMap()
.withString(":v_custid", "[email protected]"));
ItemCollection<QueryOutcome> items = table.query(querySpec);
Iterator<Item> iterator = items.iterator();
System.out.println("Query: printing results...");
while (iterator.hasNext()) {
System.out.println(iterator.next().toJSONPretty());
}
}
}
public static void deleteTable(String tableName) {
Table table = dynamoDB.getTable(tableName);
System.out.println("Deleting table " + tableName + "...");
table.delete();
// Wait for table to be deleted
System.out.println("Waiting for " + tableName + " to be deleted...");
try {
table.waitForDelete();
} catch (InterruptedException e) {
e.printStackTrace();
}
}
public static void loadData() {
Table table = dynamoDB.getTable(tableName);
System.out.println("Loading data into table " + tableName + "...");
Item item = new Item()
.withPrimaryKey("CustomerId", "[email protected]")
.withNumber("OrderId", 1)
.withNumber("IsOpen", 1)
.withNumber("OrderCreationDate", 20130101)
.withString("ProductCategory", "Book")
.withString("ProductName", "The Great Outdoors")
.withString("OrderStatus", "PACKING ITEMS");
// no ShipmentTrackingId attribute
PutItemOutcome putItemOutcome = table.putItem(item);
item = new Item()
.withPrimaryKey("CustomerId", "[email protected]")
.withNumber("OrderId", 2)
.withNumber("IsOpen", 1)
.withNumber("OrderCreationDate", 20130221)
.withString("ProductCategory", "Bike")
.withString("ProductName", "Super Mountain")
.withString("OrderStatus", "ORDER RECEIVED");
// no ShipmentTrackingId attribute
putItemOutcome = table.putItem(item);
item = new Item()
.withPrimaryKey("CustomerId", "[email protected]")
.withNumber("OrderId", 3)
// no IsOpen attribute
.withNumber("OrderCreationDate", 20130304)
.withString("ProductCategory", "Music")
.withString("ProductName", "A Quiet Interlude")
.withString("OrderStatus", "IN TRANSIT")
.withString("ShipmentTrackingId", "176493");
putItemOutcome = table.putItem(item);
item = new Item()
.withPrimaryKey("CustomerId", "[email protected]")
.withNumber("OrderId", 1)
// no IsOpen attribute
.withNumber("OrderCreationDate", 20130111)
.withString("ProductCategory", "Movie")
.withString("ProductName", "Calm Before The Storm")
.withString("OrderStatus", "SHIPPING DELAY")
.withString("ShipmentTrackingId", "859323");
putItemOutcome = table.putItem(item);
item = new Item()
.withPrimaryKey("CustomerId", "[email protected]")
.withNumber("OrderId", 2)
// no IsOpen attribute
.withNumber("OrderCreationDate", 20130124)
.withString("ProductCategory", "Music")
.withString("ProductName", "E-Z Listening")
.withString("OrderStatus", "DELIVERED")
.withString("ShipmentTrackingId", "756943");
putItemOutcome = table.putItem(item);
item = new Item()
.withPrimaryKey("CustomerId", "[email protected]")
.withNumber("OrderId", 3)
// no IsOpen attribute
.withNumber("OrderCreationDate", 20130221)
.withString("ProductCategory", "Music")
.withString("ProductName", "Symphony 9")
.withString("OrderStatus", "DELIVERED")
.withString("ShipmentTrackingId", "645193");
putItemOutcome = table.putItem(item);
item = new Item().withPrimaryKey("CustomerId", "[email protected]")
.withNumber("OrderId", 4).withNumber("IsOpen", 1)
.withNumber("OrderCreationDate", 20130222)
.withString("ProductCategory", "Hardware")
.withString("ProductName", "Extra Heavy Hammer")
.withString("OrderStatus", "PACKING ITEMS");
// no ShipmentTrackingId attribute
putItemOutcome = table.putItem(item);
item = new Item().withPrimaryKey("CustomerId", "[email protected]")
.withNumber("OrderId", 5)
/* no IsOpen attribute */
.withNumber("OrderCreationDate", 20130309)
.withString("ProductCategory", "Book")
.withString("ProductName", "How To Cook")
.withString("OrderStatus", "IN TRANSIT")
.withString("ShipmentTrackingId", "440185");
putItemOutcome = table.putItem(item);
item = new Item()
.withPrimaryKey("CustomerId", "[email protected]")
.withNumber("OrderId", 6)
// no IsOpen attribute
.withNumber("OrderCreationDate", 20130318)
.withString("ProductCategory", "Luggage")
.withString("ProductName", "Really Big Suitcase")
.withString("OrderStatus", "DELIVERED")
.withString("ShipmentTrackingId", "893927");
putItemOutcome = table.putItem(item);
item = new Item().withPrimaryKey("CustomerId", "[email protected]")
.withNumber("OrderId", 7)
/* no IsOpen attribute */
.withNumber("OrderCreationDate", 20130324)
.withString("ProductCategory", "Golf")
.withString("ProductName", "PGA Pro II")
.withString("OrderStatus", "OUT FOR DELIVERY")
.withString("ShipmentTrackingId", "383283");
putItemOutcome = table.putItem(item);
assert putItemOutcome != null;
}
}
You can use the AWS SDK for .NET low-level API (protocol-level API) to create a table with one or more
local secondary indexes, describe the indexes on the table, and perform queries using the indexes. These
operations map to the corresponding DynamoDB API. For more information, see Using the DynamoDB
API (p. 513).
The following are the common steps for table operations using the .NET low-level API.
1. Create an instance of the AmazonDynamoDBClient class.
2. Provide the required and optional parameters for the operation by creating the corresponding request
objects.
For example, create a CreateTableRequest object to create a table and an QueryRequest object
to query a table or an index.
3. Execute the appropriate method provided by the client that you created in the preceding step.
attributeDefinitions.Add(new AttributeDefinition()
{
AttributeName = "Artist",
AttributeType = "S"
});
attributeDefinitions.Add(new AttributeDefinition()
{
AttributeName = "SongTitle",
AttributeType = "S"
});
attributeDefinitions.Add(new AttributeDefinition()
{
AttributeName = "AlbumTitle",
AttributeType = "S"
});
createTableRequest.AttributeDefinitions = attributeDefinitions;
//KeySchema
List<KeySchemaElement> tableKeySchema = new List<KeySchemaElement>();
tableKeySchema.Add(new KeySchemaElement() { AttributeName = "Artist", KeyType
= "HASH" });
tableKeySchema.Add(new KeySchemaElement() { AttributeName = "SongTitle", KeyType
= "RANGE" });
createTableRequest.KeySchema = tableKeySchema;
List<KeySchemaElement> indexKeySchema = new List<KeySchemaElement>();
indexKeySchema.Add(new KeySchemaElement() { AttributeName = "Artist", KeyType
= "HASH" });
indexKeySchema.Add(new KeySchemaElement() { AttributeName = "AlbumTitle", KeyType
= "RANGE" });
Projection projection = new Projection() { ProjectionType = "INCLUDE" };
List<string> nonKeyAttributes = new List<string>();
nonKeyAttributes.Add("Genre");
nonKeyAttributes.Add("Year");
projection.NonKeyAttributes = nonKeyAttributes;
LocalSecondaryIndex localSecondaryIndex = new LocalSecondaryIndex()
{
IndexName = "AlbumTitleIndex",
KeySchema = indexKeySchema,
Projection = projection
};
List<LocalSecondaryIndex> localSecondaryIndexes = new List<LocalSecondaryIn
dex>();
localSecondaryIndexes.Add(localSecondaryIndex);
createTableRequest.LocalSecondaryIndexes = localSecondaryIndexes;
CreateTableResponse result = client.CreateTable(createTableRequest);
Console.WriteLine(result.CreateTableResult.TableDescription.TableName);
Console.WriteLine(result.CreateTableResult.TableDescription.TableStatus);
You must wait until DynamoDB creates the table and sets the table status to ACTIVE. After that, you can
begin putting data items into the table.
if (projection.ProjectionType.ToString().Equals("INCLUDE"))
{
Console.WriteLine("\t\tThe non-key projected attributes are:");
foreach (String s in projection.NonKeyAttributes)
{
Console.WriteLine("\t\t" + s);
}
}
}
OrderCreationDateIndexthe range key is OrderCreationDate, and the following attributes are projected
into the index:
ProductCategory
ProductName
OrderStatus
ShipmentTrackingId
IsOpenIndexthe range key is IsOpen, and all of the table attributes are projected into the index.
After the CustomerOrders table is created, the program loads the table with data representing customer
orders, and then queries the data using the local secondary indexes. Finally, the program deletes the
CustomerOrders table.
For step-by-step instructions to test the following sample, see Running .NET Examples for
DynamoDB (p. 57).
using
using
using
using
using
using
using
using
using
System;
System.Collections.Generic;
System.Linq;
Amazon.DynamoDBv2;
Amazon.DynamoDBv2.DataModel;
Amazon.DynamoDBv2.DocumentModel;
Amazon.DynamoDBv2.Model;
Amazon.Runtime;
Amazon.SecurityToken;
namespace com.amazonaws.codesamples
{
class LowLevelLocalSecondaryIndexExample
{
private static AmazonDynamoDBClient client = new AmazonDynamoDBClient();
private static string tableName = "CustomerOrders";
static void Main(string[] args)
{
try
{
CreateTable();
LoadData();
Query(null);
Query("IsOpenIndex");
Query("OrderCreationDateIndex");
DeleteTable(tableName);
Console.WriteLine("To continue, press Enter");
Console.ReadLine();
}
catch (AmazonDynamoDBException e) { Console.WriteLine(e.Message);
}
catch (AmazonServiceException e) { Console.WriteLine(e.Message); }
catch (Exception e) { Console.WriteLine(e.Message); }
}
};
orderCreationDateIndex.KeySchema = indexKeySchema;
// Projection (with list of projected attributes) for
// OrderCreationDateIndex
var projection = new Projection() { ProjectionType = "INCLUDE" };
var nonKeyAttributes = new List<string>()
{
"ProductCategory",
"ProductName"
};
projection.NonKeyAttributes = nonKeyAttributes;
orderCreationDateIndex.Projection = projection;
localSecondaryIndexes.Add(orderCreationDateIndex);
// IsOpenIndex
LocalSecondaryIndex isOpenIndex
= new LocalSecondaryIndex() { IndexName = "IsOpenIndex" };
// Key schema for IsOpenIndex
indexKeySchema = new List<KeySchemaElement>()
{
{ new KeySchemaElement() {AttributeName = "CustomerId", KeyType
= "HASH" }},
{ new KeySchemaElement() {AttributeName = "IsOpen", KeyType =
"RANGE" }}
};
// Projection (all attributes) for IsOpenIndex
projection = new Projection() { ProjectionType = "ALL" };
isOpenIndex.KeySchema = indexKeySchema;
isOpenIndex.Projection = projection;
localSecondaryIndexes.Add(isOpenIndex);
// Add index definitions to CreateTable request
createTableRequest.LocalSecondaryIndexes = localSecondaryIndexes;
Console.WriteLine("Creating table " + tableName + "...");
client.CreateTable(createTableRequest);
WaitUntilTableReady(tableName);
}
public static void Query(string indexName)
{
Con
sole.WriteLine("\n***********************************************************\n");
Console.WriteLine("Querying table " + tableName + "...");
QueryRequest queryRequest = new QueryRequest()
{
TableName = tableName,
ConsistentRead = true,
ScanIndexForward = true,
ReturnConsumedCapacity = "TOTAL"
};
if (indexName == "IsOpenIndex")
{
Console.WriteLine("\nUsing index: '" + indexName
+ "': Bob's orders that are open.");
Console.WriteLine("Only a user-specified list of attributes are
returned\n");
queryRequest.IndexName = indexName;
keyConditionExpression += " and IsOpen = :v_isOpen";
expressionAttributeValues.Add(":v_isOpen", new AttributeValue
{ N = "1" });
// ProjectionExpression
queryRequest.ProjectionExpression = "OrderCreationDate, Product
Category, ProductName, OrderStatus";
}
else if (indexName == "OrderCreationDateIndex")
{
Console.WriteLine("\nUsing index: '" + indexName
+ "': Bob's orders that were placed after 01/31/2013.");
Console.WriteLine("Only the projected attributes are re
turned\n");
queryRequest.IndexName = indexName;
keyConditionExpression += " and OrderCreationDate > :v_Date";
expressionAttributeValues.Add(":v_Date", new AttributeValue {
N = "20130131" });
// Select
queryRequest.Select = "ALL_PROJECTED_ATTRIBUTES";
}
else
{
Console.WriteLine("\nNo index: All of Bob's orders, by Or
derId:\n");
}
queryRequest.KeyConditionExpression = keyConditionExpression;
queryRequest.ExpressionAttributeValues = expressionAttributeValues;
{
foreach (string attr in currentItem.Keys)
{
if (attr == "OrderId" || attr == "IsOpen"
|| attr == "OrderCreationDate")
{
Console.WriteLine(attr + "---> " + currentItem[attr].N);
}
else
{
Console.WriteLine(attr + "---> " + currentItem[attr].S);
}
}
Console.WriteLine();
}
Console.WriteLine("\nConsumed capacity: " + result.ConsumedCapa
city.CapacityUnits + "\n");
}
private static void DeleteTable(string tableName)
{
Console.WriteLine("Deleting table " + tableName + "...");
client.DeleteTable(new DeleteTableRequest() { TableName = tableName
});
WaitForTableToBeDeleted(tableName);
}
public static void LoadData()
{
Console.WriteLine("Loading data into table " + tableName + "...");
};
item["OrderId"] = new AttributeValue { N = "2" };
item["IsOpen"] = new AttributeValue { N = "1" };
item["OrderCreationDate"] = new AttributeValue { N = "20130221" };
item["ProductCategory"] = new AttributeValue { S = "Bike" };
item["ProductName"] = new AttributeValue { S = "Super Mountain" };
item["OrderStatus"] = new AttributeValue { S = "ORDER RECEIVED" };
/* no ShipmentTrackingId attribute */
putItemRequest = new PutItemRequest
{
TableName = tableName,
Item = item,
ReturnItemCollectionMetrics = "SIZE"
};
client.PutItem(putItemRequest);
item = new Dictionary<string, AttributeValue>();
item["CustomerId"] = new AttributeValue { S = "[email protected]"
};
item["OrderId"] = new AttributeValue { N = "3" };
/* no IsOpen attribute */
item["OrderCreationDate"] = new AttributeValue { N = "20130304" };
item["ProductCategory"] = new AttributeValue { S = "Music" };
item["ProductName"] = new AttributeValue { S = "A Quiet Interlude"
};
item["OrderStatus"] = new AttributeValue { S = "IN TRANSIT" };
item["ShipmentTrackingId"] = new AttributeValue { S = "176493" };
putItemRequest = new PutItemRequest
{
TableName = tableName,
Item = item,
ReturnItemCollectionMetrics = "SIZE"
};
client.PutItem(putItemRequest);
item = new Dictionary<string, AttributeValue>();
item["CustomerId"] = new AttributeValue { S = "[email protected]" };
item["OrderId"] = new AttributeValue { N = "1" };
/* no IsOpen attribute */
item["OrderCreationDate"] = new AttributeValue { N = "20130111" };
item["ProductCategory"] = new AttributeValue { S = "Movie" };
item["ProductName"] = new AttributeValue { S = "Calm Before The
Storm" };
item["OrderStatus"] = new AttributeValue { S = "SHIPPING DELAY" };
item["ShipmentTrackingId"] = new AttributeValue { S = "859323" };
putItemRequest = new PutItemRequest
{
TableName = tableName,
Item = item,
ReturnItemCollectionMetrics = "SIZE"
};
client.PutItem(putItemRequest);
item = new Dictionary<string, AttributeValue>();
item["CustomerId"] = new AttributeValue { S = "[email protected]" };
item["OrderId"] = new AttributeValue { N = "2" };
/* no IsOpen attribute */
item["OrderCreationDate"] = new AttributeValue { N = "20130124" };
item["ProductCategory"] = new AttributeValue { S = "Music" };
item["ProductName"] = new AttributeValue { S = "E-Z Listening" };
item["OrderStatus"] = new AttributeValue { S = "DELIVERED" };
item["ShipmentTrackingId"] = new AttributeValue { S = "756943" };
putItemRequest = new PutItemRequest
{
TableName = tableName,
Item = item,
ReturnItemCollectionMetrics = "SIZE"
};
client.PutItem(putItemRequest);
item = new Dictionary<string, AttributeValue>();
item["CustomerId"] = new AttributeValue { S = "[email protected]" };
item["OrderId"] = new AttributeValue { N = "3" };
/* no IsOpen attribute */
item["OrderCreationDate"] = new AttributeValue { N = "20130221" };
item["ProductCategory"] = new AttributeValue { S = "Music" };
item["ProductName"] = new AttributeValue { S = "Symphony 9" };
item["OrderStatus"] = new AttributeValue { S = "DELIVERED" };
item["ShipmentTrackingId"] = new AttributeValue { S = "645193" };
putItemRequest = new PutItemRequest
{
TableName = tableName,
Item = item,
ReturnItemCollectionMetrics = "SIZE"
};
client.PutItem(putItemRequest);
item = new Dictionary<string, AttributeValue>();
item["CustomerId"] = new AttributeValue { S = "[email protected]" };
item["OrderId"] = new AttributeValue { N = "4" };
item["IsOpen"] = new AttributeValue { N = "1" };
item["OrderCreationDate"] = new AttributeValue { N = "20130222" };
item["ProductCategory"] = new AttributeValue { S = "Hardware" };
item["ProductName"] = new AttributeValue { S = "Extra Heavy Hammer"
};
item["OrderStatus"] = new AttributeValue { S = "PACKING ITEMS" };
/* no ShipmentTrackingId attribute */
putItemRequest = new PutItemRequest
{
TableName = tableName,
Item = item,
ReturnItemCollectionMetrics = "SIZE"
};
client.PutItem(putItemRequest);
item = new Dictionary<string, AttributeValue>();
item["CustomerId"] = new AttributeValue { S = "[email protected]" };
item["OrderId"] = new AttributeValue { N = "5" };
/* no IsOpen attribute */
item["OrderCreationDate"] = new AttributeValue { N = "20130309" };
item["ProductCategory"] = new AttributeValue { S = "Book" };
item["ProductName"] = new AttributeValue { S = "How To Cook" };
item["OrderStatus"] = new AttributeValue { S = "IN TRANSIT" };
item["ShipmentTrackingId"] = new AttributeValue { S = "440185" };
putItemRequest = new PutItemRequest
{
TableName = tableName,
Item = item,
ReturnItemCollectionMetrics = "SIZE"
};
client.PutItem(putItemRequest);
item = new Dictionary<string, AttributeValue>();
item["CustomerId"] = new AttributeValue { S = "[email protected]" };
item["OrderId"] = new AttributeValue { N = "6" };
/* no IsOpen attribute */
item["OrderCreationDate"] = new AttributeValue { N = "20130318" };
item["ProductCategory"] = new AttributeValue { S = "Luggage" };
item["ProductName"] = new AttributeValue { S = "Really Big Suitcase"
};
item["OrderStatus"] = new AttributeValue { S = "DELIVERED" };
item["ShipmentTrackingId"] = new AttributeValue { S = "893927" };
putItemRequest = new PutItemRequest
{
TableName = tableName,
Item = item,
ReturnItemCollectionMetrics = "SIZE"
};
client.PutItem(putItemRequest);
item = new Dictionary<string, AttributeValue>();
item["CustomerId"] = new AttributeValue { S = "[email protected]" };
item["OrderId"] = new AttributeValue { N = "7" };
/* no IsOpen attribute */
item["OrderCreationDate"] = new AttributeValue { N = "20130324" };
item["ProductCategory"] = new AttributeValue { S = "Golf" };
item["ProductName"] = new AttributeValue { S = "PGA Pro II" };
item["OrderStatus"] = new AttributeValue { S = "OUT FOR DELIVERY"
};
item["ShipmentTrackingId"] = new AttributeValue { S = "383283" };
putItemRequest = new PutItemRequest
{
TableName = tableName,
Item = item,
ReturnItemCollectionMetrics = "SIZE"
};
client.PutItem(putItemRequest);
}
private static void WaitUntilTableReady(string tableName)
{
string status = null;
// Let us wait until table is created. Call DescribeTable.
do
{
System.Threading.Thread.Sleep(5000); // Wait 5 seconds.
try
{
var res = client.DescribeTable(new DescribeTableRequest
{
TableName = tableName
});
Console.WriteLine("Table name: {0}, status: {1}",
res.Table.TableName,
res.Table.TableStatus);
status = res.Table.TableStatus;
}
catch (ResourceNotFoundException)
{
// DescribeTable is eventually consistent. So you might
// get resource not found. So we handle the potential excep
tion.
}
} while (status != "ACTIVE");
}
private static void WaitForTableToBeDeleted(string tableName)
{
bool tablePresent = true;
while (tablePresent)
{
System.Threading.Thread.Sleep(5000); // Wait 5 seconds.
try
{
var res = client.DescribeTable(new DescribeTableRequest
{
TableName = tableName
});
Console.WriteLine("Table name: {0}, status: {1}",
res.Table.TableName,
res.Table.TableStatus);
}
catch (ResourceNotFoundException)
{
tablePresent = false;
}
}
}
}
}
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' #replace with your desired region
));
$tableName = 'Music';
$result = $client->createTable(array(
'TableName' => $tableName,
'AttributeDefinitions' => array(
array(
'AttributeName' => 'Artist',
'AttributeType' => 'S'
),
array(
'AttributeName' => 'SongTitle',
'AttributeType' => 'S'
),
array(
'AttributeName' => 'AlbumTitle',
'AttributeType' => 'S'
)
),
'KeySchema' => array(
array(
'AttributeName' => 'Artist',
'KeyType' => 'HASH'
),
array(
'AttributeName' => 'SongTitle',
'KeyType' => 'RANGE'
)
),
'LocalSecondaryIndexes' => array(
array(
'IndexName' => 'AlbumTitleIndex',
'KeySchema' => array(
array(
'AttributeName' => 'Artist',
'KeyType' => 'HASH'
),
array(
'AttributeName' => 'AlbumTitle',
'KeyType' => 'RANGE'
)
),
'Projection' => array(
'ProjectionType' => 'INCLUDE',
'NonKeyAttributes' => array('Genre', 'Year')
)
)
),
'ProvisionedThroughput' => array(
'ReadCapacityUnits' => 5,
'WriteCapacityUnits' => 5
)
));
You must wait until DynamoDB creates the table and sets the table status to ACTIVE. After that, you can
begin putting data items into the table.
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' #replace with your desired region
));
$tableName='Music';
$response = $client->query(array(
'TableName' => $tableName,
'IndexName' => 'AlbumTitleIndex',
'KeyConditionExpression' => 'Artist = :v_artist and AlbumTitle >= :v_title',
'ExpressionAttributeValues' => array (
':v_artist' => array('S' => 'Acme Band'),
':v_title' => array('S' => 'Songs About Life')
),
'Select' => 'ALL_ATTRIBUTES'
));
echo "Acme Band's Songs About Life:" . PHP_EOL;
foreach($response['Items'] as $item) {
echo "
- " . $item['SongTitle']['S'] . PHP_EOL;
}
ProductCategory
ProductName
OrderStatus
ShipmentTrackingId
IsOpenIndexthe range key is IsOpen, and all of the table attributes are projected into the index.
After the CustomerOrders table is created, the program loads the table with data representing customer
orders, and then queries the data using the local secondary indexes. Finally, the program deletes the
CustomerOrders table.
<?php
use Aws\DynamoDb\DynamoDbClient;
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' // replace with your desired region
));
$tableName = 'CustomerOrders';
echo "# Creating table $tableName..." . PHP_EOL;
$response = $client->createTable(array(
'TableName' => $tableName,
'AttributeDefinitions' => array(
array(
'AttributeName' => 'CustomerId',
'AttributeType' => 'S'
),
array(
'AttributeName' => 'OrderId',
'AttributeType' => 'N'
),
array(
'AttributeName' => 'OrderCreationDate',
'AttributeType' => 'N'
),
array(
'AttributeName' => 'IsOpen',
'AttributeType' => 'N'
)
),
'KeySchema' => array(
array(
'AttributeName' => 'CustomerId',
'KeyType' => 'HASH'
),
array(
'AttributeName' => 'OrderId',
'KeyType' => 'RANGE'
)
),
'LocalSecondaryIndexes' => array(
array(
'IndexName' => 'OrderCreationDateIndex',
'KeySchema' => array(
array(
'AttributeName' => 'CustomerId',
'KeyType' => 'HASH'
),
array(
'AttributeName' => 'OrderCreationDate',
'KeyType' => 'RANGE'
)
),
'Projection' => array(
'ProjectionType' => 'INCLUDE',
'NonKeyAttributes' => array('ProductCategory', 'ProductName')
)
),
array(
'IndexName' => 'IsOpenIndex',
'KeySchema' => array(
array(
'AttributeName' => 'CustomerId',
'KeyType' => 'HASH'
),
array(
'AttributeName' => 'IsOpen',
'KeyType' => 'RANGE'
)
),
'Projection' => array(
'ProjectionType' => 'ALL'
)
)
),
'ProvisionedThroughput' => array(
'ReadCapacityUnits'
=> 5,
'WriteCapacityUnits' => 5
)
));
echo " Waiting for table $tableName to be created." . PHP_EOL;
$client->waitUntilTableExists(array('TableName' => $tableName));
echo " Table $tableName has been created." . PHP_EOL;
#########################################
# Add items to the table
echo "# Loading data into $tableName..." . PHP_EOL;
$response = $client->putItem ( array (
'TableName' => $tableName,
'Item' => array (
'CustomerId' => array ('S' => '[email protected]'),
'OrderId' => array ('N' => '1'),
'IsOpen' => array ('N' => '1'),
'OrderCreationDate' => array ('N' => '20140101'),
'ProductCategory' => array ('S' => 'Book'),
'ProductName' => array ('S' => 'The Great Outdoors'),
'OrderStatus' => array ('S' => 'PACKING ITEMS')
)
) );
// no IsOpen attribute
'OrderCreationDate' => array ('N' => '20140324'),
'ProductCategory' => array ('S' => 'Golf'),
'ProductName' => array ('S' => 'PGA Pro II'),
'OrderStatus' => array ('S' => 'OUT FOR DELIVERY'),
'ShipmentTrackingId' => array ('N' => '383283')
)
) );
#########################################
# Query for Bob's 5 most recent orders in 2014, retrieving attributes which are
projected into the index
$response = $client->query(array(
'TableName' => $tableName,
'IndexName' => 'OrderCreationDateIndex',
'KeyConditionExpression' => 'CustomerId = :v_id and OrderCreationDate >=
:v_dt',
'ExpressionAttributeValues' => array (
':v_id' => array('S' => '[email protected]'),
':v_dt' => array('N' => '20140101')
),
'Select' => 'ALL_PROJECTED_ATTRIBUTES',
'ScanIndexForward' => false,
'ConsistentRead' => true,
'Limit' => 5,
'ReturnConsumedCapacity' => 'TOTAL'
));
echo "# Querying for Bob's 5 most recent orders in 2014:" . PHP_EOL;
foreach($response['Items'] as $item) {
echo '
- ' . $item['CustomerId']['S']. ' ' . $item['OrderCreationDate']['N']
. ' '
. $item['ProductName']['S'] . ' ' . $item['ProductCategory']['S'] .
PHP_EOL;
}
echo ' Provisioned Throughput Consumed: ' . $response['ConsumedCapacity']['Ca
pacityUnits'] . PHP_EOL;
#########################################
# Query for Bob's 5 most recent orders in 2014, retrieving some attributes which
are not projected into the index
$response = $client->query(array(
'TableName' => $tableName,
'IndexName' => 'OrderCreationDateIndex',
'KeyConditionExpression' => 'CustomerId = :v_id and OrderCreationDate >=
:v_dt',
'ExpressionAttributeValues' => array (
':v_id' => array('S' => '[email protected]'),
':v_dt' => array('N' => '20140101')
),
'Select' => 'SPECIFIC_ATTRIBUTES',
'ProjectionExpression' => 'CustomerId, OrderCreationDate, ProductName,
ProductCategory, OrderStatus',
'ScanIndexForward' => false,
'ConsistentRead' => true,
'Limit' => 5,
'ReturnConsumedCapacity' => 'TOTAL'
));
echo "# Querying for Bob's 5 most recent orders in 2014:" . PHP_EOL;
foreach($response['Items'] as $item) {
echo '
- ' . $item['CustomerId']['S']. ' ' . $item['OrderCreationDate']['N']
. ' '
. $item['ProductName']['S'] . ' ' . $item['ProductCategory']['S'] . ' '
. $item['OrderStatus']['S'] . PHP_EOL;
}
echo ' Provisioned Throughput Consumed: ' . $response['ConsumedCapacity']['Ca
pacityUnits'] . PHP_EOL;
#########################################
# Query for Alice's open orders, fetching all attributes (which are already
projected into the index)
$response = $client->query(array(
'TableName' => $tableName,
'IndexName' => 'IsOpenIndex',
'KeyConditionExpression' => 'CustomerId = :v_id',
'ExpressionAttributeValues' => array (
':v_id' => array('S' => '[email protected]')
),
'Select' => 'ALL_ATTRIBUTES',
'ScanIndexForward' => false,
'ConsistentRead' => true,
'Limit' => 5,
'ReturnConsumedCapacity' => 'TOTAL'
));
echo "# Querying for Alice's open orders:" . PHP_EOL;
foreach($response['Items'] as $item) {
echo '
- ' . $item['CustomerId']['S']. ' ' . $item['OrderCreationDate']['N']
. ' '
. $item['ProductName']['S'] . ' ' . $item['ProductCategory']['S'] . ' '
. $item['OrderStatus']['S'] . PHP_EOL;
}
echo ' Provisioned Throughput Consumed: ' . $response['ConsumedCapacity']['Ca
pacityUnits'] . PHP_EOL;
#########################################
# Delete the table
echo "# Deleting table $tableName..." . PHP_EOL;
$client->deleteTable(array('TableName' => $tableName));
$client->waitUntilTableNotExists(array('TableName' => $tableName));
echo " Deleted table $tableName..." . PHP_EOL;
?>
Design For Uniform Data Access Across Items In Your Tables (p. 66)
Understand Partition Behavior (p. 68)
Use Burst Capacity Sparingly (p. 69)
Distribute Write Activity During Data Upload (p. 70)
Understand Access Patterns for Time Series Data (p. 71)
Cache Popular Items (p. 71)
Consider Workload Uniformity When Adjusting Provisioned Throughput (p. 72)
Test Your Application At Scale (p. 72)
For each item that is modified in a DynamoDB table, the stream records appear in the same sequence
as the actual modifications to the item.
DynamoDB Streams writes stream records in near real time, so that you can build applications that
consume these streams and take action based on the contents.
Note
AWS maintains separate endpoints for DynamoDB and DynamoDB Streams. To work with
database tables and indexes, your application will need to access a DynamoDB endpoint. To
read and process DynamoDB Streams records, your application will need to access a DynamoDB
Streams endpoint in the same region.
The naming convention for Streams endpoints is
streams.<dynamodb-region>.amazonaws.com. For example, if you use the endpoint
dynamodb.us-west-2.amazonaws.com to access DynamoDB, you would use the endpoint
streams.dynamodb.us-west-2.amazonaws.com to access DynamoDB Streams.
For a complete list of DynamoDB and Streams regions and endpoints, go to Regions and
Endpoints in the AWS General Reference.
Enabling a Stream
You can enable a stream on a new table when you create it. You can also enable or disable a stream on
an existing table, or change the settings of a stream. The StreamSpecification parameter determines
how the stream is configured:
StreamEnabledspecifies whether a stream is enabled (true) or disabled (false) for the table.
StreamViewTypespecifies the information that will be written to the stream whenever data in the
table is modified:
KEYS_ONLYonly the key attributes of the modified item.
NEW_IMAGEthe entire item, as it appears after it was modified.
OLD_IMAGEthe entire item, as it appeared before it was modified.
NEW_AND_OLD_IMAGESboth the new and the old images of the item.
DynamoDB Streams operates asynchronously, so there is no performance impact on a table if you enable
a stream.
You can enable or disable a stream at any time. However, note that you will receive a
ResourceInUseException if you attempt to enable a stream on a table that already has a stream, and
you will receive a ValidationException if you attempt to disable a stream on a table which does not have
a stream.
When you set StreamEnabled to true, DynamoDB creates a new stream with a unique stream descriptor
assigned to it. If you disable and then re-enable a stream on the table, a new stream will be created with
a different stream descriptor.
Every stream is uniquely identified by an Amazon Resource Name (ARN). Here is an example ARN for
a stream on a DynamoDB table named TestTable:
arn:aws:dynamodb:us-west-2:111122223333:table/TestTable/stream/2015-0511T21:21:33.291
To determine the latest stream descriptor for a table, issue a DynamoDB DescribeTable request and
look for the LatestStreamArn element in the response.
Note
If you perform a PutItem or UpdateItem operation that does not change any data in an item,
then DynamoDB Streams will not write a stream record for that operation.
To access a stream and process the stream records within, you must do the following:
Determine the unique Amazon Resource Name (ARN) of the stream that you want to access.
Determine which shard(s) in the stream contain the stream records that you are interested in.
Access the shard(s) and retrieve the stream records that you want.
Note
No more than 2 processes at most should be reading from the same Streams shard at the same
time. Having more than 2 readers per shard may result in throttling.
The DynamoDB Streams API provides the following actions for use by application programs:
ListStreamsreturns a list of stream descriptors for the current account and endpoint. You can
optionally request just the stream descriptors for a particular table name.
DescribeStreamreturns detailed information about a given stream. The output includes a list of
shards associated with the stream, including the shard IDs.
GetShardIteratorreturns a shard iterator, which describes a location within a shard. You can
request that the iterator provide access to the oldest point, the newest point, or a particular point in the
stream.
GetRecordsreturns the stream records from within a given shard.You must provide the shard iterator
returned from a GetShardIterator request.
For complete descriptions of these API actions, including example requests and responses, go to the
Amazon DynamoDB Streams API Reference.
These steps are described in the following sections, and the complete application is shown at the end of
the walkthrough.
Topics
Step 1: Create a Table with a Stream Enabled (p. 362)
Step 2: Describe the Streams Settings For The Table (p. 362)
Step 3: Modify data in the table (p. 363)
Step 4: Describe the Shards in the Stream (p. 363)
Step 5: Read the Stream Records (p. 364)
Step 6: Clean Up (p. 364)
Complete Program: Low-Level Streams API (p. 365)
ArrayList<AttributeDefinition> attributeDefinitions =
new ArrayList<AttributeDefinition>();
attributeDefinitions.add(new AttributeDefinition()
.withAttributeName("Id")
.withAttributeType("N"));
ArrayList<KeySchemaElement> keySchema = new ArrayList<KeySchemaElement>();
keySchema.add(new KeySchemaElement()
.withAttributeName("Id")
.withKeyType(KeyType.HASH));
StreamSpecification streamSpecification = new StreamSpecification();
streamSpecification.setStreamEnabled(true);
streamSpecification.setStreamViewType(StreamViewType.NEW_AND_OLD_IMAGES);
CreateTableRequest createTableRequest = new CreateTableRequest()
.withTableName(tableName)
.withKeySchema(keySchema)
.withAttributeDefinitions(attributeDefinitions)
.withProvisionedThroughput(new ProvisionedThroughput()
.withReadCapacityUnits(1L)
.withWriteCapacityUnits(1L))
.withStreamSpecification(streamSpecification);
Name);
String myStreamArn = describeTableResult.getTable().getLatestStreamArn();
StreamSpecification myStreamSpec =
describeTableResult.getTable().getStreamSpecification();
System.out.println("Current stream ARN for " + tableName + ": "+ myStreamArn);
System.out.println("Stream enabled: "+ myStreamSpec.getStreamEnabled());
System.out.println("Update view type: "+ myStreamSpec.getStreamViewType());
DescribeStreamResult describeStreamResult =
streamsClient.describeStream(new DescribeStreamRequest()
.withStreamArn(myStreamArn));
String streamArn =
describeStreamResult.getStreamDescription().getStreamArn();
List<Shard> shards =
describeStreamResult.getStreamDescription().getShards();
Step 6: Clean Up
The demo is complete, so we can delete the table. Note that the stream associated with this table will
remain available for reading, even though the table is deleted. The stream will be automatically deleted
after 24 hours.
dynamoDBClient.deleteTable(tableName);
java.util.ArrayList;
java.util.HashMap;
java.util.List;
java.util.Map;
import
import
import
import
import
import
import
import
import
import
import
com.amazonaws.auth.profile.ProfileCredentialsProvider;
com.amazonaws.services.dynamodbv2.AmazonDynamoDBClient;
com.amazonaws.services.dynamodbv2.AmazonDynamoDBStreamsClient;
com.amazonaws.services.dynamodbv2.model.AttributeAction;
com.amazonaws.services.dynamodbv2.model.AttributeDefinition;
com.amazonaws.services.dynamodbv2.model.AttributeValue;
com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate;
com.amazonaws.services.dynamodbv2.model.CreateTableRequest;
com.amazonaws.services.dynamodbv2.model.DescribeStreamRequest;
com.amazonaws.services.dynamodbv2.model.DescribeStreamResult;
com.amazonaws.services.dynamodbv2.model.DescribeTableResult;
import
import
import
import
import
import
import
import
import
import
import
import
import
com.amazonaws.services.dynamodbv2.model.GetRecordsRequest;
com.amazonaws.services.dynamodbv2.model.GetRecordsResult;
com.amazonaws.services.dynamodbv2.model.GetShardIteratorRequest;
com.amazonaws.services.dynamodbv2.model.GetShardIteratorResult;
com.amazonaws.services.dynamodbv2.model.KeySchemaElement;
com.amazonaws.services.dynamodbv2.model.KeyType;
com.amazonaws.services.dynamodbv2.model.ProvisionedThroughput;
com.amazonaws.services.dynamodbv2.model.Record;
com.amazonaws.services.dynamodbv2.model.Shard;
com.amazonaws.services.dynamodbv2.model.ShardIteratorType;
com.amazonaws.services.dynamodbv2.model.StreamSpecification;
com.amazonaws.services.dynamodbv2.model.StreamViewType;
com.amazonaws.services.dynamodbv2.util.Tables;
DescribeStreamResult describeStreamResult =
streamsClient.describeStream(new DescribeStreamRequest()
.withStreamArn(myStreamArn));
String streamArn =
describeStreamResult.getStreamDescription().getStreamArn();
List<Shard> shards =
describeStreamResult.getStreamDescription().getShards();
// Process each shard
for (Shard shard : shards) {
String shardId = shard.getShardId();
System.out.println(
"Processing " + shardId + " from stream "+ streamArn);
// Get an iterator for the current shard
GetShardIteratorRequest getShardIteratorRequest = new GetShardIter
atorRequest()
.withStreamArn(myStreamArn)
.withShardId(shardId)
.withShardIteratorType(ShardIteratorType.TRIM_HORIZON);
GetShardIteratorResult getShardIteratorResult =
streamsClient.getShardIterator(getShardIteratorRequest);
String nextItr = getShardIteratorResult.getShardIterator();
With the DynamoDB Streams Kinesis Adapter in place, you can begin developing against the KCL
interface, with the API calls seamlessly directed at the Streams endpoint.
When your application starts, it calls the KCL to instantiate a worker. You must provide the worker with
configuration information for the application, such as the stream descriptor and AWS credentials, and the
name of a record processor class that you provide. As it runs the code in the record processor, the worker
performs the following tasks:
Connects to the stream.
Enumerates the shards within the stream.
Coordinates shard associations with other workers (if any).
Instantiates a record processor for every shard it manages.
Pulls records from the stream.
Pushes the records to the corresponding record processor.
Checkpoints processed records.
API Version 2012-08-10
370
Note
For a description of the KCL concepts listed above, go to Building an Amazon Kinesis Application
in the Amazon Kinesis Developer Guide.
The following code snippet shows the main loop in StreamsRecordProcessor. The case statement
determines what action to perform, based on the OperationType that appears in the stream record.
if(StreamsAdapterDemoHelper.scanTable(dynamoDBClient,
srcTable).getItems().equals(StreamsAdapterDemoHelper.scanTable(dynamoDBClient,
destTable).getItems())) {
System.out.println("Scan result is equal.");
} else {
System.out.println("Tables are different!");
}
Step 5: Clean Up
The demo is complete, so the application deletes the source and destination tables. See the following
code snippet.
Even after the tables are deleted, their streams remain available for up to 24 hours, after which they are
automatically deleted.
dynamoDBClient.deleteTable(new DeleteTableRequest().withTableName(srcTable));
dynamoDBClient.deleteTable(new DeleteTableRequest().withTableName(destTable));
StreamsAdapterDemo.java
// Copyright 2012-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
// Licensed under the Apache License, Version 2.0.
package com.amazonaws.codesamples.gsg;
import com.amazonaws.ClientConfiguration;
import com.amazonaws.auth.AWSCredentialsProvider;
import com.amazonaws.auth.profile.ProfileCredentialsProvider;
import com.amazonaws.services.cloudwatch.AmazonCloudWatchClient;
import com.amazonaws.services.dynamodbv2.AmazonDynamoDBClient;
import com.amazonaws.services.dynamodbv2.model.DeleteTableRequest;
import com.amazonaws.services.dynamodbv2.model.DescribeTableResult;
import com.amazonaws.services.dynamodbv2.streamsadapter.AmazonDynamoDBStreamsAd
apterClient;
import com.amazonaws.services.kinesis.clientlibrary.interfaces.IRecordProcessor
Factory;
import com.amazonaws.services.kinesis.clientlibrary.lib.worker.InitialPosition
InStream;
import com.amazonaws.services.kinesis.clientlibrary.lib.worker.KinesisClientLib
Configuration;
import com.amazonaws.services.kinesis.clientlibrary.lib.worker.Worker;
public class StreamsAdapterDemo {
private static Worker worker;
private static KinesisClientLibConfiguration workerConfig;
private static IRecordProcessorFactory recordProcessorFactory;
private static AmazonDynamoDBStreamsAdapterClient adapterClient;
private static AWSCredentialsProvider streamsCredentials;
static
static
static
static
static
String
String
String
String
String
serviceName = "dynamodb";
dynamodbEndpoint = "DYNAMODB_ENDPOINT_GOES_HERE";
streamsEndpoint = "STREAMS_ENDPOINT_GOES_HERE";
tablePrefix = "KCL-Demo";
streamArn;
/**
* @param args
*/
public static void main(String[] args) throws Exception {
System.out.println("Starting demo...");
String srcTable = tablePrefix + "-src";
String destTable = tablePrefix + "-dest";
streamsCredentials = new ProfileCredentialsProvider();
dynamoDBCredentials = new ProfileCredentialsProvider();
recordProcessorFactory = new StreamsRecordProcessorFactory(dynamoDBCre
dentials, dynamodbEndpoint, serviceName, destTable);
Thread.sleep(25000);
worker.shutdown();
t.join();
if(StreamsAdapterDemoHelper.scanTable(dynamoDBClient,
srcTable).getItems().equals(StreamsAdapterDemoHelper.scanTable(dynamoDBClient,
destTable).getItems())) {
System.out.println("Scan result is equal.");
} else {
System.out.println("Tables are different!");
}
System.out.println("Done.");
cleanupAndExit(0);
}
private static void setUpTables() {
String srcTable = tablePrefix + "-src";
String destTable = tablePrefix + "-dest";
streamArn = StreamsAdapterDemoHelper.createTable(dynamoDBClient,
srcTable);
StreamsAdapterDemoHelper.createTable(dynamoDBClient, destTable);
awaitTableCreation(srcTable);
performOps(srcTable);
}
private static void awaitTableCreation(String tableName) {
Integer retries = 0;
Boolean created = false;
while(!created && retries < 100) {
DescribeTableResult result = StreamsAdapterDemoHelper.de
scribeTable(dynamoDBClient, tableName);
created = result.getTable().getTableStatus().equals("ACTIVE");
if (created) {
System.out.println("Table is active.");
return;
} else {
retries++;
try {
Thread.sleep(1000);
} catch(InterruptedException e) {
// do nothing
}
}
}
System.out.println("Timeout after table creation. Exiting...");
cleanupAndExit(1);
}
private static void performOps(String tableName) {
StreamsAdapterDemoHelper.putItem(dynamoDBClient, tableName, "101", "test1");
StreamsAdapterDemoHelper.updateItem(dynamoDBClient, tableName, "101",
"test2");
StreamsAdapterDemoHelper.deleteItem(dynamoDBClient, tableName, "101");
StreamsRecordProcessor.java
// Copyright 2012-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
// Licensed under the Apache License, Version 2.0.
package com.amazonaws.codesamples.gsg;
import java.nio.charset.Charset;
import java.util.List;
import com.amazonaws.services.dynamodbv2.AmazonDynamoDBClient;
import com.amazonaws.services.dynamodbv2.streamsadapter.model.RecordAdapter;
import com.amazonaws.services.kinesis.clientlibrary.interfaces.IRecordProcessor;
import com.amazonaws.services.kinesis.clientlibrary.interfaces.IRecordPro
cessorCheckpointer;
import com.amazonaws.services.kinesis.clientlibrary.types.ShutdownReason;
import com.amazonaws.services.kinesis.model.Record;
public class StreamsRecordProcessor implements IRecordProcessor {
private Integer checkpointCounter;
private final AmazonDynamoDBClient dynamoDBClient;
private final String tableName;
public StreamsRecordProcessor(AmazonDynamoDBClient dynamoDBClient, String
tableName) {
this.dynamoDBClient = dynamoDBClient;
this.tableName = tableName;
}
@Override
public void initialize(String shardId) {
checkpointCounter = 0;
}
@Override
public void processRecords(List<Record> records,
IRecordProcessorCheckpointer checkpointer) {
for(Record record : records) {
String data = new String(record.getData().array(), Charset.for
Name("UTF-8"));
System.out.println(data);
if(record instanceof RecordAdapter) {
com.amazonaws.services.dynamodbv2.model.Record streamRecord =
((RecordAdapter) record).getInternalObject();
switch(streamRecord.getEventName()) {
case "INSERT" : case "MODIFY" :
StreamsAdapterDemoHelper.putItem(dynamoDBClient, tableName,
streamRecord.getDynamodb().getNewImage());
break;
case "REMOVE" :
StreamsAdapterDemoHelper.deleteItem(dynamoDBClient, table
Name, streamRecord.getDynamodb().getKeys().get("Id").getN());
}
}
checkpointCounter += 1;
if(checkpointCounter % 10 == 0) {
try {
checkpointer.checkpoint();
} catch(Exception e) {
e.printStackTrace();
}
}
}
}
@Override
public void shutdown(IRecordProcessorCheckpointer checkpointer,
ShutdownReason reason) {
if(reason == ShutdownReason.TERMINATE) {
try {
checkpointer.checkpoint();
} catch (Exception e) {
e.printStackTrace();
}
}
}
}
StreamsRecordProcessorFactory.java
// Copyright 2012-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
// Licensed under the Apache License, Version 2.0.
package com.amazonaws.codesamples.gsg;
import com.amazonaws.ClientConfiguration;
import com.amazonaws.auth.AWSCredentialsProvider;
import com.amazonaws.services.dynamodbv2.AmazonDynamoDBClient;
import com.amazonaws.services.kinesis.clientlibrary.interfaces.IRecordProcessor;
import com.amazonaws.services.kinesis.clientlibrary.interfaces.IRecordProcessor
Factory;
public class StreamsRecordProcessorFactory implements
IRecordProcessorFactory {
private final AWSCredentialsProvider dynamoDBCredentials;
private final String dynamoDBEndpoint;
private final String tableName;
public StreamsRecordProcessorFactory(
AWSCredentialsProvider dynamoDBCredentials,
String dynamoDBEndpoint,
String serviceName,
String tableName) {
this.dynamoDBCredentials = dynamoDBCredentials;
this.dynamoDBEndpoint = dynamoDBEndpoint;
this.tableName = tableName;
}
@Override
public IRecordProcessor createProcessor() {
AmazonDynamoDBClient dynamoDBClient = new AmazonDynamoDBClient(dynamoD
BCredentials, new ClientConfiguration());
dynamoDBClient.setEndpoint(dynamoDBEndpoint);
return new StreamsRecordProcessor(dynamoDBClient, tableName);
}
}
StreamsAdapterDemoHelper.java
// Copyright 2012-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
// Licensed under the Apache License, Version 2.0.
package com.amazonaws.codesamples.gsg;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Map;
import
import
import
import
import
import
import
import
import
import
import
import
import
import
import
com.amazonaws.services.dynamodbv2.AmazonDynamoDBClient;
com.amazonaws.services.dynamodbv2.model.AttributeAction;
com.amazonaws.services.dynamodbv2.model.AttributeDefinition;
com.amazonaws.services.dynamodbv2.model.AttributeValue;
com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate;
com.amazonaws.services.dynamodbv2.model.CreateTableRequest;
com.amazonaws.services.dynamodbv2.model.CreateTableResult;
com.amazonaws.services.dynamodbv2.model.DeleteItemRequest;
com.amazonaws.services.dynamodbv2.model.DescribeTableRequest;
com.amazonaws.services.dynamodbv2.model.DescribeTableResult;
com.amazonaws.services.dynamodbv2.model.KeySchemaElement;
com.amazonaws.services.dynamodbv2.model.KeyType;
com.amazonaws.services.dynamodbv2.model.ProvisionedThroughput;
com.amazonaws.services.dynamodbv2.model.PutItemRequest;
com.amazonaws.services.dynamodbv2.model.ResourceInUseException;
import
import
import
import
import
com.amazonaws.services.dynamodbv2.model.ScanRequest;
com.amazonaws.services.dynamodbv2.model.ScanResult;
com.amazonaws.services.dynamodbv2.model.StreamSpecification;
com.amazonaws.services.dynamodbv2.model.StreamViewType;
com.amazonaws.services.dynamodbv2.model.UpdateItemRequest;
Overview
The following diagram provides an overview of a cross-region replication setup.
You launch a preconfigured AWS CloudFormation stack. This is a one-time operation that
takes approximately 20 minutes to complete.
The AWS CloudFormation stack uses AWS Elastic Beanstalk to launch the Replication
Coordinator and DynamoDB Connector into the Amazon EC2 Container Service (Amazon
ECS).
You use the Cross Region Replication Console to create a replication group.
The Replication Coordinator allocates all of the necessary resources, including metadata
tables and replica tables in other regions. This operation can take up to 30 minutes to
complete.
The DynamoDB Connector reads and processes incoming records from the stream on the
master table in DynamoDB.
After the initial setup, the following components are used to perform the replication tasks.
Cross Region Replication Consolea standalone web application that resembles the AWS
Management Console. This application allows you to:
Define a replication group, consisting of a master table and at least one replica. The master and the
replica(s) must have the same key schema and attribute definition. A replica can be located in the
same AWS region as the master, or in a different region.
Launch the replication group. The Cross Region Replication Console communicates with the
Replication Coordinator to perform create, delete, and update operations for the replication group.
Monitor the performance of replication groups and their members.
Add and remove replicas from a replication group, or delete a replication group.
Replication Coordinatoran application running on Amazon EC2 Container Service that does the
following:
Responds to user requests from the Cross Region Replication Console.
Manages replication states and physical copies of a table.
Creates and maintains the following DynamoDB tables:
One metadata table that keeps track of replication activity and enables recovery from failures.
One KCL checkpoint table for tracking Kinesis Client Library (KCL) processing.
An additional KCL checkpoint table per replication path. For example, if you have a replication
group with three replicas, the Replication Coordinator will create three additional KCL checkpoint
table. Each additional KCL checkpoint table is created in the same AWS region as its corresponding
replica.
Amazon Web Services provides a prewritten AWS CloudFormation template that launches the Replication
Coordinator on a customer-provided Amazon ECS cluster.
DynamoDB Connectoran application that contains the low-level processing logic for replication from
a source table to a destination table. The DynamoDB Connector does the following:
Reads incoming Streams records for the source table, using the Kinesis Client Library (KCL) and
the DynamoDB Streams Kinesis Adapter libraries.
Analyzes each Streams record to determine whether that record is necessary for the current replication
tasks.
Groups related records into batches, based on primary key values. Duplicate records are removed.
Issues asynchronous conditional write requests to the replica table, in parallel.
3.
4.
Table NameSourceTable
Primary Key TypeHash
c.
d.
Click Continue.
5.
6.
On the Add Indexes page, click Continue. You will not need any indexes for this exercise.
On the Provisioned Throughput page, click Continue.
7.
8.
Select the Enable Streams option. Set the View Type to New and Old Images.
Deselect the Use Basic Alarms option. You will not need alarms for this exercise.
Important
Do not delete individual components used by cross region replication. If you do, your replication
environment will not function correctly.
If you want to remove cross region replication entirely, see (Optional) Step 5: Clean Up (p. 388).
2.
View Template
When you are ready to launch the stack, click this button:
3.
4.
For this walkthrough, you will use the default settings. However, note that this page lets you customize
the name of the AWS CloudFormation stack, or use a different template.
On the Specify Parameters page, click Next.
For this walkthrough, you will use the default settings. However, note that this page lets you customize
the settings for Amazon ECS instance(s), and the name and region of the DynamoDB metadata
table.
5.
6.
Select "I acknowledge that this template might cause AWS CloudFormation to create IAM
resources."
Click Create.
While the stack is deploying, you can monitor its progress by going to the AWS CloudFormation
console and viewing the Status column for the Replication Coordinator and the Elastic Beanstalk
environment.
You can proceed to the next step after the Status for both of these environments is
UPDATE_COMPLETE.
Note
This AWS CloudFormation template creates an Amazon SQS queue that permits access
to DynamoDB tables and other resources needed for replication. Click here to review the
AWS CloudFormation template.
If you adapt this cross-region replication solution for your own use, you should create an
AWS Identity and Access Management role with access to the Amazon SQS queue, and
then attach that role to IAM users that require access to this application. For more information,
go to Amazon SQS Policy Examples in the Amazon Simple Queue Service Developer Guide.
7.
If you launch the above stack in one of the following regions, please skip this step:
us-east-1
us-west-2
eu-west-1
ap-northeast-1
ap-southeast-2
Otherwise, you will need to launch a second stack because the cross-region replication application
relies on Amazon EC2 Container Service, which is currently not available in certain AWS regions.
Please use the following template to launch a second stack in a specified region, according to our
recommendation:
https://dynamodb-cross-region.s3.amazonaws.com/dynamodb-replication-ecs-cluster.template
Regions
Orignal Stack Region
us-west-1
us-west-2
eu-central-1
eu-west-1
ap-southeast-1
ap-southeast-2
sa-east-1
us-east-1
Launch buttons
You should wait for the stack to change status to CREATE_COMPLETE, before moving onto Step 3 of this
walkthrough.
API Version 2012-08-10
386
2.
Select the stack with the following description: DynamoDB Cross Region Replication
Coordinator
3.
Click the Outputs tab, where you should see the following:
KeyReplicationConsoleURL
Valuea system-generated URL
Descriptiona link to the Cross Region Replication Console
4.
5.
6.
7.
Click the link shown in the Value. This will launch the Cross Region Replication Console.
Enter your AWS access key ID and secret key when you are prompted to do so, and then click
Confirm.
In the Cross Region Replication Console, on the Replication Group page, click Create.
On the Create Replication Group page, do the following:
a.
b.
c.
8.
Note
You should allow 30 minutes for the replication group to be fully configured. You can monitor
progress by going to the Cross Region Replication Console, selecting your replication group,
and clicking Status. When the status is ACTIVE, you can proceed to the next step.
Step 4: Test Your Replication Setup (p. 388)
3.
4.
5.
Click PutItem.
Repeat the previous step to add two more data items:
Id2 and MessageSecond item
Id3 and MessageThird item
6.
7.
8.
9.
In the upper right corner of the window, choose US West (Oregon) from the region selector.
In the list of tables, double-click ReplicaTable.
Verify that the data in ReplicaTable is the same as that in SourceTable.
(Optional) Go back to the SourceTable in us-east-1 and do the following:
Update item 2. Set the Message to Hello from us-east-1!
Delete item 3.
Go to us-west-2 and verify that the data in ReplicaTable is the same as that in SourceTable.
3.
4.
Note
You should allow 15 minutes for the stack to be deleted.
API Version 2012-08-10
388
Deleting the Replication Coordinator does not delete any of the DynamoDB tables. If you want
to delete the master, replica(s), or metadata tables, you will need to wait until the AWS
CloudFormation stack is deleted, and then delete the tables using the AWS Management Console
for DynamoDB.
Troubleshooting
This section covers some basic failure modes and troubleshooting for DynamoDB cross-region replication.
Topics
Access Your Amazon CloudWatch Logs (p. 389)
Problems Creating a Replication Group (p. 389)
Replication Group Stuck in CREATING Status (p. 391)
Narrowing the Scope of a User's IAM Policy (p. 392)
Note
Be sure to check all of the relevant AWS regions for CloudWatch Logs. For cross-region
replication, the logs are published to the local region of the EC2 instance hosting the replication
process.
To choose a different AWS region, go to the upper right corner of the console window and click
the region selector.
Following are the replication-related log groups and the events recorded in each:
DynamoDBCrossRegionReplicationServerRequests that are sent by the replication console, such
as creating a replication group, adding a replication member, etc.
DynamoDBCrossRegionReplicationCoordinatorLaunches or deletions of replication-related
resources, such as starting a table copy, DynamoDB connector activity (replicating live updates), etc.
DynamoDBCrossRegionReplicationTableCopyEvents that are related to the table copy process,
which replicates existing items in the master table to the replica table(s).
DynamoDBCrossRegionReplicationConnectorsEvents in the live update replication process,
where real-time writes to the master table are copied to the replica table(s).
Both of these are hosted by AWS Elastic Beanstalk. To resolve the issue, you can rebuild the Elastic
Beanstalk environment
1.
2.
In the All Applications section, select the environment associated with the DynamoDB Replication
Coordinator application.
3.
From the Actions menu in the upper right-hand corner, choose Rebuild Environment.
4.
A warning message appears, informing you that the rebuild will take several minutes. Click Rebuild
to proceed.
You can monitor the progress by monitoring the Recent Events section of the Elastic Beanstalk console.
When the message Successfully rebuilt environment appears, the rebuild is complete.
At this point, you can go to the AWS CloudFormation console and view the
DynamoDBReplicationCoordinator stack. When its status reaches UPDATE_COMPLETE, you can go to
the Cross Region Replication Console (using the ReplicationConsoleUrl link in the Outputs tab) and
create your replication group.
Following these steps should ensure that the Replication Coordinator and the SQS queue are working
properly. If you are still having trouble creating a replication group, or if the replication group shows up
in the Cross Region Replication Console with a "failure" status, you should consult your CloudWatch Logs
for the latest diagnostic messages. For more information, see Access Your Amazon CloudWatch
Logs (p. 389).
To increase the number of Amazon EC2 instances available for Amazon ECS tasks
1.
2.
3.
4.
5.
6.
7.
8.
Note
As a rule of thumb, each replication connection (from one table to another) requires 512 MB of
memory and 512 CPU units. For example, if you have two replication paths (one master replicating
to two replica tables), you would need either two t1.micro instances, or one t2.micro instance.
To optimize cost, the default Amazon EC2 instance type is t1.micro. Instead of increasing the
cluster size, you can try using a larger instance type. To do this, follow the procedure above, but
this time adjust the EcsInstanceType parameter from t1.micro to t2.micro.
The new parameter setting(s) for your DynamoDBReplicationCoordinator stack will take effect when
stack's status changes from UPDATE_IN_PROGRESS to UPDATE_COMPLETE. You must wait for the
UPDATE_COMPLETE status before you attempt to access the Cross Region Replication Console (using
the ReplicationConsoleUrl link in the Outputs tab). Before you try to re-create the replication groups
using your new Amazon EC2 parameters, make sure that you delete any failed replication groups first.
https://dynamodb-cross-region-replication-console.s3.amazonaws.com/in
dex.html#/?AccountId=123456789123
&SQSUrl=https://sqs.us-east-1.amazonaws.com/123456789123/awseb-e-gdhsk6d5jkstack-AWSEBWorkerQueue-9FASHEYAJMQH
&SQSDeadLetterUrl=https://queue.amazonaws.com/123456789123/awseb-egdhsk6d5jk-stack-AWSEBWorkerDeadLetterQueue-UV6KA9IWJLA1
&SQSRegion=us-east-1
&MetadataTableName=CoordinatorMetadata
&MetadataTableRegion=us-east-1
Based on the information in this link, here is a sample IAM policy that would allowing minimal permissions
for Cross Region Replication Console access:
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "Stmt1436394463022",
"Action": [
"dynamodb:DescribeTable",
"dynamodb:GetItem",
"dynamodb:Query",
"dynamodb:Scan"
],
"Effect": "Allow",
"Resource": "arn:aws:dynamodb:us-east-1:123456789123:table/Coordin
atorMetadata"
},
{
"Sid": "Stmt1436394552396",
"Action": [
"cloudwatch:DescribeAlarmHistory",
"cloudwatch:DescribeAlarms",
"cloudwatch:DescribeAlarmsForMetric",
"cloudwatch:GetMetricStatistics"
],
"Effect": "Allow",
"Resource": "*"
},
{
"Sid": "Stmt1436394630482",
"Action": [
"sqs:DeleteMessage",
"sqs:ReceiveMessage"
],
"Effect": "Allow",
"Resource": "arn:aws:sqs:us-east-1:123456789123:awseb-e-gdhsk6d5jkstack-AWSEBWorkerDeadLetterQueue-UV6KA9IWJLA1"
},
{
"Sid": "Stmt1436394673542",
"Action": ["sqs:SendMessage"],
"Effect": "Allow",
"Resource": "arn:aws:sqs:us-east-1:123456789123:awseb-e-gdhsk6d5jkstack-AWSEBWorkerQueue-9FASHEYAJMQH"
},
{
"Sid": "Stmt1436394762899",
"Action": [
"dynamodb:DescribeTable",
"dynamodb:ListTables"
],
"Effect": "Allow",
"Resource": "*"
}
]
}
Note
For more information on AWS Lambda, go to the AWS Lambda Developer Guide.
Topics
Walkthrough: Using the AWS Management Console to Create a DynamoDB Trigger (p. 394)
2.
3.
4.
5.
Choose Continue.
In the Add Indexes window, choose Continue. This will skip creating indexes on the table.
In the Provisioned Throughput Capacity window, choose Continue.This will use default provisioned
throughput settings for the table.
6.
7.
Choose Continue.
In the Review window, review all of your settings to ensure each value is what you want, and then
choose Create.
DynamoDB will begin creating the table.You will need to wait until the table status becomes ACTIVE.
4.
Choose Next
In the Configure function section, do the following:
In the Name field, type StreamsLambdaFunction. (This is the name of the function that we will
use for this walkthrough.)
Leave the Runtime field at its default setting: Node.js .
5.
Do not modify any fields in the Lambda function code section.You will use the pre-provided Node.js
code.
API Version 2012-08-10
395
6.
7.
On the Review page, go to Enable event source and choose Enable now.
Leave all of the other settings on this page their default values, and then choose Create function.
3.
4.
5.
6.
Repeat these steps at least two more times, in order to write more data items to the table.
In the Explore Table window, select Scan and then choose Go to view the contents of the table.
Select one of the items, choose Edit, and then do the following:
Type an Id key value of your choice, and add any additional attributes you want.
Choose Save.
In the confirmation window, choose OK.
7.
8.
Repeat these steps at least two more times, in order to update the items in the table.
In the Explore Table window, select Scan and then choose Go to view the contents of the table.
Select one of the items and choose Delete. In the confirmation window, choose OK. This will remove
one of the items from the table.
Step 4: View The Lambda Function Output in CloudWatch Logs (p. 396)
1.
2.
3.
Choose the Monitoring tab to view CloudWatch graphs that show runtime metrics for your Lambda
function.
4.
5.
DynamoDB Console
Topics
Working with Items and Attributes (p. 400)
Monitoring Tables (p. 406)
Setting Up CloudWatch Alarms (p. 406)
Exporting and Importing Data (p. 407)
The AWS Management Console for Amazon DynamoDB is available at https://console.aws.amazon.com/
dynamodb/home. The console enables you to do the following:
Create, update, and delete tables. The throughput calculator provides you with estimates of how many
capacity units you will need to request based on the usage information you provide.
View items stored in a tables, add, update, and delete items.
Query a table.
Set up alarms to monitor your table's capacity usage.
View your table's top monitoring metrics on real-time graphs from CloudWatch.
View alarms configured for each table and create custom alarms.
If your account doesn't already have tables in DynamoDB, the console displays an introductory screen
that prompts you to create your first table. This screen also provides an overview of the process for
creating a table, and links to relevant documentation and resources.
You can find detailed steps for creating your first table in the console in Creating Tables and Loading
Sample Data (p. 14). Once you have one or more tables, the console displays the tables as a list. You
can select a table from the list to see additional information in the lower pane. In the lower pane, you also
have the option to set up alarms and view CloudWatch metrics for the table.
The Explore Table option enables you to view existing items in a table, add new items, update items, or
delete items. You can also query the table. For more information, see Working with Items and
Attributes (p. 400).
Adding an Item
You can upload a large number of items programmatically. However, the console provides a way for you
to upload an item without having to write any code.
To add an item
1.
Sign in to the AWS Management Console and open the DynamoDB console at https://
console.aws.amazon.com/dynamodb/.
2.
3.
4.
The Put Item tab shows data entry fields for you to enter the required primary key attribute values.
If the table has any secondary indexes, then the console also shows data entry fields for index key
values.
The following screen shot shows the primary key attributes of the Reply table (Id and ReplyDateTime)
and PostedByIndex (PostedBy).
5.
If you want to add more attributes, click the action menu to the left of PostedBy. In the action menu,
click Append, and then click the data type you want.
Type the new attribute name and value in the fields provided.
6.
Repeat this step as often as needed if you want to add more attributes.
When the item is as you want it, click Save to add the new item to the table.
Deleting an Item
You can delete one item at a time using the console.
To delete an item
1.
2.
Sign in to the AWS Management Console and open the DynamoDB console at https://
console.aws.amazon.com/dynamodb/.
In the Tables pane, select a table and click Explore Table.
3.
In the Browse Items tab, click on the item in the table that you want to remove, and click the Delete
Item button.
4.
Updating an Item
You can update an item through the DynamoDB console using the Browse Items tab.
To update an item
1.
Sign in to the AWS Management Console and open the DynamoDB console at https://
console.aws.amazon.com/dynamodb/.
2.
3.
In the Browse Items tab, click on the item in the table that you want to update, and click the Edit
Item button.
4.
Copying an Item
You can use an existing item to create a new item through the DynamoDB console.
Sign in to the AWS Management Console and open the DynamoDB console at https://
console.aws.amazon.com/dynamodb/.
2.
3.
In the Browse Items tab, click on the item in the table that you want to copy, and click the Copy to
New button.
4.
Change the hash and/or range key to avoid overwriting the original item, and change other attributes
or values as desired. When you are ready to add the new item to the table, click Save.
If you forget to update the hash and/or range keys, you'll see a warning that you're about to overwrite
the original item. Click Cancel, update the keys, and click Save to save the changes.
API Version 2012-08-10
405
Monitoring Tables
The console for DynamoDB displays some metrics for your table in the lower pane. If you need to see
other metrics, you can use the console for DynamoDB to set parameters for CloudWatch to display
information about your table.
To see the CloudWatch metrics for your table, with your table selected, click the Monitoring tab. You
can expand the CloudWatch alarms and Alarm History sections to see more details about alarms that
have been triggered. Also, you can view your CloudWatch metrics on this tab in convenient, real-time
graphs.
Note
CloudWatch metrics do appear in real-time in the console. However, DynamoDB updates the
Storage Size value approximately only every six hours. Recent changes might not be reflected
in this value.
For more information about CloudWatch metrics for DynamoDB, see Monitoring DynamoDB with
CloudWatch (p. 577).
When you make a selection in the "Advanced CloudWatch Alarms" section of the Alarm Setup tab, you
are redirected to the CloudWatch console. For more information about setting up alarms, see the
CloudWatch Help in the CloudWatch console, or go to the CloudWatch Documentation.
Higher-Level Programming
Interfaces for DynamoDB
The AWS SDKs provide applications with low-level interfaces for working with Amazon DynamoDB.These
client-side API classes and methods correspond directly to the DynamoDB server-side API. However,
many developers experience a sense of disconnect, or "impedance mismatch", when they need to map
complex data types to items in a database table. With a low-level database API, developers must write
methods for reading or writing object data to database tables, and vice-versa. The amount of extra code
required for each combination of object type and database table can seem overwhelming.
To simplify development, the AWS SDKs for Java and .NET provide additional APIs with higher levels of
abstraction, in addition to the low-level APIs. The higher-level interfaces for DynamoDB let you define
the relationships between objects in your program and the database tables that store those objects' data.
After you define this mapping, you call simple object methods such as save, load, or delete, and the
underlying low-level DynamoDB APIs are automatically invoked on your behalf. This allows you to write
object-centric code, rather than database-centric code.
The higher-level programming interfaces for DynamoDB are available in the AWS SDKs for Java and
.NET.
Java
Java: Object Persistence Model (p. 409)
.NET
.NET: Document Model (p. 446)
.NET: Object Persistence Model (p. 477)
Note
The object persistence model lets you query database tables and perform item operations such
as saving, updating, or deleting. However, the object persistence model does not provide APIs
to create, update, or delete tables. To perform those tasks, use AWS SDK for Java Document
API instead. For more information, see Working with Tables Using the AWS SDK for Java
Document API (p. 73).
The AWS SDK for Java provides a set of annotation types, so that you can map your classes to tables.
For example, consider a ProductCatalog table that has Id as the hash primary key.
ProductCatalog(Id, ...)
You can map a class in your client application to the ProductCatalog table as shown in the following Java
code. This code snippet defines a Plain Old Java Object (POJO) named CatalogItem, which uses
annotation types to map object fields to DynamoDB attribute names:
package com.amazonaws.codesamples;
import java.util.Set;
import
import
import
import
com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBAttribute;
com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBHashKey;
com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBIgnore;
com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBTable;
@DynamoDBTable(tableName="ProductCatalog")
public class CatalogItem {
private
private
private
private
private
Integer id;
String title;
String ISBN;
Set<String> bookAuthors;
String someProp;
@DynamoDBHashKey(attributeName="Id")
public Integer getId() { return id;}
public void setId(Integer id) {this.id = id;}
@DynamoDBAttribute(attributeName="Title")
public String getTitle() {return title; }
public void setTitle(String title) { this.title = title; }
@DynamoDBAttribute(attributeName="ISBN")
public String getISBN() { return ISBN; }
public void setISBN(String ISBN) { this.ISBN = ISBN; }
@DynamoDBAttribute(attributeName = "Authors")
public Set<String> getBookAuthors() { return bookAuthors; }
public void setBookAuthors(Set<String> bookAuthors) { this.bookAuthors =
bookAuthors; }
@DynamoDBIgnore
public String getSomeProp() { return someProp;}
public void setSomeProp(String someProp) {this.someProp = someProp;}
}
In the preceding code, the @DynamoDBTable annotation type maps the CatalogItem class to the
ProductCatalog table.You can store individual class instances as items in the table. In the class definition,
the @DynamoDBHashKey annotation type maps the Id property to the primary key.
By default, the class properties map to the same name attributes in the table. The properties Title and
ISBN map to the same name attributes in the table. If you define a class property name that does not
match a corresponding item attribute name, then you must explicitly add the @DynamoDBAttribute
annotation type to specify the mapping. In the preceding example, the @DynamoDBAttribute annotation
type is added to each property to ensure that the property names match exactly with the tables created
in Creating Tables and Loading Sample Data (p. 14), and to be consistent with the attribute names used
in other code examples in this guide.
Your class definition can have properties that don't map to any attributes in the table. You identify these
properties by adding the @DynamoDBIgnore annotation type. In the preceding example, the SomeProp
property is marked with the @DynamoDBIgnore annotation type. When you upload a CatalogItem
instance to the table, your DynamoDBMapper instance does not include SomeProp property. In addition,
the mapper does not return this attribute when you retrieve an item from the table.
After you have defined your mapping class, you can use DynamoDBMapper methods to write an instance
of that class to a corresponding item in the Catalog table. The following code snippet demonstrates this
technique:
AmazonDynamoDBClient client = new AmazonDynamoDBClient(new ProfileCredentialsPro
vider());
DynamoDBMapper mapper = new DynamoDBMapper(client);
CatalogItem item = new CatalogItem();
item.setId(102);
item.setTitle("Book 102 Title");
item.setISBN("222-2222222222");
item.setBookAuthors(new HashSet<String>(Arrays.asList("Author 1", "Author 2")));
item.setSomeProp("Test");
mapper.save(item);
The following code snippet shows how to retrieve the item and access some of its attributes:
CatalogItem hashKeyValues = new CatalogItem();
hashKeyValues.setId(102);
DynamoDBQueryExpression<CatalogItem> queryExpression = new DynamoDBQueryExpres
sion<CatalogItem>()
.withHashKeyValues(hashKeyValues);
List<CatalogItem> itemList = mapper.query(CatalogItem.class, queryExpression);
for (int i = 0; i < itemList.size(); i++) {
System.out.println(itemList.get(i).getTitle());
System.out.println(itemList.get(i).getBookAuthors());
}
The object persistence model offers an intuitive, natural way of working with DynamoDB data within Java.
It also provides a number of built-in features such as optimistic locking, auto-generated hash and range
keys, and object versioning.
DynamoDB type
N (number type)
Strings
S (string type)
boolean
N (number type), 0 or 1.
ByteBuffer
B (binary type)
Date
S (string type). The Date values are stored as ISO-8601 formatted strings.
In addition, DynamoDB supports arbitrary data types. For example, you can define your own complex
types on the client. You use the DynamoDBMarshaller interface and the @DynamoDBMarhsalling
annotation type for the complex type to describe the mapping (Mapping Arbitrary Data (p. 428)).
Note
In the following table, only the DynamoDBTable and the DynamoDBHashKey are the required
tags.
Declarative Tag (Annotation)
Description
@DynamoDBTable
@DynamoDBIgnore
Description
@DynamoDBAttribute
Description
@DynamoDBRangeKey
Maps a class property to the range key attribute of the table. The
property must be one of the scalar string, number or binary types;
it cannot be a collection type.
If the primary key is made of both the hash and range key attributes, you can use this tag to map your class field to the range attribute. For example, assume that you have a Reply table that
stores replies for forum threads. Each thread can have many
replies. So the primary key of this table is both the ThreadId and
ReplyDateTime.The ThreadId is the hash attribute and ReplyDateTime is the range attribute. The following Java code snippet
defines a Reply class and maps it to the Reply table. It uses both
the @DynamoDBHashKey and @DynamoDBRangeKey tags to
identify class properties that map to the primary key.
@DynamoDBTable(tableName="Reply")
public class Reply {
private String id;
private String replyDateTime;
@DynamoDBHashKey(attributeName="Id")
public String getId() { return id; }
public void setId(String id) { this.id = id;
}
@DynamoDBRangeKey(attributeName="ReplyDate
Time")
public String getReplyDateTime() { return
replyDateTime; }
public void setReplyDateTime(String replyDat
eTime) { this.replyDateTime = replyDateTime; }
// Additional properties go here.
}
Description
@DynamoDBAutoGeneratedKey
@DynamoDBVersionAttribute
Description
@DynamoDBIndexHashKey
@DynamoDBIndexRangeKey
@DynamoDBMarshalling
Method
Description
save
Saves the specified object to the table. The object that you wish to save is the only required parameter for this method. You can provide optional configuration parameters
using the DynamoDBMapperConfig object.
If an item that has the same primary key does not exist, this method creates a new item
in the table. If an item that has the same primary key exists, it updates the existing item.
String hash and range keys annotated with @DynamoDBAutoGeneratedKey are given
a random universally unique identifier (UUID) if left uninitialized. Version fields annotated
with @DynamoDBVersionAttribute will be incremented by one. Additionally, if a version
field is updated or a key generated, the object passed in is updated as a result of the
operation.
By default, only attributes corresponding to mapped class properties are updated; any
additional existing attributes on an item are unaffected. However, if you specify SaveBehavior.CLOBBER, you can force the item to be completely overwritten.
mapper.save(obj, new DynamoDBMapperConfig(DynamoDBMapperConfig.Save
Behavior.CLOBBER));
If you have versioning enabled, then the client-side and server-side item versions must
match. However, the version does not need to match if the SaveBehavior.CLOBBER
option is used. For more information about versioning, see Optimistic Locking With Version
Number (p. 426).
load
Retrieves an item from a table. You must provide the primary key of the item that you
wish to retrieve. You can provide optional configuration parameters using the DynamoDBMapperConfig object. For example, you can optionally request strongly consistent
reads to ensure that this method retrieves only the latest item values as shown in the
following Java statement.
CatalogItem item = mapper.load(CatalogItem.class, item.getId(),
new DynamoDBMapperConfig(DynamoDBMapperConfig.Con
sistentReads.CONSISTENT));
By default, DynamoDB returns the item that has values that are eventually consistent.
For information about the eventual consistency model of DynamoDB, see Data Read
and Consistency Considerations (p. 10).
delete
Deletes an item from the table.You must pass in an object instance of the mapped class.
If you have versioning enabled, then the client-side and server-side item versions must
match. However, the version does not need to match if the SaveBehavior.CLOBBER
option is used. For more information about versioning, see Optimistic Locking With Version
Number (p. 426).
Method
Description
query
Method
Description
Queries a table. You can query a table only if its primary key is made of both a hash and
a range attribute. This method requires you to provide a hash attribute value and a query
filter that is applied on the range attribute. A filter expression includes a condition and a
value.
Assume that you have a table, Reply, that stores forum thread replies. Each thread
subject can have 0 or more replies. The primary key of the Reply table consists of the
Id and ReplyDateTime fields, where Id is the hash attribute and ReplyDateTime is the
range attribute of the primary key.
Reply ( Id, ReplyDateTime, ... )
Now, assume that you created an object persistence model that includes a Reply class
that maps to the table.
The following Java code snippet uses the DynamoDBMapper instance to query the table
to find all replies in the past two weeks for a specific thread subject.
String forumName = "DynamoDB";
String forumSubject = "DynamoDB Thread 1";
String hashKey = forumName + "#" + forumSubject;
long twoWeeksAgoMilli = (new Date()).getTime() (14L*24L*60L*60L*1000L);
Date twoWeeksAgo = new Date();
twoWeeksAgo.setTime(twoWeeksAgoMilli);
SimpleDateFormat df = new SimpleDateFormat("yyyy-MMdd'T'HH:mm:ss.SSS'Z'");
String twoWeeksAgoStr = df.format(twoWeeksAgo);
Note
If your table's primary key is made of only a hash attribute, then you cannot use
the query method. Instead, you can use the load method and provide the hash
attribute to retrieve the item.
By default, the
API Version 2012-08-10
420
Method
Description
query method returns a "lazy-loaded" collection. It initially returns only one page of
results, and then makes a service call for the next page if needed. To obtain all the
matching items, you only need to iterate over the latestReplies collection.
queryPage
Queries a table and returns a single page of matching results. As with the query method,
you must specify a hash attribute value and a query filter that is applied on the range
attribute. However, queryPage will only return the first "page" of data - that is, the amount
of data that will fit within 1 MB
scan
Scans an entire table. You can optionally specify one or more Condition instances to
filter the result set, and you can specify a filter expression for any item attributes.
Assume that you have a table, Thread, that stores forum thread information including
Subject (part of the composite primary key) and if the thread is answered.
Thread ( ForumName, Subject, ..., Answered )
If you have an object persistence model for this table, then you can use the DynamoDBMapper to scan the table. For example, the following Java code snippet filters the
Thread table to retrieve all the unanswered threads. The scan condition identifies the
attribute and a condition.
DynamoDBScanExpression scanExpression = new DynamoDBScanExpres
sion();
Map<String, Condition> scanFilter = new HashMap<String, Condi
tion>();
Condition scanCondition = new Condition()
.withComparisonOperator(ComparisonOperator.EQ.toString())
.withAttributeValueList(new AttributeValue().withN("0"));
scanFilter.put("Answered", scanCondition);
scanExpression.setScanFilter(scanFilter);
List<Thread> unansweredThreads = mapper.scan(Thread.class, scanEx
pression);
By default, the scan method returns a "lazy-loaded" collection. It initially returns only
one page of results, and then makes a service call for the next page if needed. To obtain
all the matching items, you only need to iterate over the unansweredThreads collection.
scanPage
Scans a table and returns a single page of matching results. As with the scan method,
you can optionally specify one or more Condition instances to filter the result set, and
you can specify a filter expression for any item attributes. However, scanPage will only
return the first "page" of data - that is, the amount of data that will fit within 1 MB
Method
Description
parallelS- Performs a parallel scan of an entire table. You specify a number of logical segments
for the table, along with a scan expression to filter the results. The parallelScan divides
can
the scan task among multiple workers, one for each logical segment; the workers process
the data in parallel and return the results.
The following Java code snippet performs a parallel scan on the Product table.
int numberOfThreads = 4;
DynamoDBScanExpression scanExpression = new DynamoDBScanExpres
sion();
scanExpression.addFilterCondition("Price",
new Condition()
.withComparisonOperator(ComparisonOperator.GT)
.withAttributeValueList(new Attribute
Value().withN("100")));
List<Product> scanResult = mapper.parallelScan(Product.class,
scanExpression, numberOfThreads);
For a Java code sample illustrating usage of parallelScan, see Example: Query and
Scan (p. 438).
batchSave
Saves objects to one or more tables using one or more calls to the AmazonDynamoDB.batchWriteItem method. This method does not provide transaction guarantees.
The following Java code snippet saves two items (books) to the ProductCatalog table.
Book book1 = new Book();
book1.id = 901;
book1.productCategory = "Book";
book1.title = "Book 901 Title";
Book book2 = new Book();
book2.id = 902;
book2.productCategory = "Book";
book2.title = "Book 902 Title";
mapper.batchSave(Arrays.asList(book1, book2));
Method
Description
batchLoad
Retrieves multiple items from one or more tables using their primary keys.
The following Java code snippet retrieves two items from two different tables.
ArrayList<Object> itemsToGet = new ArrayList<Object>();
ForumItem forumItem = new ForumItem();
forumItem.setForumName("Amazon DynamoDB");
itemsToGet.add(forumItem);
ThreadItem threadItem = new ThreadItem();
threadItem.setForumName("Amazon DynamoDB");
threadItem.setSubject("Amazon DynamoDB thread 1 message text");
itemsToGet.add(threadItem);
Map<String, List<Object>> items = mapper.batchLoad(itemsToGet);
batchDelete
Deletes objects from one or more tables using one or more calls to the AmazonDynamoDB.batchWriteItem method. This method does not provide transaction guarantees.
The following Java code snippet deletes two items (books) from the ProductCatalog
table.
Book book1 = mapper.load(Book.class, 901);
Book book2 = mapper.load(Book.class, 902);
mapper.batchDelete(Arrays.asList(book1, book2));
batchWrite
Saves objects to and deletes objects from one or more tables using one or more calls
to the AmazonDynamoDB.batchWriteItem method. This method does not provide
transaction guarantees or support versioning (conditional puts or deletes).
The following Java code snippet writes a new item to the Forum table, writes a new item
to the Thread table, and deletes an item from the ProductCatalog table.
// Create a Forum item to save
Forum forumItem = new Forum();
forumItem.name = "Test BatchWrite Forum";
// Create a Thread item to save
Thread threadItem = new Thread();
threadItem.forumName = "AmazonDynamoDB";
threadItem.subject = "My sample question";
// Load a ProductCatalog item to delete
Book book3 = mapper.load(Book.class, 903);
List<Object> objectsToWrite = Arrays.asList(forumItem, threadItem);
List<Book> objectsToDelete = Arrays.asList(book3);
mapper.batchWrite(objectsToWrite, objectsToDelete);
Method
Description
count
Evaluates the specified scan expression and returns the count of matching items. No
item data is returned.
generateCreateTableRequest
Parses a POJO class that represents a DynamoDB table, and returns a CreateTableRequest for that table.
createS3Link
Creates a link to an object in Amazon S3. You must specify a bucket name and a key
name, which uniquely identifies the object in the bucket.
To use createS3Link, your mapper class must define getter and setter methods. The
following code snippet illustrates this by adding a new attribute and getter/setter methods
to the CatalogItem class:
@DynamoDBTable(tableName="ProductCatalog")
public class CatalogItem {
...
public S3Link productImage;
....
@DynamoDBAttribute(attributeName = "ProductImage")
public S3Link getProductImage() {
return productImage;
}
public void setProductImage(S3Link productImage) {
this.productImage = productImage;
}
...
}
The following Java code defines a new item to be written to the Product table. The item
includes a link to a product image; the image data is uploaded to Amazon S3.
CatalogItem item = new CatalogItem();
item.id = 150;
item.title = "Book 150 Title";
String myS3Bucket = "myS3bucket";
String myS3Key = "productImages/book_150_cover.jpg";
item.setProductImage(mapper.createS3Link(myS3Bucket, myS3Key));
item.getProductImage().uploadFrom(new
File("/file/path/book_150_cover.jpg"));
mapper.save(item);
The S3Link class provides many other methods for manipulating objects in Amazon
S3. For more information, see the Javadocs for S3Link.
Method
Description
getS3ClientCache
For more information, see DynamoDBMapperConfig in the AWS SDK for Java API Reference.
You can use the following arguments for an instance of DynamoDBMapperConfig:
A DynamoDBMapperConfig.ConsistentReads enumeration value:
EVENTUALthe mapper instance uses an eventually consistent read request.
CONSISTENTthe mapper instance uses a strongly consistent read request.You can use this optional
setting with load, query, or scan operations. Strongly consistent reads have implications for
performance and billing; see the DynamoDB product detail page for more information.
If you do not specify a read consistency setting for your mapper instance, the default is EVENTUAL.
A DynamoDBMapperConfig.PaginationLoadingStrategy enumeration valueControls how the
mapper instance processes a paginated list of data, such as the results from a query or scan:
LAZY_LOADING the mapper instance loads data when possible, and keep all loaded results in
memory.
EAGER_LOADINGthe mapper instance loads the data as soon as the list is initialized.
ITERATION_ONLYyou can only use an Iterator to read from the list. During the iteration, the list
will clear all the previous results before loading the next page, so that the list will keep at most one
page of the loaded results in memory. This also means the list can only be iterated once. This strategy
is recommended when handling large items, in order to reduce memory overhead.
If you do not specify a pagination loading strategy for your mapper instance, the default is
LAZY_LOADING.
Integer id;
String title;
String ISBN;
Set<String> bookAuthors;
String someProp;
Long version;
@DynamoDBHashKey(attributeName="Id")
public Integer getId() { return id; }
public void setId(Integer Id) { this.id = Id; }
@DynamoDBAttribute(attributeName="Title")
public String getTitle() { return title; }
You can apply the @DynamoDBVersion annotation to nullable types provided by the primitive wrappers
classes such as Long and Integer, or you can use the primitive types int and long. We recommend
that you use Integer and Long whenever possible.
Optimistic locking has the following impact on these DynamoDBMapper methods:
save For a new item, the DynamoDBMapper assigns an initial version number 1. If you retrieve an
item, update one or more of its properties and attempt to save the changes, the save operation succeeds
only if the version number on the client-side and the server-side match. The DynamoDBMapper
increments the version number automatically.
delete The delete method takes an object as parameter and the DynamoDBMapper performs a
version check before deleting the item. The version check can be disabled if
DynamoDBMapperConfig.SaveBehavior.CLOBBER is specified in the request.
Note that the internal implementation of optimistic locking in the object persistence code uses the
conditional update and the conditional delete API support in DynamoDB.
Note
This code example assumes that you have already loaded data into DynamoDB for your account
by following the instructions in the Creating Tables and Loading Sample Data (p. 14) section.
Alternatively, you can load the data programmatically using the instructions in the Creating
Example Tables and Uploading Data Using the AWS SDK for Java (p. 684) topic.
For step-by-step instructions to run the following example, see Running Java Examples for
DynamoDB (p. 55).
// Copyright 2012-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
// Licensed under the Apache License, Version 2.0.
package com.amazonaws.codesamples.datamodeling;
import
import
import
import
java.io.IOException;
java.util.Arrays;
java.util.HashSet;
java.util.Set;
import
import
import
import
import
import
import
import
com.amazonaws.auth.profile.ProfileCredentialsProvider;
com.amazonaws.services.dynamodbv2.AmazonDynamoDBClient;
com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBAttribute;
com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBHashKey;
com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBMapper;
com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBMarshaller;
com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBMarshalling;
com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBTable;
@DynamoDBMarshalling(marshallerClass = DimensionTypeConverter.class)
public DimensionType getDimensions() { return dimensionType; }
public void setDimensions(DimensionType dimensionType) { this.dimension
Type = dimensionType; }
@Override
public String toString()
return "Book [ISBN="
+ ", dimensionType="
+ ", Title=" + title
}
{
+ ISBN + ", bookAuthors=" + bookAuthors
+ dimensionType + ", Id=" + id
+ "]";
}
static public class DimensionType {
private String length;
private String height;
private String thickness;
public String getLength() { return length; }
public void setLength(String length) { this.length = length; }
public String getHeight() { return height; }
public void setHeight(String height) { this.height = height; }
public String getThickness() { return thickness; }
public void setThickness(String thickness) { this.thickness = thickness;
}
}
// Converts the complex type DimensionType to a string and vice-versa.
static public class DimensionTypeConverter implements DynamoDBMarshaller<Di
mensionType> {
@Override
public String marshall(DimensionType value) {
DimensionType itemDimensions = (DimensionType)value;
String dimension = null;
try {
if (itemDimensions != null) {
dimension = String.format("%s x %s x %s",
itemDimensions.getLength(),
itemDimensions.getHeight(),
itemDimensions.getThickness());
}
} catch (Exception e) {
e.printStackTrace();
}
return dimension;
}
@Override
public DimensionType unmarshall(Class<DimensionType> dimensionType,
String value) {
DimensionType itemDimension = new DimensionType();
try {
if (value != null && value.length() !=0 ) {
Note
This code example assumes that you have already loaded data into DynamoDB for your account
by following the instructions in the Creating Tables and Loading Sample Data (p. 14) section.
Alternatively, you can load the data programmatically using the instructions in the Creating
Example Tables and Uploading Data Using the AWS SDK for Java (p. 684) topic.
For step-by-step instructions to run the following example, see Running Java Examples for
DynamoDB (p. 55).
// Copyright 2012-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
// Licensed under the Apache License, Version 2.0.
package com.amazonaws.codesamples.datamodeling;
import
import
import
import
java.io.IOException;
java.util.Arrays;
java.util.HashSet;
java.util.Set;
import
import
import
import
import
import
import
com.amazonaws.auth.profile.ProfileCredentialsProvider;
com.amazonaws.services.dynamodbv2.AmazonDynamoDBClient;
com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBAttribute;
com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBHashKey;
com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBMapper;
com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBMapperConfig;
com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBTable;
System.out.println("Example complete!");
}
@DynamoDBTable(tableName="ProductCatalog")
public static class CatalogItem {
private Integer id;
private String title;
private String ISBN;
private Set<String> bookAuthors;
@DynamoDBHashKey(attributeName="Id")
public Integer getId() { return id; }
public void setId(Integer id) { this.id = id; }
@DynamoDBAttribute(attributeName="Title")
public String getTitle() { return title; }
public void setTitle(String title) { this.title = title; }
@DynamoDBAttribute(attributeName="ISBN")
public String getISBN() { return ISBN; }
public void setISBN(String ISBN) { this.ISBN = ISBN;}
@DynamoDBAttribute(attributeName = "Authors")
public Set<String> getBookAuthors() { return bookAuthors; }
public void setBookAuthors(Set<String> bookAuthors) { this.bookAuthors
= bookAuthors; }
@Override
public String toString() {
return "Book [ISBN=" + ISBN + ", bookAuthors=" + bookAuthors
+ ", id=" + id + ", title=" + title + "]";
}
}
private static void testCRUDOperations() {
CatalogItem item = new CatalogItem();
item.setId(601);
item.setTitle("Book 601");
item.setISBN("611-1111111111");
item.setBookAuthors(new HashSet<String>(Arrays.asList("Author1", "Au
thor2")));
// Save the item (book).
DynamoDBMapper mapper = new DynamoDBMapper(client);
mapper.save(item);
// Retrieve the item.
CatalogItem itemRetrieved = mapper.load(CatalogItem.class, 601);
System.out.println("Item retrieved:");
System.out.println(itemRetrieved);
// Update the item.
itemRetrieved.setISBN("622-2222222222");
itemRetrieved.setBookAuthors(new HashSet<String>(Arrays.asList("Author1",
"Author3")));
mapper.save(itemRetrieved);
System.out.println("Item updated:");
System.out.println(itemRetrieved);
java.text.SimpleDateFormat;
java.util.ArrayList;
java.util.Arrays;
java.util.HashSet;
java.util.List;
java.util.Set;
import
import
import
import
import
import
import
com.amazonaws.auth.profile.ProfileCredentialsProvider;
com.amazonaws.services.dynamodbv2.AmazonDynamoDBClient;
com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBAttribute;
com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBHashKey;
com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBMapper;
com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBMapperConfig;
com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBRangeKey;
import com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBTable;
public class ObjectPersistenceBatchWriteExample {
static AmazonDynamoDBClient client = new AmazonDynamoDBClient(new ProfileCre
dentialsProvider());
static SimpleDateFormat dateFormatter = new SimpleDateFormat("yyyy-MMdd'T'HH:mm:ss.SSS'Z'");
public static void main(String[] args) throws Exception {
try {
DynamoDBMapper mapper = new DynamoDBMapper(client);
testBatchSave(mapper);
testBatchDelete(mapper);
testBatchWrite(mapper);
System.out.println("Example complete!");
} catch (Throwable t) {
System.err.println("Error running the ObjectPersistenceBatchWrit
eExample: " + t);
t.printStackTrace();
}
}
private static void testBatchSave(DynamoDBMapper mapper) {
Book book1 = new Book();
book1.id = 901;
book1.inPublication = true;
book1.ISBN = "902-11-11-1111";
book1.pageCount = 100;
book1.price = 10;
book1.productCategory = "Book";
book1.title = "My book created in batch write";
Book book2 = new Book();
book2.id = 902;
book2.inPublication = true;
book2.ISBN = "902-11-12-1111";
book2.pageCount = 200;
book2.price = 20;
book2.productCategory = "Book";
book2.title = "My second book created in batch write";
Book book3 = new Book();
book3.id = 903;
book3.inPublication = false;
book3.ISBN = "902-11-13-1111";
book3.pageCount = 300;
book3.price = 25;
book3.productCategory = "Book";
book3.title = "My third book created in batch write";
System.out.println("Adding three books to ProductCatalog table.");
mapper.batchSave(Arrays.asList(book1, book2, book3));
}
private static void testBatchDelete(DynamoDBMapper mapper) {
Book book1 = mapper.load(Book.class, 901);
Book book2 = mapper.load(Book.class, 902);
System.out.println("Deleting two books from the ProductCatalog table.");
mapper.batchDelete(Arrays.asList(book1, book2));
}
private static void testBatchWrite(DynamoDBMapper mapper) {
// Create Forum item to save
Forum forumItem = new Forum();
forumItem.name = "Test BatchWrite Forum";
forumItem.threads = 0;
forumItem.category = "Amazon Web Services";
// Create Thread item to save
Thread threadItem = new Thread();
threadItem.forumName = "AmazonDynamoDB";
threadItem.subject = "My sample question";
threadItem.message = "BatchWrite message";
List<String> tags = new ArrayList<String>();
tags.add("batch operations");
tags.add("write");
threadItem.tags = new HashSet<String>(tags);
// Load ProductCatalog item to delete
Book book3 = mapper.load(Book.class, 903);
List<Object> objectsToWrite = Arrays.asList(forumItem, threadItem);
List<Book> objectsToDelete = Arrays.asList(book3);
DynamoDBMapperConfig config = new DynamoDBMapperConfig(DynamoDBMapper
Config.SaveBehavior.CLOBBER);
mapper.batchWrite(objectsToWrite, objectsToDelete, config);
}
@DynamoDBTable(tableName="ProductCatalog")
public static class Book {
private int id;
private String title;
private String ISBN;
private int price;
private int pageCount;
private String productCategory;
private boolean inPublication;
@DynamoDBHashKey(attributeName="Id")
public int getId() { return id; }
public void setId(int id) { this.id = id; }
@DynamoDBAttribute(attributeName="Title")
public String getTitle() { return title; }
public void setTitle(String title) { this.title = title; }
@DynamoDBAttribute(attributeName="ISBN")
public String getISBN() { return ISBN; }
public void setISBN(String ISBN) { this.ISBN = ISBN; }
@DynamoDBAttribute(attributeName="Price")
public int getPrice() { return price; }
public void setPrice(int price) { this.price = price; }
@DynamoDBAttribute(attributeName="PageCount")
public int getPageCount() { return pageCount; }
public void setPageCount(int pageCount) { this.pageCount = pageCount;}
@DynamoDBAttribute(attributeName="ProductCategory")
public String getProductCategory() { return productCategory; }
public void setProductCategory(String productCategory) { this.product
Category = productCategory; }
@DynamoDBAttribute(attributeName="InPublication")
public boolean getInPublication() { return inPublication; }
public void setInPublication(boolean inPublication) { this.inPublication
= inPublication; }
@Override
public String toString() {
return "Book [ISBN=" + ISBN + ", price=" + price
+ ", product category=" + productCategory + ", id=" + id
+ ", title=" + title + "]";
}
}
@DynamoDBTable(tableName="Reply")
public static class Reply {
private String id;
private String replyDateTime;
private String message;
private String postedBy;
@DynamoDBHashKey(attributeName="Id")
public String getId() { return id; }
public void setId(String id) { this.id = id; }
@DynamoDBRangeKey(attributeName="ReplyDateTime")
public String getReplyDateTime() { return replyDateTime; }
public void setReplyDateTime(String replyDateTime) { this.replyDateTime
= replyDateTime; }
@DynamoDBAttribute(attributeName="Message")
public String getMessage() { return message; }
public void setMessage(String message) { this.message = message; }
@DynamoDBAttribute(attributeName="PostedBy")
public String getPostedBy() { return postedBy; }
public void setPostedBy(String postedBy) { this.postedBy = postedBy;}
}
@DynamoDBTable(tableName="Thread")
public static class Thread {
private String forumName;
private String subject;
private String message;
private String lastPostedDateTime;
private String lastPostedBy;
private Set<String> tags;
private int answered;
private int views;
private int replies;
@DynamoDBHashKey(attributeName="ForumName")
public String getForumName() { return forumName; }
public void setForumName(String forumName) { this.forumName = forumName;
}
@DynamoDBRangeKey(attributeName="Subject")
public String getSubject() { return subject; }
public void setSubject(String subject) { this.subject = subject; }
@DynamoDBAttribute(attributeName="Message")
public String getMessage() { return message; }
public void setMessage(String message) { this.message = message; }
@DynamoDBAttribute(attributeName="LastPostedDateTime")
public String getLastPostedDateTime() { return lastPostedDateTime; }
public void setLastPostedDateTime(String lastPostedDateTime) {
this.lastPostedDateTime = lastPostedDateTime; }
@DynamoDBAttribute(attributeName="LastPostedBy")
public String getLastPostedBy() { return lastPostedBy; }
public void setLastPostedBy(String lastPostedBy) { this.lastPostedBy =
lastPostedBy;}
@DynamoDBAttribute(attributeName="Tags")
public Set<String> getTags() { return tags; }
public void setTags(Set<String> tags) { this.tags = tags; }
@DynamoDBAttribute(attributeName="Answered")
public int getAnswered() { return answered; }
public void setAnswered(int answered) { this.answered = answered; }
@DynamoDBAttribute(attributeName="Views")
public int getViews() { return views; }
public void setViews(int views) { this.views = views; }
@DynamoDBAttribute(attributeName="Replies")
public int getReplies() { return replies; }
public void setReplies(int replies) { this.replies = replies; }
}
@DynamoDBTable(tableName="Forum")
public static class Forum {
private String name;
@DynamoDBAttribute(attributeName="Threads")
public int getThreads() { return threads; }
public void setThreads(int threads) { this.threads = threads;}
}
}
Note
This code example assumes that you have already loaded data into DynamoDB for your account
by following the instructions in the Creating Tables and Loading Sample Data (p. 14) section.
Alternatively, you can load the data programmatically using the instructions in the Creating
Example Tables and Uploading Data Using the AWS SDK for Java (p. 684) topic.
For step-by-step instructions to run the following example, see Running Java Examples for
DynamoDB (p. 55).
// Copyright 2012-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
// Licensed under the Apache License, Version 2.0.
package com.amazonaws.codesamples.datamodeling;
import
import
import
import
import
java.text.SimpleDateFormat;
java.util.Date;
java.util.List;
java.util.Set;
java.util.TimeZone;
import
import
import
import
import
import
import
import
import
import
import
import
com.amazonaws.auth.profile.ProfileCredentialsProvider;
com.amazonaws.services.dynamodbv2.AmazonDynamoDBClient;
com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBAttribute;
com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBHashKey;
com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBMapper;
com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBQueryExpression;
com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBRangeKey;
com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBScanExpression;
com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBTable;
com.amazonaws.services.dynamodbv2.model.AttributeValue;
com.amazonaws.services.dynamodbv2.model.ComparisonOperator;
com.amazonaws.services.dynamodbv2.model.Condition;
// Scan a table and find book items priced less than specified
value.
FindBooksPricedLessThanSpecifiedValue(mapper, "20");
// Scan a table with multiple threads and find bicycle items with
a specified bicycle type
int numberOfThreads = 16;
FindBicyclesOfSpecificTypeWithMultipleThreads(mapper, numberOf
Threads, "Road");
System.out.println("Example complete!");
} catch (Throwable t) {
System.err.println("Error running the ObjectPersistenceQuery
ScanExample: " + t);
t.printStackTrace();
}
}
private static void GetBook(DynamoDBMapper mapper, int id) throws Exception
{
System.out.println("GetBook: Get book Id='101' ");
System.out.println("Book table has no range key attribute, so you Get
(but no query).");
Book book = mapper.load(Book.class, 101);
System.out.format("Id = %s Title = %s, ISBN = %s %n", book.getId(),
book.getTitle(), book.getISBN() );
}
}
}
private static void FindRepliesPostedWithinTimePeriod(
DynamoDBMapper mapper,
String forumName,
String threadSubject) throws Exception {
String hashKey = forumName + "#" + threadSubject;
System.out.println("FindRepliesPostedWithinTimePeriod: Find replies for
thread Message = 'DynamoDB Thread 2' posted within a period.");
long startDateMilli = (new Date()).getTime() - (14L*24L*60L*60L*1000L);
// Two weeks ago.
long endDateMilli = (new Date()).getTime() - (7L*24L*60L*60L*1000L);
// One week ago.
SimpleDateFormat dateFormatter = new SimpleDateFormat("yyyy-MMdd'T'HH:mm:ss.SSS'Z'");
dateFormatter.setTimeZone(TimeZone.getTimeZone("UTC"));
String startDate = dateFormatter.format(startDateMilli);
String endDate = dateFormatter.format(endDateMilli);
Condition rangeKeyCondition = new Condition()
.withComparisonOperator(ComparisonOperator.BETWEEN.toString())
.withAttributeValueList(new AttributeValue().withS(startDate),
new AttributeValue().withS(endDate));
Reply replyKey = new Reply();
replyKey.setId(hashKey);
DynamoDBQueryExpression<Reply> queryExpression = new DynamoDBQueryEx
pression<Reply>()
.withHashKeyValues(replyKey)
.withRangeKeyCondition("ReplyDateTime", rangeKeyCondition);
List<Reply> betweenReplies = mapper.query(Reply.class, queryExpression);
scanExpression.addFilterCondition("ProductCategory",
new Condition()
.withComparisonOperator(ComparisonOperator.EQ)
.withAttributeValueList(new AttributeValue().withS("Book")));
List<Book> scanResult = mapper.scan(Book.class, scanExpression);
for (Book book : scanResult) {
System.out.println(book);
}
}
private static void FindBicyclesOfSpecificTypeWithMultipleThreads(
DynamoDBMapper mapper,
int numberOfThreads,
String bicycleType) throws Exception {
System.out.println("FindBicyclesOfSpecificTypeWithMultipleThreads: Scan
ProductCatalog With Multiple Threads.");
DynamoDBScanExpression scanExpression = new DynamoDBScanExpression();
scanExpression.addFilterCondition("ProductCategory",
new Condition()
.withComparisonOperator(ComparisonOperator.EQ)
.withAttributeValueList(new AttributeValue().withS("Bi
cycle")));
scanExpression.addFilterCondition("BicycleType",
new Condition()
.withComparisonOperator(ComparisonOperator.EQ)
.withAttributeValueList(new AttributeValue().withS(bicycle
Type)));
List<Bicycle> scanResult = mapper.parallelScan(Bicycle.class, scanEx
pression, numberOfThreads);
for (Bicycle bicycle : scanResult) {
System.out.println(bicycle);
}
}
@DynamoDBTable(tableName="ProductCatalog")
public static class Book {
private int id;
private String title;
private String ISBN;
private int price;
private int pageCount;
private String productCategory;
private boolean inPublication;
@DynamoDBHashKey(attributeName="Id")
public int getId() { return id; }
public void setId(int id) { this.id = id; }
@DynamoDBAttribute(attributeName="Title")
public String getTitle() { return title; }
public void setTitle(String title) { this.title = title; }
@DynamoDBAttribute(attributeName="ISBN")
@DynamoDBAttribute(attributeName="ProductCategory")
public String getProductCategory() { return productCategory; }
public void setProductCategory(String productCategory) { this.product
Category = productCategory; }
@DynamoDBAttribute(attributeName="InPublication")
public boolean getInPublication() { return inPublication; }
public void setInPublication(boolean inPublication) { this.inPublication
= inPublication; }
@Override
public String toString() {
return "Book [ISBN=" + ISBN + ", price=" + price
+ ", product category=" + productCategory + ", id=" + id
+ ", title=" + title + "]";
}
}
@DynamoDBTable(tableName="ProductCatalog")
public static class Bicycle {
private int id;
private String title;
private String description;
private String bicycleType;
private String brand;
private int price;
private String gender;
private Set<String> color;
private String productCategory;
@DynamoDBHashKey(attributeName="Id")
public int getId() { return id; }
public void setId(int id) { this.id = id; }
@DynamoDBAttribute(attributeName="Title")
public String getTitle() { return title; }
public void setTitle(String title) { this.title = title; }
@DynamoDBAttribute(attributeName="Description")
public String getDescription() { return description; }
public void setDescription(String description) { this.description =
description; }
@DynamoDBAttribute(attributeName="BicycleType")
public String getBicycleType() { return bicycleType; }
}
@DynamoDBTable(tableName="Thread")
public static class Thread {
private String forumName;
private String subject;
private String message;
private String lastPostedDateTime;
private String lastPostedBy;
private Set<String> tags;
private int answered;
private int views;
private int replies;
@DynamoDBHashKey(attributeName="ForumName")
public String getForumName() { return forumName; }
public void setForumName(String forumName) { this.forumName = forumName;
}
@DynamoDBRangeKey(attributeName="Subject")
public String getSubject() { return subject; }
public void setSubject(String subject) { this.subject = subject; }
@DynamoDBAttribute(attributeName="Message")
public String getMessage() { return message; }
public void setMessage(String message) { this.message = message; }
@DynamoDBAttribute(attributeName="LastPostedDateTime")
public String getLastPostedDateTime() { return lastPostedDateTime; }
public void setLastPostedDateTime(String lastPostedDateTime) {
this.lastPostedDateTime = lastPostedDateTime; }
@DynamoDBAttribute(attributeName="LastPostedBy")
public String getLastPostedBy() { return lastPostedBy; }
public void setLastPostedBy(String lastPostedBy) { this.lastPostedBy =
lastPostedBy;}
@DynamoDBAttribute(attributeName="Tags")
public Set<String> getTags() { return tags; }
public void setTags(Set<String> tags) { this.tags = tags; }
@DynamoDBAttribute(attributeName="Answered")
public int getAnswered() { return answered; }
public void setAnswered(int answered) { this.answered = answered; }
@DynamoDBAttribute(attributeName="Views")
public int getViews() { return views; }
public void setViews(int views) { this.views = views; }
@DynamoDBAttribute(attributeName="Replies")
public int getReplies() { return replies; }
public void setReplies(int replies) { this.replies = replies; }
}
@DynamoDBTable(tableName="Forum")
public static class Forum {
@DynamoDBAttribute(attributeName="Threads")
public int getThreads() { return threads; }
public void setThreads(int threads) { this.threads = threads;}
}
}
Note
In general, you use the LoadTable method once at the beginning of your application because
it makes a remote DescribeTable API call that adds to the round trip to DynamoDB.
You can then use the table object to perform various data operations. Each of these data operations have
two types of overloads; one that takes the minimum required parameters and another that also takes
operation specific optional configuration information. For example, to retrieve an item, you must provide
the table's primary key value in which case you can use the following GetItem overload:
// Get the item from a table that has a primary key that is composed of only a
hash attribute.
Table.GetItem(Primitive hashAttribute);
// Get the item from a table whose primary key is composed of both a hash and
range attribute.
Table.GetItem(Primitive hashAttribute, Primitive rangeAttribute);
You can also pass optional parameters to these methods. For example, the preceding GetItem returns
the entire item including all its attributes. You can optionally specify a list of attributes to retrieve. In this
case, you use the following GetItem overload that takes in the operation specific configuration object
parameter:
You can use the configuration object to specify several optional parameters such as request a specific
list of attributes or specify the page size (number of items per page). Each data operation method has its
own configuration class. For example, the GetItemOperationConfig class enables you to provide
options for the GetItem operation and the PutItemOperationConfig class enables you to provide
optional parameters for the PutItem operation.
The following sections discuss each of the data operations that are supported by the Table class.
In the preceding example, the Document instance creates an item that has Number, String, String Set,
Boolean, and Null attributes. (Null is used to indicate that the QuantityOnHand for this product is unknown.)
For Boolean and Null, use the constructor methods DynamoDBBool and DynamoDBNull.
In DynamoDB, the List and Map data types can contain elements composed of other data types. Here is
how to map these data types to the document model API:.
List use the DynamoDBList constructor.
Map use the Document constructor.
You can modify the preceding example to add a List attribute to the item. To do this, use a DynamoDBList
constructor, as shown in the following code snippet:
To add a Map attribute to the book, you define another Document. The following code snippet illustrates
how to do this.
These examples are based on the item shown in Case Study: A ProductCatalog Item (p. 98).The document
model lets you create complex nested attributes, such as the ProductReviews attribute shown in the
case study.
The GetItem operation returns all the attributes of the item and performs an eventually consistent read
(see Data Read and Consistency Considerations (p. 10)) by default.
When you retrieve an item using the document model API, you can access individual elements within the
Document object is returned:
int id = doc["Id"].AsInt();
string title = doc["Title"].AsString();
List<string> authors = doc["Authors"].AsListOfString();
bool inStock = doc["InStock"].AsBoolean();
DynamoDBNull quantityOnHand = doc["QuantityOnHand"].AsDynamoDBNull();
For attributes that are of type List or Map, here is how to map these attributes to the document model
API:
List use the AsDynamoDBList method.
Map use the AsDocument method.
The following code snippet shows how to retrieve a List (RelatedItems) and a Map (Pictures) from the
Document object:
Note
This mid-level UpdateItem operation does not support the Add action (see UpdateItem)
supported by the underlying API.
Note
The PutItem operation (Putting an Item - Table.PutItem Method (p. 448)) can also can perform
an update. If you call PutItem to upload an item and the primary key exists, the PutItem
operation replaces the entire item. Note that, if there are attributes in the existing item and those
attributes are not specified on the Document that is being put, the PutItem operation deletes
those attributes. However, the UpdateItem API only updates the specified input attributes. Any
other existing attributes of that item will remain unchanged.
The following are the steps to update an item using the AWS SDK for .NET document model.
1. Execute the Table.LoadTable method by providing the name of the table in which you want to
perform the update operation.
2. Create a Document instance by providing all the updates that you wish to perform.
To delete an existing attribute, specify the attribute value as null.
API Version 2012-08-10
452
3. Call the Table.UpdateItem method and provide the Document instance as an input parameter.
You must provide the primary key either in the Document instance or explicitly as a parameter.
The following C# code snippet demonstrates the preceding tasks. The code sample updates an item in
the Book table. The UpdateItem operation updates the existing Authors multivalued attribute, deletes
the PageCount attribute, and adds a new attribute XYZ. The Document instance includes the primary
key of the book to update.
For a working example, see Example: Batch Operations Using AWS SDK for .NET Document Model
API (p. 461).
You can use the batch write operation to perform put and delete operations on multiple tables. The
following are the steps to put or delete multiple items from multiple table using the AWS SDK for .NET
document model.
1. You create DocumentBatchWrite instance for each table in which you want to put or delete multiple
items as described in the preceding procedure.
For step-by-step instructions to test the following sample, see Using the AWS SDK for .NET (p. 56).
using System;
using System.Collections.Generic;
using System.Linq;
using Amazon.DynamoDBv2;
using Amazon.DynamoDBv2.DocumentModel;
using Amazon.Runtime;
namespace com.amazonaws.codesamples
{
class MidlevelItemCRUD
{
private static AmazonDynamoDBClient client = new AmazonDynamoDBClient();
// Delete.
DeleteBook(productCatalog);
Console.WriteLine("To continue, press Enter");
Console.ReadLine();
}
catch (AmazonDynamoDBException e) { Console.WriteLine(e.Message);
}
catch (AmazonServiceException e) { Console.WriteLine(e.Message); }
productCatalog.PutItem(book);
}
// Optional parameters.
UpdateItemOperationConfig config = new UpdateItemOperationConfig
{
// Get updated item in response.
ReturnValues = ReturnValues.AllNewAttributes
};
Document updatedBook = productCatalog.UpdateItem(book, config);
Console.WriteLine("UpdateMultipleAttributes: Printing item after
updates ...");
PrintDocument(updatedBook);
}
{
Console.WriteLine("\n*** Executing UpdateBookPriceConditionally()
***");
// Optional parameters.
UpdateItemOperationConfig config = new UpdateItemOperationConfig
{
ConditionalExpression = expr,
ReturnValues = ReturnValues.AllNewAttributes
};
Document updatedBook = productCatalog.UpdateItem(book, config);
Console.WriteLine("UpdateBookPriceConditionally: Printing item whose
price was conditionally updated");
PrintDocument(updatedBook);
}
PrintDocument(document);
}
{
string stringValue = null;
var value = updatedDocument[attribute];
if (value is Primitive)
stringValue = value.AsPrimitive().Value.ToString();
else if (value is PrimitiveList)
stringValue = string.Join(",", (from primitive
in value.AsPrimitiveL
ist().Entries
select primitive.Value).ToAr
ray());
Console.WriteLine("{0} - {1}", attribute, stringValue);
}
}
}
}
using System;
using System.Collections.Generic;
using Amazon.DynamoDBv2;
using Amazon.DynamoDBv2.DocumentModel;
using Amazon.Runtime;
namespace com.amazonaws.codesamples
{
class MidLevelBatchWriteItem
{
private static AmazonDynamoDBClient client = new AmazonDynamoDBClient();
book1["ISBN"] = "902-11-11-1111";
book1["Price"] = 10;
book1["ProductCategory"] = "Book";
book1["Authors"] = new List<string> { "Author 1", "Author 2", "Author
3" };
book1["Dimensions"] = "8.5x11x.5";
book1["InStock"] = new DynamoDBBool(true);
book1["QuantityOnHand"] = new DynamoDBNull(); //Quantity is unknown
at this time
batchWrite.AddDocumentToPut(book1);
// Specify delete item using overload that takes PK.
batchWrite.AddKeyToDelete(12345);
Console.WriteLine("Performing batch write in SingleTableBatch
Write()");
batchWrite.Execute();
}
For example, the following C# code snippet queries for all forum replies that were posted in the last 15
days.
This creates a Search object. You can now call the Search.GetNextSet method iteratively to retrieve
one page of results at a time as shown in the following C# code snippet. The code prints the attribute
values for each item that the query returns.
Console.WriteLine();
foreach (var attribute in document.GetAttributeNames())
{
string stringValue = null;
var value = document[attribute];
if (value is Primitive)
stringValue = value.AsPrimitive().Value;
else if (value is PrimitiveList)
stringValue = string.Join(",", (from primitive
in value.AsPrimitiveList().Entries
select primitive.Value).ToArray());
Console.WriteLine("{0} - {1}", attribute, stringValue);
}
}
Query(QueryOperationConfig config);
Assume that you want to execute the query in the preceding example (retrieve forum replies posted in
the last 15 days). However, assume that you want to provide optional query parameters to retrieve only
specific attributes and also request a strongly consistent read. The following C# code snippet constructs
the request using the QueryOperationConfig object.
using System;
using System.Collections.Generic;
using System.Linq;
using Amazon.DynamoDBv2;
using Amazon.DynamoDBv2.DocumentModel;
using Amazon.Runtime;
using Amazon.SecurityToken;
namespace com.amazonaws.codesamples
{
class MidLevelQueryAndScan
{
private static AmazonDynamoDBClient client = new AmazonDynamoDBClient();
FindRepliesInLast15DaysWithConfig(replyTable, forumName,
threadSubject);
FindRepliesPostedWithinTimePeriod(replyTable, forumName,
threadSubject);
// Get Example.
Table productCatalogTable = Table.LoadTable(client, "Product
Catalog");
int productId = 101;
GetProduct(productCatalogTable, productId);
{
string hashAttribute = forumName + "#" + threadSubject;
// Use Query overloads that takes the minimum required query para
meters.
Search search = table.Query(filter);
do
{
documentList = search.GetNextSet();
Console.WriteLine("\nFindRepliesPostedWithinTimePeriod: printing
replies posted within dates: {0} and {1} ............", startDate, endDate);
foreach (var document in documentList)
{
PrintDocument(document);
}
} while (!search.IsDone);
"PostedBy" },
ConsistentRead = true
};
PrintDocument(document);
} while (!search.IsDone);
}
count++;
Console.WriteLine();
foreach (var attribute in document.GetAttributeNames())
{
string stringValue = null;
var value = document[attribute];
if (value is Primitive)
stringValue = value.AsPrimitive().Value.ToString();
else if (value is PrimitiveList)
stringValue = string.Join(",", (from primitive
in value.AsPrimitiveL
ist().Entries
select primit
ive.Value).ToArray());
Console.WriteLine("{0} - {1}", attribute, stringValue);
}
}
}
}
Scan(ScanFilter filter);
For example, assume that you maintain a table of forum threads tracking information such as thread
subject (primary), the related message, forum Id to which the thread belongs, Tags, a multivalued attribute
for keywords, and other information. Assume that the subject is the primary key.
This is a simplified version of forums and threads that you see on AWS forums (see Discussion Forums).
The following C# code snippet queries all threads in a specific forum (ForumId = 101) that are tagged
"rangekey". Because the ForumId is not a primary key, the example scans the table. The ScanFilter
includes two conditions. Query returns all the threads that satisfy both of the conditions.
Scan(ScanOperationConfig config);
The following C# code snippet executes the same preceding query (find forum threads in which the
ForumId is 101 and the Tag attribute contains the "rangekey" keyword). However, this time assume that
you want to add an optional parameter to retrieve only a specific attribute list. In this case, you must create
a ScanOperationConfig object by providing all the parameters, required and optional as shown in the
following code example.
using System;
using System.Collections.Generic;
using System.Linq;
using Amazon.DynamoDBv2;
using Amazon.DynamoDBv2.DocumentModel;
namespace com.amazonaws.codesamples
{
class MidLevelScanOnly
{
private static AmazonDynamoDBClient client = new AmazonDynamoDBClient();
Console.ReadLine();
}
count++;
Console.WriteLine();
foreach (var attribute in document.GetAttributeNames())
{
string stringValue = null;
var value = document[attribute];
if (value is Primitive)
stringValue = value.AsPrimitive().Value.ToString();
else if (value is PrimitiveList)
stringValue = string.Join(",", (from primitive
in value.AsPrimitiveL
ist().Entries
select primitive.Value).ToAr
ray());
Console.WriteLine("{0} - {1}", attribute, stringValue);
}
}
}
}
Note
The object persistence model does not provide an API to create, update, or delete tables. It
provides only data operations. You can use only the AWS SDK for .NET low-level API to create,
update, and delete tables. For more information, see Working with Tables Using the AWS SDK
for .NET Low-Level API (p. 79).
To show you how the object persistence model works, let's walk through an example. We'll start with the
ProductCatalog table. It has Id as the primary key.
ProductCatalog(Id, ...)
Suppose you have a Book class with Title, ISBN, and Authors properties. You can map the Book class
to the ProductCatalog table by adding the attributes defined by the object persistence model, as shown
in the following C# code snippet.
[DynamoDBTable("ProductCatalog")]
public class Book
{
[DynamoDBHashKey]
public int Id { get; set; }
public string Title { get; set; }
public int ISBN { get; set; }
[DynamoDBProperty("Authors")]
public List<string> BookAuthors { get; set; }
[DynamoDBIgnore]
public string CoverPage { get; set; }
}
In the preceding example, the DynamoDBTable attribute maps the Book class to the ProductCatalog
table.
The object persistence model supports both the explicit and default mapping between class properties
and table attributes.
Explicit mappingTo map a property to a primary key, you must use the DynamoDBHashKey and
DynamoDBRangeKey object persistence model attributes. Additionally, for the non-primary key attributes,
if a property name in your class and the corresponding table attribute to which you want to map it are
not the same, then you must define the mapping by explicitly adding the DynamoDBProperty attribute.
In the preceding example, Id property maps to the primary key with the same name and the
BookAuthors property maps to the Authors attribute in the ProductCatalog table.
Default mappingBy default, the object persistence model maps the class properties to the attributes
with the same name in the table.
In the preceding example, the properties Title and ISBN map to the attributes with the same name
in the ProductCatalog table.
You don't have to map every single class property. You identify these properties by adding the
DynamoDBIgnore attribute. When you save a Book instance to the table, the DynamoDBContext does
not include the CoverPage property. It also does not return this property when you retrieve the book
instance.
You can map properties of .NET primitive types such as int and string. You can also map any arbitrary
data types as long as you provide an appropriate converter to map the arbitrary data to one of the
DynamoDB types. To learn about mapping arbitrary types, see Mapping Arbitrary Data with DynamoDB
Using the AWS SDK for .NET Object Persistence Model (p. 489).
The object persistence model supports optimistic locking. During an update operation this ensures you
have the latest copy of the item you are about to update. For more information, see Optimistic Locking
Using Version Number with DynamoDB Using the AWS SDK for .NET Object Persistence Model (p. 487).
DynamoDB Attributes
The following table lists the attributes the object persistence model offers so you can map your classes
and properties to DynamoDB tables and attributes.
Note
In the following table, only DynamoDBTable and DynamoDBHashKey are required tags.
Declarative Tag (attrib- Description
ute)
DynamoDBGlobalSec- Maps a class property to the hash key attribute of a global secondary index.
Use this attribute if you need to Query a global secondary index.
ondaryIndexHashKey
DynamoDBGlobalSec- Maps a class property to the range key attribute of a global secondary index.
Use this attribute if you need to Query a global secondary index and want to
ondaryInrefine your results using the index range key.
dexRangeKey
DynamoDBHashKey
Maps a class property to the hash attribute of the table's primary key. The
primary key attributes cannot be a collection type.
The following C# code examples maps the Book class to the ProductCatalog
table, and the Id property to the table's primary key hash attribute.
[DynamoDBTable("ProductCatalog")]
public class Book {
[DynamoDBHashKey]
public int Id { get; set; }
// Additional properties go here.
}
DynamoDBIgnore
Indicates that the associated property should be ignored. If you don't want to
save any of your class properties you can add this attribute to instruct DynamoDBContext not to include this property when saving objects to the table.
DynamoDBLocalSec- Maps a class property to the range key attribute of a local secondary index.
Use this attribute if you need to Query a local secondary index and want to
ondaryInrefine your results using the index range key.
dexRangeKey
DynamoDBProperty
Maps a class property to a table attribute. If the class property maps to the
same name table attribute, then you don't need to specify this attribute. However, if the names are not the same, you can use this tag to provide the mapping. In the following C# statement the DynamoDBProperty maps the
BookAuthors property to the Authors attribute in the table.
[DynamoDBProperty("Authors")]
public List<string> BookAuthors { get; set; }
DynamoDBContext uses this mapping information to create the Authors attribute when saving object data to the corresponding table.
Maps a class property to the range attribute of the table's primary key. If the
table's primary key is made of both the hash and range attributes, you must
specify both the DynamoDBHashKey and DynamoDBRangeKey attributes in
your class mapping.
For example, the sample table Reply has a primary key made of the Id hash
attribute and Replenishment range attribute. The following C# code example
maps the Reply class to the Reply table. The class definition also indicates
that two of its properties map to the primary key.
For more information about sample tables, see Example Tables and
Data (p. 678).
[DynamoDBTable("Reply")]
public class Reply {
[DynamoDBHashKey]
public int ThreadId { get; set; }
[DynamoDBRangeKey]
public string Replenishment { get; set; }
// Additional properties go here.
}
Identifies the target table in DynamoDB to which the class maps. For example,
the following C# code example maps the Developer class to the People table
in DynamoDB.
[DynamoDBTable("People")]
public class Developer { ...}
You can add the optional parameter, LowerCamelCaseProperties, to request DynamoDB to lower case the first letter of the property name when
storing the objects to a table as shown in the following C# snippet.
[DynamoDBTable("People", LowerCamelCaseProperties=true)]
public class Developer {
string DeveloperName;
...}
Identifies a class property for storing the item version number. To more information about versioning, see Optimistic Locking Using Version Number with
DynamoDB Using the AWS SDK for .NET Object Persistence Model (p. 487).
DynamoDBContext Class
The DynamoDBContext class is the entry point to the DynamoDB database. It provides a connection to
DynamoDB and enables you to access your data in various tables, perform various CRUD operations,
and execute queries. The DynamoDBContext class provides the following methods:
Method
Description
To retrieve the items from the table(s), use the ExecuteBatchGet method, passing
the MultiTableBatchGet object as a parameter.
CreateMul- Creates a MultiTableBatchWrite object, composed of multiple individual BatchtiTable
Write objects. Each of these BatchWrite objects can be used for writing or deleting
BatchWrite items in a single DynamoDB table.
To write to the table(s), use the ExecuteBatchWrite method, passing the MultiTableBatchWrite object as a parameter.
Create
BatchGet
Creates a BatchGet object that you can use to retrieve multiple items from a table. For
more information, see Batch Get: Getting Multiple Items (p. 495).
Create
Creates a BatchWrite object that you can use to put multiple items into a table, or to
BatchWrite delete multiple items from a table. For more information, see Batch Write: Putting and
Deleting Multiple Items (p. 493).
Delete
Deletes an item from the table. The method requires the primary key of the item you
want to delete. You can provide either the primary key value or a client-side object
containing a primary key value as a parameter to this method.
If you specify a client-side object as a parameter and you have enabled optimistic
locking, the delete succeeds only if the client-side and the server-side versions of the
object match.
If you specify only the primary key value as a parameter, the delete succeeds regardless of whether you have enabled optimistic locking or not.
Note
To perform this operation in the background, use the DeleteAsync method
instead.
Dispose
Execute
BatchGet
Reads data from one or more tables, processing all of the BatchGet objects in a MultiTableBatchGet.
Note
To perform this operation in the background, use the ExecuteBatchGetAsync
method instead.
Execute
Writes or deletes data in one or more tables, processing all of the BatchWrite objects
BatchWrite in a MultiTableBatchWrite.
Note
To perform this operation in the background, use the ExecuteBatchWriteAsync method instead.
Method
Description
FromDocument
Note
If your Document object implements the IEnumerable interface, you can use
the FromDocuments method instead. This will allow you to iterate over all of
the class instances in the Document.
FromQuery
Executes a Query operation, with the query parameters defined in a QueryOperationConfig object.
Note
To perform this operation in the background, use the FromQueryAsync
method instead.
FromScan
Executes a Scan operation, with the scan parameters defined in a ScanOperationConfig object.
Note
To perform this operation in the background, use the FromScanAsync method
instead.
GetTarget
Table
Retrieves the target table for the specified type. This is useful if you are writing a custom
converter for mapping arbitrary data to a DynamoDB table and need to determine which
table is associated with a custom data type.
Load
Retrieves an item from a table. The method requires only the primary key of the item
you want to retrieve.
By default, DynamoDB returns the item with values that are eventually consistent. For
information on the eventual consistency model, see Data Read and Consistency Considerations (p. 10).
Note
To perform this operation in the background, use the LoadAsync method instead.
Method
Description
Query
Note
To perform this operation in the background, use the QueryAsync method
instead.
Save
Saves the specified object to the table. If the primary key specified in the input object
does not exist in the table, the method adds a new item to the table. If primary key exists,
the method updates the existing item.
If you have optimistic locking configured, the update succeeds only if the client and the
server side versions of the item match. For more information, see Optimistic Locking
Using Version Number with DynamoDB Using the AWS SDK for .NET Object Persistence
Model (p. 487).
Note
To perform this operation in the background, use the SaveAsync method instead.
Method
Description
Scan
The Scan method returns a "lazy-loaded" IEnumerable collection. It initially returns only
one page of results, and then makes a service call for the next page if needed. To obtain
all the matching items, you only need to iterate over the IEnumerable.
For performance reasons you should query your tables and avoid a table scan.
Note
To perform this operation in the background, use the ScanAsync method instead.
ToDocument Returns an instance of the Document document model class from your class instance.
This is helpful if you want to use the document model classes along with the object
persistence model to perform any data operations. For more information about the
document model classes provided by the AWS SDK for .NET, see .NET: Document
Model (p. 446).
Suppose you have a client-side class mapped to the sample Forum table. You can then
use a DynamoDBContext to get an item, as a Document object, from the Forum table
as shown in the following C# code snippet.
DynamoDBContext context = new DynamoDBContext(client);
Forum forum101 = context.Load<Forum>(101); // Retrieve a forum by
primary key.
Document doc = context.ToDocument<Forum>(forum101);
Instead of setting these parameters at the DynamoDBContext level, you can specify them for individual
operations you execute using DynamoDBContext as shown in the following C# code snippet.The example
loads a specific book item. The Load method of DynamoDBContext specifies the preceding optional
parameters.
AmazonDynamoDBClient client = new AmazonDynamoDBClient();
...
DynamoDBContext context = new DynamoDBContext(client);
Book bookItem = context.Load<Book>(productId,new DynamoDBContextConfig{ Consist
entRead = true, SkipVersionCheck = true });
In this case DynamoDBContext includes these parameters only when sending the Get request.
The object persistence model also supports the .NET collection types with the following limitations:
Collection type must implement ICollection interface.
Collection type must be composed of the supported primitive types. For example,
ICollection<string>, ICollection<bool>.
Collection type must provide a parameter-less constructor.
The following table summarizes the mapping of the preceding .NET types to the DynamoDB types.
.NET primitive type
DynamoDB type
N (number type)
S (string type)
MemoryStream, byte[]
B (binary type)
bool
Collection types
BS (binary set) type, SS (string set) type, and NS (number set) type
DateTime
The object persistence model also supports arbitrary data types. However, you must provide converter
code to map the complex types to the DynamoDB types.
{
[DynamoDBHashKey]
// Hash key.
public int Id { get; set; }
[DynamoDBProperty]
public string Title { get; set; }
[DynamoDBProperty]
public string ISBN { get; set; }
[DynamoDBProperty("Authors")]
public List<string> BookAuthors { get; set; }
[DynamoDBVersion]
public int? VersionNumber { get; set; }
}
Note
You can apply the DynamoDBVersion attribute only to a nullable numeric primitive type (such
as int?).
Optimistic locking has the following impact on DynamoDBContext operations:
SaveFor a new item, DynamoDBContext assigns initial version number 0. If you retrieve an existing
item, and then update one or more of its properties and attempt to save the changes, the save operation
succeeds only if the version number on the client-side and the server-side match. The
DynamoDBContext increments the version number. You don't need to set the version number.
DeleteThe Delete method provides overloads that can take either a primary key value or an object
as parameter as shown in the following C# code snippet.
DynamoDBContext context = new DynamoDBContext(client);
...
// Load a book.
Book book = context.Load<ProductCatalog>(111);
// Do other operations.
// Delete 1 - Pass in the book object.
context.Delete<ProductCatalog>(book);
// Delete 2 - pass in the Id (primary key)
context.Delete<ProductCatalog>(222);
If you provide an object as the parameter, then the delete succeeds only if the object version matches
the corresponding server-side item version. However, if you provide a primary key value as the
parameter, the DynamoDBContext is unaware of any version numbers and it deletes the item without
making the version check.
Note that the internal implementation of optimistic locking in the object persistence model code uses
the conditional update and the conditional delete API actions in DynamoDB.
namespace com.amazonaws.codesamples
{
class HighLevelMappingArbitraryData
{
// 1. Create a book.
DimensionType myBookDimensions = new DimensionType()
{
Length = 8M,
Height = 11M,
Thickness = 0.5M
};
Dimensions = myBookDimensions
};
context.Save(myBook);
// hash key
[DynamoDBProperty("Authors")]
public List<string> BookAuthors { get; set; }
// Arbitrary type, with a converter to map it to DynamoDB type.
[DynamoDBProperty(typeof(DimensionTypeConverter))]
public DimensionType Dimensions { get; set; }
}
To delete one or more items, you can either specify the primary key of the item or a client-side object
that maps to the item you want to delete. Use the AddDeleteItem, AddDeleteItems, and the
AddDeleteKey methods to specify the list of items to delete.
Call the BatchWrite.Execute method to put and delete all the specified items from the table.
Note
When using object persistence model, you can specify any number of operations in a batch.
However, note that DynamoDB limits the number of operations in a batch and the total size of
the batch in a batch operation. For more information about the specific limits, see BatchWriteItem.
If the API detects your batch write request exceeded the allowed number of write requests or
exceeded the maximum allowed HTTP payload size, it breaks the batch in to several smaller
batches. Additionally, if a response to a batch write returns unprocessed items, the API will
automatically send another batch request with those unprocessed items.
Suppose that you have defined a C# class Book class that maps to the ProductCatalog table in DynamoDB.
The following C# code snippet uses the BatchWrite object to upload two items and delete one item
from the ProductCatalog table.
DynamoDBContext context = new DynamoDBContext(client);
var bookBatch = context.CreateBatchWrite<Book>();
// 1. Specify two books to add.
Book book1 = new Book
{
Id = 902,
ISBN = "902-11-11-1111",
ProductCategory = "Book",
Title = "My book3 in batch write"
};
Book book2 = new Book
{
Id = 903,
ISBN = "903-11-11-1111",
ProductCategory = "Book",
Title = "My book4 in batch write"
};
Call the Execute method of MultiTableBatchWrite, which performs the specified put and delete
operations on various tables.
Suppose that you have defined Forum and Thread C# classes that map to the Forum and Thread tables
in DynamoDB. Also, suppose that the Thread class has versioning enabled. Because versioning is not
supported when using batch operations, you must explicitly disable versioning as shown in the following
C# code snippet. The code snippet uses the MultiTableBatchWrite object to perform a multi-table
update.
DynamoDBContext context = new DynamoDBContext(client);
// Create BatchWrite objects for each of the Forum and Thread classes.
var forumBatch = context.CreateBatchWrite<Forum>();
DynamoDBOperationConfig config = new DynamoDBOperationConfig();
config.SkipVersionCheck = true;
var threadBatch = context.CreateBatchWrite<Thread>(config);
// 1. New Forum item.
Forum newForum = new Forum
{
Name = "Test BatchWrite Forum",
Threads = 0
};
forumBatch.AddPutItem(newForum);
// 2. Specify a forum to delete by specifying its primary key.
forumBatch.AddDeleteKey("Some forum");
// 3. New Thread item.
Thread newThread = new Thread
{
ForumName = "Amazon S3 forum",
Subject = "My sample question",
KeywordTags = new List<string> { "Amazon S3", "Bucket" },
Message = "Message text"
};
threadBatch.AddPutItem(newThread);
// Now execute multi-table batch write.
var superBatch = new MultiTableBatchWrite(forumBatch, threadBatch);
superBatch.Execute();
For a working example, see Example: Batch Write Operation Using the AWS SDK for .NET Object
Persistence Model (p. 500).
Note
DynamoDB batch API limits the number of writes in batch and also limits the size of the batch.
For more information, see BatchWriteItem. When using the .NET object persistence model API,
you can specify any number of operations. However, if either the number of operations in a batch
or size exceed the limit, the .NET API breaks the batch write request into smaller batches and
sends multiple batch write requests to DynamoDB.
namespace com.amazonaws.codesamples
{
class HighLevelItemCRUD
{
private static AmazonDynamoDBClient client = new AmazonDynamoDBClient();
// Retrieve the updated book. This time add the optional Consisten
tRead parameter using DynamoDBContextConfig object.
}
}
[DynamoDBTable("ProductCatalog")]
public class Book
{
[DynamoDBHashKey]
// Hash key.
namespace com.amazonaws.codesamples
{
class HighLevelBatchWriteItem
{
private static AmazonDynamoDBClient client = new AmazonDynamoDBClient();
}
catch (AmazonServiceException e) { Console.WriteLine(e.Message); }
};
[DynamoDBTable("Reply")]
public class Reply
{
[DynamoDBHashKey]
// Hash key.
[DynamoDBRangeKey]
// Range key.
[DynamoDBProperty("LastPostedBy")]
public string PostedBy { get; set; }
[DynamoDBTable("Thread")]
public class Thread
{
// PK mapping.
[DynamoDBHashKey]
public string ForumName { get; set; }
[DynamoDBRangeKey]
public String Subject { get; set; }
// Implicit mapping.
public string Message { get; set; }
public string LastPostedBy { get; set; }
public int Views { get; set; }
public int Replies { get; set; }
public bool Answered { get; set; }
public DateTime LastPostedDateTime { get; set; }
// Explicit mapping (property and table attribute names are different.
[DynamoDBProperty("Tags")]
public List<string> KeywordTags { get; set; }
// Property to store version number for optimistic locking.
[DynamoDBVersion]
public int? Version { get; set; }
}
[DynamoDBTable("Forum")]
public class Forum
{
[DynamoDBHashKey]
public string Name { get; set; }
// All the following properties are explicitly mapped,
// only to show how to provide mapping.
[DynamoDBProperty]
public int Threads { get; set; }
[DynamoDBProperty]
public int Views { get; set; }
[DynamoDBProperty]
public string LastPostBy { get; set; }
[DynamoDBProperty]
public DateTime LastPostDateTime { get; set; }
[DynamoDBProperty]
public int Messages { get; set; }
}
[DynamoDBTable("ProductCatalog")]
public class Book
{
[DynamoDBHashKey]
// Hash key.
namespace com.amazonaws.codesamples
// Scan table.
FindProductsPricedLessThanZero(context);
Console.WriteLine("To continue, press Enter");
Console.ReadLine();
}
catch (AmazonDynamoDBException e) { Console.WriteLine(e.Message);
}
catch (AmazonServiceException e) { Console.WriteLine(e.Message); }
IEnumerable<Reply> latestReplies =
context.Query<Reply>(replyId, QueryOperator.GreaterThan,
twoWeeksAgoDate);
Console.WriteLine("\nFindRepliesInLast15Days: Printing result.....");
string forumName,
string threadSub
ject)
{
string forumId = forumName + "#" + threadSubject;
Console.WriteLine("\nFindRepliesPostedWithinTimePeriod: Printing
result.....");
QueryOp
erator.Between, startDate, endDate);
foreach (Reply r in repliesInAPeriod)
Console.WriteLine("{0}\t{1}\t{2}\t{3}", r.Id, r.PostedBy,
r.Message, r.ReplyDateTime);
}
[DynamoDBTable("Reply")]
public class Reply
{
[DynamoDBHashKey]
// Hash key.
[DynamoDBRangeKey]
// Range key.
[DynamoDBProperty("LastPostedBy")]
public string PostedBy { get; set; }
// Property to store version number for optimistic locking.
[DynamoDBVersion]
public int? Version { get; set; }
}
[DynamoDBTable("Thread")]
public class Thread
{
// PK mapping.
[DynamoDBHashKey]
[DynamoDBProperty("Tags")]
public List<string> KeywordTags { get; set; }
// Property to store version number for optimistic locking.
[DynamoDBVersion]
public int? Version { get; set; }
}
[DynamoDBTable("Forum")]
public class Forum
{
[DynamoDBHashKey]
public string Name { get; set; }
// All the following properties are explicitly mapped,
// only to show how to provide mapping.
[DynamoDBProperty]
public int Threads { get; set; }
[DynamoDBProperty]
public int Views { get; set; }
[DynamoDBProperty]
public string LastPostBy { get; set; }
[DynamoDBProperty]
public DateTime LastPostDateTime { get; set; }
[DynamoDBProperty]
public int Messages { get; set; }
}
[DynamoDBTable("ProductCatalog")]
public class Book
{
[DynamoDBHashKey]
// Hash key.
"AttributeName": "Time",
"KeyType": "RANGE"
}
],
"TableStatus": "ACTIVE",
"CreationDateTime": Mon Mar 25 09:46:00 PDT 2013,
"ProvisionedThroughput": {
"NumberOfDecreasesToday": 0,
"ReadCapacityUnits": 10,
"WriteCapacityUnits": 10
},
"TableSizeBytes": 949,
"ItemCount": 23
}
}
In the low-level JSON wire protocol used by DynamoDB, the following abbreviations are used to denote
data types:
SString
NNumber
BBinary
BOOLBoolean
NULLNull
SSString set
NSNumber set
BSBinary set
LList
MMap
For more information about data types, see DynamoDB Data Types (p. 6).
If number precision is important to your application, convert number values to strings before you pass
them to DynamoDB.
Note
DynamoDB limits numbers to 38 digits. More than 38 digits will cause an error.
POST / HTTP/1.1
host: dynamodb.us-west-2.amazonaws.com
x-amz-date: 20130112T092034Z
x-amz-target: DynamoDB_20120810.CreateTable
Authorization: AWS4-HMAC-SHA256 Credential=AccessKeyID/20130112/us-west-2/dy
namodb/aws4_request,SignedHeaders=host;x-amz-date;x-amz-target,Signa
ture=145b1567ab3c50d929412f28f52c45dbf1e63ec5c66023d232a539a4afd11fd9
content-type: application/x-amz-json-1.0
content-length: 23
connection: Keep-Alive
Note
DynamoDB uses JSON as a transport protocol, and it parses the data for storage. However,
data is not stored natively in JSON format. For more information, see Using JSON Data Format
with DynamoDB (p. 513).
DynamoDB does not serialize null values. If you are using a JSON parser set to serialize null values for
requests, DynamoDB ignores them.
x-amz-crc32DynamoDB calculates a CRC32 checksum of the UTF-8 encoded bytes in the HTTP
response payload, and returns this checksum in the x-amz-crc32 header. We recommend that you
compute your own CRC32 checksum on the client side and compare it with the x-amz-crc32 header;
if the checksums do not match, it might indicate that the data was corrupted in transit. If this happens,
you should retry your request.
AWS SDK users do not need to manually perform this verification, because the SDKs compute the
checksum of each reply from DynamoDB and automatically retry if a mismatch is detected.
DynamoDB Response:
HTTP/1.1 200
x-amzn-RequestId: K2QH8DNOU907N97FNA2GDLL8OBVV4KQNSO5AEMVJF66Q9ASUAAJG
x-amz-crc32: 2215946753
Content-Type: application/x-amz-json-1.0
Content-Length: 144
Date: Mon, 16 Jan 2012 17:50:53 GMT
{
"Item": {
"Year": {"S": "1985"},
"Fans": {"SS": ["Fox","Lloyd"]},
"Name": {"S": "Back To The Future"},
"Rating": {"S": "****"}
}
}
For more request and response examples using various API operations, see the Amazon DynamoDB
API Reference.
Error Types
While interacting with DynamoDB programmatically, you might encounter errors of two types: client errors
and server errors. Each error has a status code (such as 400), an error code (such as
ValidationException), and an error message (such as Supplied AttributeValue is empty,
must contain exactly one of the supported data types).
Client Errors
Client errors are indicated by a 4xx HTTP response code.
Client errors indicate that DynamoDB found a problem with the client request, such as an authentication
failure, missing required parameters, or exceeding the table's provisioned throughput. Fix the issue in
the client application before submitting the request again.
Server Errors
Server errors are indicated by a 5xx HTTP response code, and need to be resolved by Amazon. You can
resubmit/retry the request until it succeeds.
Message
Cause
Retry
400
AccessDeniedException
Access denied.
General authentica- N
tion failure. The client did not correctly sign the request. Consult the
signing documentation.
400
ConditionalCheckFailedException
400
IncompleteSignatureException
400
400
LimitExceededException
Message
400
MissingAuthenticationTokenException
400
400
ResourceInUseException
400
ResourceNotFoundException
Requested resource
not found.
Example: Table
N
which is being requested does not
exist, or is too early
in the CREATING
state.
Cause
Retry
Message
Cause
400
ThrottlingException
This exception
Y
might be returned
if the following API
operations are requested too rapidly: CreateTable; UpdateTable; DeleteTable
400
UnrecognizedClientException
400
ValidationException
413
(n/a)
Maximum request
size of 1 MB exceeded.
500
InternalFailure
500
InternalServerError
503
ServiceUnavailableException
Retry
Catching Errors
For your application to run smoothly, you need to build logic into the application to catch and respond to
errors. One typical approach is to implement your request within a try block or if-then statement.
The AWS SDKs perform their own retries and error checking. If you encounter an error while using one
of the AWS SDKs, you should see the error code and description. You should also see a Request ID
value. The Request ID value can help troubleshoot problems with DynamoDB support.
The following example uses the AWS SDK for Java to delete an item within a try block and uses a catch
block to respond to the error (in this case, it warns the user that the request failed). The example uses
the AmazonServiceException class to retrieve information about any operation errors, including the
Request ID. The example also uses the AmazonClientException class in case the request is not
successful for other reasons.
try {
DeleteItemRequest request = new DeleteItemRequest(tableName, key);
DeleteItemResult result = dynamoDB.deleteItem(request);
System.out.println("Result: " + result);
// Get error information from the service while trying to run the operation
}
// limit retries
Operations in DynamoDB
The DynamoDB API supports the following operations:
BatchGetItem
BatchWriteItem
CreateTable
DeleteItem
DeleteTable
DescribeTable
GetItem
ListTables
PutItem
Query
Scan
UpdateItem
UpdateTable
For more information, see the Amazon DynamoDB API Reference.
Note
For backward compatibility with existing applications, DynamoDB also supports the previous
API version (2011-12-05). For more information, see Previous API Version (2011-12-05) (p. 737).
New applications should use the current API version (2012-08-10). For more information on
the current API, see the Amazon DynamoDB API Reference.
Step 2: Examine the Data Model and Implementation Details (p. 530) This section first describes
in detail the data model, including the indexes and the use of the composite value attribute. Then the
section explains how the application works.
Step 3: Deploy in Production Using the DynamoDB Service (p. 537) This section focuses on
deployment considerations in production. In this step, you create a table using the Amazon DynamoDB
service and deploy the application using AWS Elastic Beanstalk. When you have the application in
production, you also grant appropriate permissions so the application can access the DynamoDB table.
The instructions in this section walk you through the end-to-end production deployment.
Step 4: Clean Up Resources (p. 543) This section highlights areas that are not covered by this
example. The section also provides steps for you to remove the AWS resources you created in the
preceding steps so that you avoid incurring any charges.
Python
Flask (a microframework for Python)
AWS SDK for Python (Boto)
DynamoDB running on your computer
Git
On Linux, you don't specify the .exe extension. You only specify python get-pip.py.
Using PIP, install the Flask and Boto packages using the following code:
3. Download DynamoDB to your computer. For instructions on how to run it, see Running DynamoDB
On Your Computer (p. 544).
4. Download the Tic-Tac-Toe application:
a. Install Git. For instructions, go to git Downloads.
b. Execute the following code to download the application:
git clone https://github.com/awslabs/dynamodb-tictactoe-example-app.git
Start DynamoDB.
Start the web server for the Tic-Tac-Toe application.
To do so, open a command terminal, navigate to the folder where you downloaded the Tic-Tac-Toe
application, and run the application locally using the following code:
python.exe application.py --mode local --serverPort 5000 --port 8000
4.
Note
This example application does not perform any user authentication. The user ID is only used
to identify players. If two players log in with the same alias, the application works as if you
are playing in two different browsers.
5.
If this is your first time playing the game, a page appears requesting you to create the required table
(Games) in DynamoDB. Click CREATE TABLE.
6.
7.
Type user2 in the Choose an Opponent box, and click Create Game!
Doing this creates the game by adding an item in the Games table. It sets the game status to PENDING.
8.
9.
The browser passes information through cookies, so you should use incognito mode or private
browsing so that your cookies don't carry over.
Log in as user2.
A page appears that shows a pending invitation from user1.
The game page appears with an empty tic-tac-toe grid.The page also shows relevant game information
such as the game ID, whose turn it is, and game status.
11. Play the game.
For each user move, the web service sends a request to DynamoDB to conditionally update the game
item in the Games table. For example, the conditions ensure the move is valid, the square the user clicked
is available, and it was the turn of the user who made the move. For a valid move, the update operation
adds a new attribute corresponding to the click on the board. The update operation also sets the value
of the existing attribute to the user who can make the next move.
On the game page, the application makes asynchronous JavaScript calls every second, for up to five
minutes, to check if the game state in DynamoDB has changed. If it has, the application updates the page
with new information. After five minutes, the application stops making the requests and you need to refresh
the page to get updated information.
The Games table has a hash-type primary key made of the one attribute, GameId, of string type. The
application assigns a unique ID to each game. For more information on DynamoDB primary keys, see
Primary Key (p. 5).
When a user initiates a tic-tac-toe game by inviting another user to play, the application creates a new
item in the Games table with attributes storing game metadata, such as the following:
HostId, the user who initiated the game.
Opponent, the user who was invited to play.
The user whose turn it is to play. The user who initiated the game plays first.
The user who uses the O symbol on the board. The user who initiates the games uses the O symbol.
In addition, the application creates a StatusDate composite attribute, marking the initial game state
as PENDING.The following screenshot shows an example item as it appears in the DynamoDB console:
As the game progresses, the application adds one attribute to the table for each game move. The
attribute name is the board position, for example TopLeft or BottomRight. For example, a move
might have a TopLeft attribute with the value O, a TopRight attribute with the value O, and a
BottomRight attribute with the value X. The attribute value is either O or X, depending on which user
made the move. For example, consider the following board:
Composite value attributes The StatusDate attribute illustrates a composite value attribute. In
this approach, instead of creating separate attributes to store game status (PENDING, IN_PROGRESS,
and FINISHED) and date (when the last move was made), you combine them as single attribute, for
example IN_PROGRESS_2014-04-30 10:20:32.
The application then uses the StatusDate attribute in creating secondary indexes by specifying
StatusDate as a range attribute of the index key. The benefit of using the StatusDate composite
value attribute is further illustrated in the indexes discussed next.
Global secondary indexes You can use the table's primary key, GameId, to efficiently query the
table to find a game item. To query the table on attributes other than the primary key attributes,
DynamoDB supports the creation of secondary indexes. In this example application, you build the
following two secondary indexes:
hostStatusDate. This index has HostId as a hash key and StatusDate as a range key. You can
use this index to query on HostId, for example to find games hosted by a particular user.
opponentStatusDate. This index has Opponent as a hash key and StatusDate as a range key.
You can use this index to query on Opponent, for example to find games where a particular user is
the opponent.
These indexes are called global secondary indexes because the hash key attribute in these indexes
is not the same the hash key attribute GameId, used in the primary key of the table.
Note that both the indexes specify StatusDate, a composite range attribute. Doing this enables the
following:
You can query using the BEGINS_WITH comparison operator. For example, you can find all games
with the IN_PROGRESS attribute hosted by a particular user. In this case, the BEGINS_WITH operator
checks for the StatusDate value that begins with IN_PROGRESS.
DynamoDB keeps items in the index sorted by range attribute. So if all status prefixes are the same
(for example, IN_PROGRESS), the ISO format used for the date part will have items sorted from oldest
to the newest. This approach enables certain queries to be performed efficiently, for example the
following:
Retrieve up to 10 of the most recent IN_PROGRESS games hosted by the user who is logged in.
For this query, you specify the hostStatusDate index.
Retrieve up to 10 of the most recent IN_PROGRESS games where the user logged in is the opponent.
For this query, you specify the opponentStatusDate index.
For more information about secondary indexes, see Improving Data Access with Secondary Indexes in
DynamoDB (p. 249).
Home Page
After the user logs in, the application displays the following three lists of information:
Invitations This list shows up to the 10 most recent invitations from others that are pending acceptance
by the user who is logged in. In the preceding screenshot, user1 has invitations from user5 and user2
pending.
Games In-Progress This list shows up to the 10 most recent games that are in progress. These are
games that the user is actively playing, which have the status IN_PROGRESS. In the screenshot, user1
is actively playing a tic-tac-toe game with user3 and user4.
Recent History This list shows up to the 10 most recent games that the user finished, which have
the status FINISHED. In game shown in the screenshot, user1 has previously played with user2. For
each completed game, the list shows the game result.
In the code, the index function (in application.py) makes the following three calls to retrieve game
status information:
inviteGames
= controller.getGameInvites(session["username"])
inProgressGames = controller.getGamesWithStatus(session["username"], "IN_PRO
GRESS")
finishedGames
= controller.getGamesWithStatus(session["username"], "FINISHED")
Each of these calls return a list of items from DynamoDB that are wrapped by the Game objects. It is easy
to extract data from these objects in the view. The index function passes these object lists to the view to
render the HTML.
return render_template("index.html",
user=session["username"],
invites=inviteGames,
inprogress=inProgressGames,
finished=finishedGames)
The Tic-Tac-Toe application defines the Game class primarily to store game data retrieved from DynamoDB.
These functions return lists of Game objects that enable you to isolate the rest of the application from code
related to Amazon DynamoDB items. Thus, these functions help you decouple your application code from
the details of the data store layer.
The architectural pattern described here is also referred as the model-view-controller (MVC) UI pattern.
In this case, the Game object instances (representing data) are the model, and the HTML page is the
view. The controller is divided into two files. The application.py file has the controller logic for the
Flask framework, and the business logic is isolated in the gameController.py file.That is, the application
stores everything that has to do with DynamoDB SDK in its own separate file in the dynamodb folder.
Let us review the three functions and how they query the Games table using global secondary indexes
to retrieve relevant data.
gameInvitesIndex = self.cm.getGamesTable().query(
Opponent__eq=user,
StatusDate__beginswith="PENDING_",
index="opponentStatusDate",
limit=10)
In the index, for each OpponentId (the hash attribute) DynamoDB keeps items sorted by StatusDate
(the range attribute). Therefore, the games that the query returns will be the 10 most recent games.
The following section discusses in-progress games, but the same description also applies to finished
games.
A list of in-progress games for a given user includes both the following:
In-progress games hosted by the user
The function then combines the two lists, sorts, and for the first 0 to 10 items creates a list of the Game
objects and returns the list to the calling function (that is, the index).
games = self.mergeQueries(hostGamesInProgress,
oppGamesInProgress)
return games
Game Page
The game page is where the user plays tic-tac-toe games. It shows the game grid along with game-relevant
information. The following screenshot shows an example game in progress:
The function returns true if the item update was successful; otherwise, it returns false. Note the following
about the updateBoardAndTurn function:
The AWS SDK for Python API function calls are to low-level functions and not to mid-level functions
as in other parts of the code. Use of the low-level API lets the application have full control over the
request it sends to perform the update.
The mid-level API requires you to get an item first in order to update it using the UpdateItem API
operation. For information about the mid-level Python API for DynamoDB, go to DynamoDB API. Note
that these mid-level API functions are referred to as high-level in the SDK.
The function calls the update_item function of the AWS SDK for Python to make a finite set of updates
to an existing item. The function maps to the UpdateItem DynamoDB API operation. For more
information, see UpdateItem.
Note
The difference between the UpdateItem and PutItem operations is that PutItem replaces
the entire item. For more information, see PutItem.
The new attribute to add, specific to the current user move, and its value (for example, TopLeft="X").
attributeUpdates = {
position : {
"Action" : "PUT",
"Value" : { "S" : representation }
}
}
The game must be in progress. That is, the StatusDate attribute value must begin with
IN_PROGRESS.
The current turn must be a valid user turn as specified by the Turn attribute.
The square that the user clicked must be available. That is, the attribute corresponding to the square
must not exist.
expectations = {"StatusDate" : {"AttributeValueList": [{"S" : "IN_PROGRESS_"}],
"ComparisonOperator": "BEGINS_WITH"},
"Turn" : {"Value" : {"S" : current_player}},
position : {"Exists" : False}}
After the function returns, the selectSquare function calls redirect as shown in the following example:
redirect("/game="+gameId)
This call causes the browser to refresh. As part of this refresh, the application checks to see if the game
has ended in a win or draw. If it has, the application will update the game item accordingly.
In addition, you also have to configure permissions. Any AWS resources you create, such as the Games
table in DynamoDB, are private by default. Only the resource owner, that is the AWS account that created
the Games table, can access this table. Thus, by default your Tic-Tac-Toe application cannot update the
Games table.
To grant necessary permissions, you will create an AWS Identity and Access Management (IAM) role
and grant this role permissions to access the Games table. Your Amazon EC2 instance first assumes
this role. In response, AWS returns temporary security credentials that the Amazon EC2 instance can
use to update the Games table on behalf of the Tic-Tac-Toe application. When you configure your Elastic
Beanstalk application, you specify the IAM role that the Amazon EC2 instance or instances can assume.
For more information about IAM roles, go to IAM Roles for Amazon EC2 in the Amazon EC2 User Guide
for Linux Instances.
Note
Before you create Amazon EC2 instances for the Tic-Tac-Toe application, you must first decide
the AWS region where you want Elastic Beanstalk to create the instances. After you create the
Elastic Beanstalk application, you provide the same region name and endpoint in a configuration
file. The Tic-Tac-Toe application uses information in this file to create the Games table and send
subsequent requests in a specific AWS region. Both the DynamoDB Games table and the
Amazon EC2 instances that Elastic Beanstalk launches must be in the same AWS region. For
a list of available regions, go to Amazon DynamoDB in the Amazon Web Services General
Reference.
In summary, you do the following to deploy the Tic-Tac-Toe application in production:
1. Create an IAM role using the AWS IAM service.You will attach a policy to this role granting permissions
for DynamoDB actions to access the Games table.
2. Bundle the Tic-Tac-Toe application code and a configuration file, and create a .zip file. You use this
.zip file to give the Tic-Tac-Toe application code to Elastic Beanstalk to put on your servers. For more
information on creating a bundle, go to Creating an Application Source Bundle in the AWS Elastic
Beanstalk Developer Guide.
In the configuration file (beanstalk.config), you provide AWS region and endpoint information. The
Tic-Tac-Toe application uses this information to determine which DynamoDB region to talk to.
3. Set up the Elastic Beanstalk environment. Elastic Beanstalk will launch an Amazon EC2 instance or
instances and deploy your Tic-Tac-Toe application bundle on them. After the Elastic Beanstalk
environment is ready, you provide the configuration file name by adding the CONFIG_FILE environment
variable.
4. Create the DynamoDB table. Using the Amazon DynamoDB service, you create the Games table on
AWS, rather than locally on your computer. Remember, this table has a hash-type primary key made
of the GameId hash attribute of string type.
5. Test the game in production.
"dynamodb:ListTables"
],
"Effect":"Allow",
"Resource":"*"
},
{
"Action":[
"dynamodb:*"
],
"Effect":"Allow",
"Resource":[
"arn:aws:dynamodb:us-west-2:922852403271:table/Games"
]
}
]
}
For further instructions, go to Creating a Role for an AWS Service (AWS Management Console) in IAM
User Guide.
For a list of available regions, go to Amazon DynamoDB in the Amazon Web Services General
Reference.
Important
The region specified in the configuration file is the location where the Tic-Tac-Toe application
creates the Games table in DynamoDB. You must create the Elastic Beanstalk application
discussed in the next section in the same region.
Note
When you create your Elastic Beanstalk application, you will request to launch an environment
where you can choose the environment type. To test the Tic-Tac-Toe example application,
you can choose the Single Instance environment type, skip the following, and go to the
next step.
However, note that the Load balancing, autoscaling environment type provides a highly
available and scalable environment, something you should consider when you create and
deploy other applications. If you choose this environment type, you will also need to generate
a UUID and add it to the configuration file as shown following:
[dynamodb]
region=us-west-2
endpoint=dynamodb.us-west-2.amazonaws.com
[flask]
secret_key= 284e784d-1a25-4a19-92bf-8eeb7a9example
In client-server communication when the server sends response, for security's sake the
server sends a signed cookie that the client sends back to the server in the next request.
When there is only one server, the server can locally generate an encryption key when it
starts. When there are many servers, they all need to know the same encryption key;
otherwise, they won't be able to read cookies set by the peer servers. By adding secret_key
to the configuration file, we tell all servers to use this encryption key.
3.
Zip the content of the root folder of the application (which includes the beanstalk.config file)for
example, TicTacToe.zip.
4.
Upload the .zip file to an Amazon Simple Storage Service (Amazon S3) bucket. In the next section,
you provide this .zip file to Elastic Beanstalk to upload on the server or servers.
For instructions on how to upload to an Amazon S3 bucket, go to the Create a Bucket and Add an
Object to a Bucket topics in the Amazon Simple Storage Service Getting Started Guide.
Both testuser1 and testuser2 can play the game. For each move, the application will save the move in
the corresponding item in the Games table.
1.
Type the following custom URL to set up an Elastic Beanstalk console to set up the environment:
https://console.aws.amazon.com/elasticbeanstalk/?region=<AWS-Region>#/newAp
plication
?applicationName=TicTacToeyour-name
&solutionStackName=Python
&sourceBundleUrl=https://s3.amazonaws.com/<bucket-name>/TicTacToe.zip
&environmentType=SingleInstance
&instanceType=t1.micro
For more information about custom URLs, go to Constructing a Launch Now URL in the AWS Elastic
Beanstalk Developer Guide. For the URL, note the following:
You will need to provide an AWS region name (the same as the one you provided in the
configuration file), an Amazon S3 bucket name, and the object name.
For testing, the URL requests the SingleInstance environment type, and t1.micro as the instance
type.
The application name must be unique. Thus, in the preceding URL, we suggest you prepend your
name to the applicationName.
2.
3.
Doing this opens the Elastic Beanstalk console. In some cases, you might need to sign in.
In the Elastic Beanstalk console, click Review and Launch, and then click Launch.
Note the URL for future reference. This URL opens your Tic-Tac-Toe application home page.
4.
Configure the Tic-Tac-Toe application so it knows the location of the configuration file.
Click the gear box next to Software Configuration, as shown in the following screenshot.
b.
At the end of the Environment Properties section, type CONFIG_FILE and its value
beanstalk.config, and then click Save.
It might take a few minutes for this environment update to complete.
5.
6.
7.
8.
9.
Make sure that you clear all cookies in your browser window so you won't be logged in as same user.
Type the same URL to open the application home page, as shown in the following example:
http://<env-name>.elasticbeanstalk.com
2.
3.
4.
Terminate the Elastic Beanstalk environment to free up the Amazon EC2 instances.
Delete the IAM role you created.
Remove the object you created in Amazon S3.
Tip
For more best practices, how-to guides and tools, be sure to check the DynamoDB Developer
Resources page:
http://aws.amazon.com/dynamodb/developer-resources/
data transfer fees. In addition, you do not need to have an Internet connection in order to develop
applications.
The downloadable version of DynamoDB is ideal for development and testing purposes. When you are
ready to deploy your application in production, you simply redirect it to the Amazon DynamoDB web
service, without having to modify your application code.
Important
DynamoDB supports the Java Runtime Engine (JRE) version 6.x or newer; it will not run on
older JRE versions.
2.
3.
After you have downloaded the archive to your computer, extract the contents and copy the extracted
directory to a location of your choice.
To start DynamoDB on your computer, open a command prompt window, navigate to the directory
where you extracted DynamoDBLocal.jar, and enter the following command:
java -Djava.library.path=./DynamoDBLocal_lib -jar DynamoDBLocal.jar sharedDb
Note
DynamoDB uses port 8000 by default. If port 8000 is unavailable, this command will throw
an exception. You can use the -port option to specify a different port number. For a
complete list of DynamoDB runtime options, including -port , type this command:
java -Djava.library.path=./DynamoDBLocal_lib -jar DynamoDBLocal.jar
-help
-sharedDb DynamoDB will use a single database file, instead of using separate files for each
credential and region. If you specify -sharedDb, all DynamoDB clients will interact with the same
set of tables regardless of their region and credential configuration.
You will see occasional diagnostic messages in the window where DynamoDB is running. DynamoDB
will process incoming requests until you stop it. To stop DynamoDB, type Ctrl+C in the command
prompt window.
.NET
var config = new AmazonDynamoDBConfig();
config.ServiceURL = "http://localhost:8000";
client = new AmazonDynamoDBClient(config);
PHP
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2', #replace with your desired region
'endpoint' => 'http://localhost:8000'
));
Usage Notes
Except for the endpoint, applications that run with DynamoDB on your system should also work with the
Amazon DynamoDB web service. However, you should be aware of the following:
If you use the -sharedDb option, DynamoDB creates a single database file named
shared-local-instance.db. Every program that connects to DynamoDB will access this file. If you delete
the file, you will lose any data you have stored in it.
If you omit -sharedDb, the database file will be named myaccesskeyid_region.db, with the AWS access
key ID and region as they appear in your application configuration. If you delete the file, you will lose
any data you have stored in it.
If you use the -inMemory option, DynamoDB does not write any database files at all. Instead, all data
is written to memory, and the data is not saved when you terminate DynamoDB.
If you use the -optimizeDbBeforeStartup option, you must also specify the -dbPath parameter
so that DynamoDB will be able to find its database file.
JavaScript Shell
The downloadable version of DynamoDB provides a built-in JavaScript shell, which provides an easy-to-use
environment for prototyping and application development.
Note
We recommend that you access the JavaScript shell using Firefox or Chrome. If you run the
JavaScript shell in other browsers, errors may occur.
For more information about the JavaScript shell, including JavaScript code samples, see the Amazon
DynamoDB Getting Started Guide.
Note
Each edge has a direction, indicated by the arrow, but the edge information is still stored in both
the "in" and the "out" nodes.
A simple traversal of this graph can tell you what Justin's friends like.
Storage
Backend
Configuration Value
Consistency Availability
Scalability
Replication
Persistence
DynamoDB
com.amazon.ti- eventually
tan.diskstor- consistent,
age.dymanaged
namodb.DynamoDBStoreManager
SSD, managed
Cassandra
cassandra
eventually
consistent
highly available
disk
HBase
hbase
disk
BerkeleyDB
berkeleyje
ACID
single point
of failure
single machine
HA mode
available
disk
Persistit
persistit
ACID
single point
of failure
single machine
none
disk
InMemory
inmemory
ACID
single point
of failure
single machine
none
none
Using DynamoDB for graph storage gives you a highly scalable distributed graph database without the
burden of managing database clusters. DynamoDB can scale to any size, provides fast, predictable
performance, and is highly available with automatic data replication across three Availability Zones in an
AWS region. It also provides AWS-managed authentication and multiple graphs in a single account and
region by prepending prefixes to Titan graph tables.
Titan Features
The DynamoDB Storage Backend for Titan plugin supports Titan versions 0.4.4 and 0.5.4. Titan offers
the following:
Fast traversals and arbitrary traversals along specified edge types
Directed, typed edges
Stored relationships
Titan 0.4.4 supports the Tinkerpop 2.4 stack by implementing the Blueprints API. Tinkerpop includes the
following components:
dynamodb
cassandra
berkeleyje
hbase
persistit
(0.4.4 only)
in memory
(0.5.4 only)
batchMutation
Yes
Yes
No
Yes
No
No
distributed
Yes
Yes
No
Yes
No
No
keyConsistent
Yes
Yes
No
Depends on No
config
Depends on
config
keyOrdered
No
Depends on Yes
partitioner
Yes
Yes
Yes
localKeyPar- No
tition
Depends on No
partitioner
No
No
No
locking
Yes
No
Yes
No
Yes
No
multiQuery
Yes
Yes, except
cassandraembedded
No
Yes
No
No
orderedScan No
Depends on Yes
partitioner
Yes
Yes
Yes
transactional No
No
No
Yes
No
Yes
unorderedScan
Yes
Depends on No
partitioner
Yes
optimisticLocking
(0.5.4 only)
Yes
Yes
No
Yes
Yes
cellTTL
(0.5.4 only)
No
Yes
No
No
No
storeTTL
(0.5.4 only)
No
No
No
Yes
No
preferredTimestamps
(0.5.4 only)
No
Yes
MILLI
timestamps
(0.5.4 only)
No
Yes
No
Yes
No
visibility
(0.5.4 only)
No
No
No
No
No
Cassandra Partitioners
Partitioner
RANDOM
BYTEORDER
keyOrdered / localKeyPartition
No
Yes
orderedScan
No
Yes
unorderedScan
Yes
No
Next Step
Getting Started with the DynamoDB Storage Backend for Titan (p. 552)
Launch DynamoDB Storage Backend for Titan with Rexster on Amazon EC2 by using a AWS
CloudFormation template (p. 556)
Storage in Local DynamoDB vs. the Amazon DynamoDB Service (p. 557)
In the folder where you want to set up the Git project, run the following command to clone the Git
project.
git clone https://github.com/awslabs/dynamodb-titan-storage-backend.git
Note
This git command is for Titan Version 0.5.4. For the Titan 0.4.4 git command, see the
README.md file for Titan 0.4.4.
2.
Change into the dynamodb-titan-storage-backend folder, and then type the following command
to install the package using Maven.
mvn install
3.
When you install Maven, it downloads the additional dependencies from the Maven repository,
including the Titan package.
Open another command-prompt window, and then type the following command to start DynamoDB
on your computer (for testing the graph database).
mvn test -Pstart-dynamodb-local
4.
In the previous command-prompt window, then typ the following command to run the Gremlin shell.
mvn test -Pstart-gremlin
5.
Type the following to open a graph using the DynamoDB Storage Backend for Titan in the Gremlin
shell.
conf = new BaseConfiguration()
conf.setProperty("storage.backend", "com.amazon.titan.diskstorage.dynamodb.Dy
namoDBStoreManager")
conf.setProperty("storage.dynamodb.client.endpoint", "http://localhost:4567")
conf.setProperty("index.search.backend", "elasticsearch")
Note
This configuration is for Titan Version 0.5.4. For the Titan 0.4.4 configuration, see the
README.md file for Titan 0.4.4.
6.
Type the following command to load the first 100 lines of the Marvel Universe Social Graph.
com.amazon.titan.example.MarvelGraphFactory.load(g, 100, false)
To increase the number of test lines and create a larger graph, raise the value of the second argument
to the MarvelGraphFactory.load() method.
7.
Type the following to print the characters and the comic-books they appeared in where the characters
had a weapon that was a shield or claws.
g.V.has('weapon', T.in, ['shield','claws']).as('c').outE('ap
peared').inV.as('b').transform{e,m -> m.c.character + ' had ' + m.c.weapon
+ ' in ' + m.b['comic-book']}.order
8.
Type the following to print the characters and the comic-books they appeared in where the characters
had a weapon that was not a shield or claws.
g.V.has('weapon', T.notin, ['shield','claws']).as('c').outE('ap
peared').inV.as('b').transform{e,m -> m.c.character + ' had ' + m.c.weapon
+ ' in ' + m.b['comic-book']}.order
9.
Type the following to print a sorted list of the characters that appear in comic-book AVF 4.
g.V.has('comic-book', 'AVF 4').inE('appeared').outV.character.order
10. Print a sorted list of the characters that appear in comic-book AVF 4 that have a weapon that is not
a shield or claws.
g.V.has('comic-book', 'AVF 4').inE('appeared').outV.has('weapon', T.notin,
['shield','claws']).character.order
3.
Go to the Titan Getting Started documentation and then follow the rest of the setup process, starting
from the Global Graph Indices section.
2.
3.
4.
Replace localhost in the base-uri tag of rexster.xml with the fully qualified domain name (FQDN) of
the host you want to run Rexster on, if you do not run it on localhost. The ec2-metadata -p
command on Amazon Linux in EC2 reveals the public FQDN of the an EC2 host.
Install Titan server, which includes Rexster, and then follow the instructions at the command prompt.
src/test/resources/install-rexster.sh
5.
Note
You will need to run rexster.sh with sudo if you choose 80 instead of 8182 as the Rexster
port.
6.
Test that the endpoint works from the command line. There should be no vertices.
curl http://localhost:8182/graphs/marvel/vertices | python -m json.tool
7.
Navigate to http://localhost:8182/ and open a graph using the DynamoDB Storage Backend for Titan
on the Gremlin shell in the Gremlin tab.
import com.thinkaurelius.titan.example.GraphOfTheGodsFactory; GraphOfThe
GodsFactory.load(g);
Next steps
Now that you have the Gremlin shell on Rexster, you can start working with Titan. Here are some options
for continuing:
Follow Titan Getting Started tutorial
Go to the Titan Getting Started documentation and then follow the rest of the setup process, starting
from the Global Graph Indices section.
Follow the Gremlin examples
To learn more about Gremlin, repeat steps 1 through 4 of this section and follow the examples in the
Gremlin documentation.
Experiment with the Marvel graph
To work with the Marvel Social Graph data, repeat steps 1 through 4 of this section and then redo
steps 6 through 10 of the Marvel graph section.
To learn more about the Rexster REST API, go to the Rexster documentation.
Next Steps
Storage in Local DynamoDB vs. the Amazon DynamoDB Service (p. 557)
Launch DynamoDB Storage Backend for Titan with Rexster on Amazon EC2 by using a AWS
CloudFormation template (p. 556)
Prerequisites
An SSH key for Amazon EC2 instances must exist in the region you plan to create the Rexster stack.
The name and path of an IAM role in the region that has Amazon S3 Read access and DynamoDB full
access, the very minimum policies required to run this CloudFormation stack. Amazon S3 read access
is required to provide the rexster.xml file to the stack in cloud-init. DynamoDB full access is required
because the DynamoDB Storage Backend for Titan must create and delete tables, and read and write
data in those tables.
Note
The AWS CloudFormation template downloads repackaged versions of
titan-dynamodb-0.5.4-hadoop2.zip and titan-dynamodb-server-0.4.4.zip .The DynamoDB Storage
Backend for Titan and its dependencies have been added to the default distributions. They are
available for download from the following websites:
0.4.4: dynamodb-titan044-storage-backend-server-1.0.0.zip (SHA256 hash:
a3bbd0e5eb0b71bbadf6762def516f5836c8032c442d5f39799c56c5345cb14b)
0.5.4: dynamodb-titan054-storage-backend-1.0.0-hadoop2.zip (SHA256 hash:
41e8a45da86910ff7f4a3cf49ffa70df99d4230c29ccdf0453581f74353c8ea9)
Click the following link to view the AWS CloudFormation template that creates a Rexster stack using
the DynamoDB Storage Backend for Titan:
View Version 0.4.4 Template
2.
3.
Note
This walkthrough uses the default settings. However, this page lets you customize the name
of the AWS CloudFormation stack, or use a different template.
4.
RexPro port, if you changed the value in rexster.xml from the default 8184.
Rexster port, if you changed the value in rexster.xml from the default 8182.
The Amazon S3 URL to your rexster.xml file.
The name of your pre-existing Amazon EC2 SSH key.
The path of your IAM Role that enables Amazon S3 read permissions and DynamoDB full
permissions.
The name of your IAM Role that enables Amazon S3 read permissions and DynamoDB full
permissions.
5.
You can change the Network whitelist and Amazon EC2 instance type.
On the Options page, click Next.
Note
For this walkthrough, you use the default settings.
6.
On the Review page, select I acknowledge that this template might cause AWS CloudFormation
to create IAM resources, and then click Create.
Note
This AWS CloudFormation template does not create IAM resources.
7.
While the stack is deploying, you can monitor its progress by going to the AWS CloudFormation
console and viewing the Status column for the Amazon EC2 instance.
8. When stack creation is complete, go to the Outputs tab of your new stack.
9. Copy the SSH tunnel command from the CloudFormation script Outputs and use it to create an SSH
tunnel from your localhost port 8182 to the Rexster port (8182) on the EC2 host after the stack
deployment is complete.
10. Continue the To run Gremlin on Rexster (p. 555) section in the previous topic starting from Step 5.
Next Step
Titan Graph Modeling in DynamoDB (p. 558)
To switch the storage backend from local DynamoDB to the Amazon DynamoDB web
service
1.
2.
storage.dynamodb.client.endpoint=https://dynamodb.us-west-2.amazonaws.com
For a list of available regions and endpoints, go to the Amazon DynamoDB section in the Amazon
Web Services General Reference.
You can now run Titan without having to run DynamoDB on your computer. The Titan DynamoDB Storage
backend will use tables in the DynamoDB region of your endpoint instead of a local instance of DynamoDB.
Related Topics
Titan Graph Modeling in DynamoDB (p. 558)
Config Property
Description
DynamoDBSingleRowStore
SINGLE
DynamoDBStore
MULTI
Description
edgestore
edgeindex
Index of edges.
Table
Description
vertexindex
titan_ids
system_properties
Titan version 0.5.4 uses different backend tables. Including edgstore, the Titan version 0.5.4 uses the
following DynamoDB tables for storage:
Table
Description
edgestore
graphindex
systemlog
txlog
Transaction log.
titan_ids
system_properties
Note
Titan version 0.5.4 also supports user-defined transaction logs, which are each stored in a table.
You can select either single or multiple item storage options in the DynamoDB Storage Backend for Titan
properties file. The following sections describe the two implementations.
Note
This is a representation of the data that is stored in a table. The actual data is serialized with
compressed metadata and is not human readable.
Hash Key (hk) Attribute
Attribute
Attribute
Attribute
Attribute
Vertex id 1
Hidden Property
- Exists
Vertex id 2
Vertex id 3
Vertex id 4
Vertex id 5
This table does not show all of the data that is stored in each attribute. For information about the data
and data format of edges and properties stored in attributes, see the Titan Data Model page.
A limitation of this model is that storing everything in a single item limits the number of properties and
edges incident to each vertex because DynamoDB has a 400 KB item size limit.
Note
This is a representation of the data that is stored in a table. The actual data is serialized with
compressed metadata and is not human readable.
Hash Key (hk)
Vertex id 1
Range key
Vertex id 1
Property id
Vertex id 1
Edge id
Vertex id 1
Edge id
Vertex id 1
Edge id
Vertex id 1
Property id
Vertex id 2
Range key
Vertex id 2
Property id
Value (v)
Vertex id 2
Edge id
Vertex id 2
Edge id
Vertex id 2
Property id
Vertex id 3
Range key
Vertex id 3
Property id
Vertex id 3
Edge id
Vertex id 3
Edge id
Vertex id 3
Property id
Vertex id 4
Range key
Vertex id 4
Property id
Vertex id 4
Edge id
Vertex id 4
Edge id
Vertex id 4
Property id
Vertex id 5
Range key
Vertex id 5
Property id
Vertex id 5
Edge id
Vertex id 5
Property id
This table does not show all of the data that is stored in each attribute. For information about the data
and the data format of edges and properties stored in attributes, go to the Titan Data Model page.
Although the multiple item data model lets you avoid the 400 KB item limit, it comes with a performance
penalty. Scanning the base table to iterate over vertices in the edgestore table can take much longer in
the multiple item data model than in the single item data model.
The multiple item data model overcomes the 400 KB limit by denormalizing one entity in a store into one
item for each column at a key. This functionality means that one key appears once for each column in a
multiple item data store. The greater scan time for this model occurs because a separate item exists in
this model for each edge label, vertex property, and edge property. The edgestore_key table stores the
key and revision number of the store entry, so a scan only accesses a KCV key once with each mutating
operation. This functionality means that any mutation to a KCV store requires at least two HTTP round
trips, one for the key table and at least one for the base table, and more if the mutation only involves
deleting columns.
Note
Edges are bidirectional by default. Unless you create unidirectional (out only) edges, the edges
out and in will be equal.
Edges into vertex: The number of edges coming in to the vertex.
Hidden properties: Properties stored by Titan. Each vertex has at least an exists property. Inn Titan
version 0.4.4 there is at least 1 hidden property per vertex and in Titan 0.5.4 there is at least 2 hidden
properties per vertex.
Note
In the single item data model, many of the graph objects are serialized into a single item with
the vertex, so they are not needed to estimate usage.
Type
Update/DeleteItem calls to
Update/DeleteItem calls to
edgestore, SINGLE item model edgestore, MULTI item model
Create
vertices * edgesOutOfVertex
vertices * (vertexProperties +
edgesIntoVertex + edgesOutOfVertex + titanHiddenProperties)
Updating
vertices * edgesOutOfVertex
vertices + vertexProperties +
edgesIntoVertex + edgesOutOfVertex + titanHiddenProperties
Reading
vertices
vertices + vertexProperties +
edgesIntoVertex + edgesOutOfVertex + titanHiddenProperties
The preceding table separates capacity estimations by storage model and operation type. The following
list gives more information on DynamoDB activity for different operation types, and discusses the effects
of indexes.
Loading data
Bulk loading of data is very write intensive. Loading new data into a graph requires items to be created
in the backend database. In the multiple item model creating is more intensive because each vertex,
property, and edge is written as a separate item.
Updating data
Updating data is less intensive with the multiple item storage model because it only needs to update
the items for the specific property or edge that is being updated. In the single item storage model,
the entire item must be updated.
Reading data
In the multiple item model, reading a subset of properties or edges can more efficient than in the
single model because only the items you request are read instead of the whole item.
Operations on the graphindex table
In the single item model, items in the graphindex table are keyed at unique vertex/edge property
name and value combinations, and the other item attributes (columns) represent the vertexs/edge
identifiers that have this property value. In the multiple item model, items in the graphindex are still
keyed at the property name/value combinations, but there is a separate item for each vertex/edge
that has that property name/value combination. Therefore, in the single item model, you will have
one item per property/value combination written to graphindex. In the multiple item model, you will
have vertices * vertexProperties + edges * edgeProperties items written to graphindex.
Metrics
Titan uses the Metrics-core package to record and emit metrics. Metrics-core supports reporting metrics
over JMX, HTTP, STDOUT, CSV, SLF4j, Ganglia, and Graphite. There are more reporters available as
third-party plugins.You can learn more about the Metrics-core package from the Metrics website at https://
dropwizard.github.io/metrics/3.1.0/manual/core/.
You can turn on Metrics by using the following properties:
metrics.enabled=true
Note
Properties can be set in a properties file in the classpath, directly in the Gremlin shell using a
configuration object, or in the rexster.xml file.
To set the metrics configuration properties in the Gremlin shell, type the following:
Metrics core supports a variety of quantity measurements. A Timer is a Meter on the rate and a Histogram
on latency of a piece of code. Histograms measure the distribution of a particular value and emit count,
max, mean, min, stddev, p50, p75, p95, p98, p99, and p999. Meters measure a call rate (tps) and emit
count, mean_rate, m1_rate, m5_rate and m15_rate. Gauges measure a value in a different thread and
emit a value. Counters count the number of times a piece of code is called and emit a count.
Titan emits the metrics described in the table on the Titan Metrics (p. 565) page.
The Amazon DynamoDB Storage Backend for Titan emits metrics in addition to those emitted by Titan.
They relate to statistics the low-level DynamoDB APIs, and are described in the table on the Additional
Amazon DynamoDB Storage Backend for Titan Metrics (p. 568).
Titan Metrics
The metrics for Titan 0.5.4 are a superset of the metrics generated by Titan 0.4.4.
Note
<store> indicates the graph store that the metric is associated with.
Metric name
Titan Version
Scope
Instrumentation type
db.getVertexByID
Global
Counter
db.getVerticesByID
Global
Counter
<store>.getKeys.calls
0.5.4
Graph Store
Counter
<store>.getKeys.iterat- 0.5.4
or.hasNext.calls
Graph Store
Counter
<store>.getKeys.iterat- 0.5.4
or.hasNext.time
Graph Store
Timer (Histogram+Meter)
<store>.getKeys.iterat- 0.5.4
or.next.calls
Graph Store
Counter
<store>.getKeys.iterat- 0.5.4
or.next.time
Graph Store
Timer (Histogram+Meter)
<store>.getKeys.time
0.5.4
Graph Store
Timer (Histogram+Meter)
<store>.getSlice.calls
Graph Store
Counter
Graph Store
Histogram
Graph Store
Counter
<store>.getSlice.time
Graph Store
Timer (Histogram+Meter)
<store>.acquireLock.calls
Graph Store
Counter
<store>.acquireLock.time
Graph Store
Timer (Histogram+Meter)
query.graph.execute.calls
Global
Counter
query.graph.execute.ex- 0.5.4
ceptions
Global
Counter
query.graph.execute.time
Global
Timer (Histogram+Meter)
query.graph.getNew.calls
Global
Counter
query.graph.getNew.time
Global
Timer (Histogram+Meter)
query.graph.hasDeletions.calls
Global
Counter
query.graph.hasDeletions.time
Global
Timer (Histogram+Meter)
query.graph.isDeleted.calls
Global
Counter
query.graph.isDeleted.time
Global
Timer (Histogram+Meter)
query.vertex.execute.calls
Global
Counter
query.vertex.execute.time
Global
Timer (Histogram+Meter)
query.vertex.getNew.calls
Global
Counter
query.vertex.getNew.time
Global
Timer (Histogram+Meter)
query.vertex.hasDeletions.calls
Global
Counter
query.vertex.hasDeletions.time
Global
Timer (Histogram+Meter)
query.vertex.isDeleted.calls
0.5.4
Global
Counter
query.vertex.isDeleted.time
0.5.4
Global
Timer (Histogram+Meter)
schemacache.name.misses 0.5.4
Global
Counter
schemacache.name.re- 0.5.4
trievals
Global
Counter
schemacache.relations.misses
0.5.4
Global
Counter
schemacache.relations.retrievals
0.5.4
Global
Counter
Global
Counter
Global
Timer (Histogram+Meter)
stores.getKeys.calls
0.5.4
Global
Counter
stores.getKeys.iterator.hasNext.calls
0.5.4
Global
Counter
stores.getKeys.iterator.hasNext.time
0.5.4
Global
Timer (Histogram+Meter)
stores.getKeys.iterator.next.calls
0.5.4
Global
Counter
stores.getKeys.iterator.next.time
0.5.4
Global
Timer (Histogram+Meter)
stores.getKeys.time
0.5.4
Global
Timer (Histogram+Meter)
stores.getSlice.calls
Global
Counter
stores.getSlice.entrieshistogram
Global
Histogram
stores.getSlice.entriesreturned
Global
Counter
stores.getSlice.time
Global
Timer (Histogram+Meter)
System Store
Counter
System Store
Histogram
System Store
Counter
System Store
Timer (Histogram+Meter)
System Store
Counter
System Store
Timer (Histogram+Meter)
Global
Counter
Global
Histogram
Global
Counter
Global
Timer (Histogram+Meter)
sys.stores.mutate.calls
Global
Counter
sys.stores.mutate.time
Global
Timer (Histogram+Meter)
tx.begin
Global
Counter
tx.commit
Global
Counter
tx.commit.exceptions
0.5.4
Global
Counter
tx.rollback
0.5.4
Global
Counter
Metric name
Instrumentation type
<ddb>.<prefix>_ListTablesHistogram
Timer (Histogram+Meter)
<ddb>.<prefix>_mutateManyGauge
Timer (Histogram+Meter)
<ddb>.<prefix>_executor-queue-size
Gauge
<ddb>.<prefix>_ListTablesPagesTimer
Histogram
<ddb>.CreateTable.<prefix>_<store>
Timer (Histogram+Meter)
<ddb>.DeleteItem.<prefix>_<store>
Timer (Histogram+Meter)
<ddb>.DeleteItemConsumedCapacity.<prefix>_<store>
Meter
<ddb>.DeleteItemRetries.<prefix>_<store>
Meter
Timer (Histogram+Meter)
<ddb>.DescribeTable.<prefix>_<store>
Timer (Histogram+Meter)
<ddb>.GetItem.<prefix>_<store>
Timer (Histogram+Meter)
<ddb>.GetItemConsumedCapacity.<prefix>_<store>
Meter
<ddb>.GetItemRetries.<prefix>_<store>
Meter
<ddb>.GetItemThrottling.<prefix>_<store>
Timer (Histogram+Meter)
<ddb>.Query.<prefix>_<store>
Timer (Histogram+Meter)
<ddb>.QueryConsumedCapacity.<prefix>_<store>
Meter
<ddb>.QueryItemCountCounter.<prefix>_<store>
Counter
<ddb>.QueryItemCountHistogram.<prefix>_<store>
Histogram
<ddb>.QueryPages.<prefix>_<store>
Histogram
<ddb>.QueryRetries.<prefix>_<store>
Meter
<ddb>.QueryThrottling.<prefix>_<store>
Timer (Histogram+Meter)
<ddb>.Scan.<prefix>_<store>
Timer (Histogram+Meter)
<ddb>.ScanConsumedCapacity.<prefix>_<store>
Meter
<ddb>.ScanItemCountCounter.<prefix>_<store>
Counter
<ddb>.ScanItemCountHistogram.<prefix>_<store>
Histogram
<ddb>.ScanPages.<prefix>_<store>
Histogram
<ddb>.ScanRetries.<prefix>_<store>
Meter
<ddb>.ScanThrottling.<prefix>_<store>
Timer (Histogram+Meter)
<ddb>.UpdateItem.<prefix>_<store>
Timer (Histogram+Meter)
<ddb>.UpdateItemBytes.<prefix>_<store>
Histogram
<ddb>.UpdateItemConsumedCapacity.<prefix>_<store>
Meter
<ddb>.UpdateItemRetries.<prefix>_<store>
Meter
Prerequisites
The following items are required to use the Logstash plugin for Amazon DynamoDB:
Amazon Web Services (AWS) account with DynamoDB
A running Elasticsearch clusterTo download Elasticsearch, go to https://www.elastic.co/products/
elasticsearch.
LogstashTo download Logstash, go to https://github.com/awslabs/logstash-input-dynamodb.
JRubyTo download JRuby, go to http://jruby.org/download.
GitTo download Git, go to http://git-scm.com/downloads
Apache MavenTo get Apache Maven, go to http://maven.apache.org/.
4.
5.
6.
Table NameSourceTable
Primary Key TypeHash
Hash attribute data typeNumber
Hash Attribute NameId
Choose Continue.
On the Add Indexes page, choose Continue. You will not need any indexes for this exercise.
On the Provisioned Throughput page, choose Continue.
On the Additional Options page, do the following:
a.
Select Enable Streams, and then set the View Type to New and Old Images.
b.
Clear Use Basic Alarms. You will not need alarms for this exercise.
At the command prompt, change to the directory where you want to install the Logstash plugin for
DynamoDB and demo project.
In the directory where you want the Git project, clone the Git project:
https://github.com/awslabs/logstash-input-dynamodb.git
2.
3.
The Bundler gem checks dependencies for Ruby gems and installs them for you.
To install the dependencies for the Logstash plugin for DynamoDB, type the following command:
bundle install
4.
4.
Note
This command is formatted for the Bash shell. If you are using a different command-line
you may need to change the format. For example, in the Windows command prompt, you
must change all the slashes (/) to backslashes (\).
5.
Before running the Logstash plugin for DynamoDB, verify that you have the Elasticsearch and stdout
output plugins installed.
To list all the installed plugins type the following command:
bin/plugin list
Note
This is a single command formatted for the Bash shell. If you are using a different command-line
you may need to change the format. For example, in the Windows command prompt, you must
change all the slashes (/) to backslashes (\) and it must all be entered on a single line.
Important
This is an example configuration. You must replace <access_key_id> and <secret_key>
with your access key and secret key. If you have credentials saved in a credentials file, you
can omit these configuration values.
You can also change the other configuration options to match your particular use case.
The following table shows the configuration values.
Setting
Description
table_name
endpoint
streams_endpoint
view_type
aws_access_key_id
Note
If you are running DynamoDB on your
computer, this ID must match the access
key ID that you used to create the table.
If it does not match, the Logstash plugin
will fail because DynamoDB partitions
data by access key ID and region.
aws_secret_access_key
perform_scan
Note
Set this option to false if your are restarting the Logstash plugin.
checkpointer
A string that uniquely identifies the KCL checkpointer name and CloudWatch metrics name.
This is used when one worker leaves a shard so
that another worker knows where to start again.
publish_metrics
perform_stream
read_ops
number_of_scan_threads
number_of_write_threads
log_format
4.
5.
6.
You can now search the DynamoDB items in Elasticsearch. For information about accessing and searching
data in Elasticsearch, see the Elasticsearch documentation.
The following commands will add new items to the table. These example use a combination of shorthand
syntax and JSON.
aws dynamodb put-item
--table-name MusicCollection
--item '{
"Artist": {"S": "No One You Know"},
"SongTitle": {"S": "Call Me Today"} ,
"AlbumTitle": {"S": "Somewhat Famous"} }'
--return-consumed-capacity TOTAL
aws dynamodb put-item
--table-name MusicCollection
--item '{
"Artist": {"S": "Acme Band"},
On the command line, it can be difficult to compose valid JSON; however, the AWS CLI can read JSON
files. For example, consider the following JSON snippet which is stored in a file named key-conditions.json:
{
"Artist": {
"AttributeValueList": [
{
"S": "No One You Know"
}
],
"ComparisonOperator": "EQ"
},
"SongTitle": {
"AttributeValueList": [
{
"S": "Call Me Today"
}
],
"ComparisonOperator": "EQ"
}
}
You can now issue a Query request using the AWS CLI. In this example, the contents of the
key-conditions.json file are used for the --key-conditions parameter:
aws dynamodb query --table-name MusicCollection --key-conditions file://keyconditions.json
For more documentation on using the AWS CLI with DynamoDB, go to http://docs.aws.amazon.com/cli/
latest/reference/dynamodb/index.html.
Here is an example, using the AWS CLI to list the tables in a local database:
aws dynamodb list-tables --endpoint-url http://localhost:8000
If DynamoDB is using a port number other than the default (8000), you will need to modify the
--endpoint-url value accordingly.
Note
At this time, the AWS CLI cannot use the downloadable version of DynamoDB as a default
endpoint; therefore, you will need to specify --endpoint-url with each CLI command.
Amazon DynamoDB and Amazon CloudWatch are integrated, so you can gather and analyze performance
metrics.You can monitor these metrics using the CloudWatch console, the AWS Command Line Interface,
or programmatically using the CloudWatch API. CloudWatch also allows you to set alarms when you
reach a specified threshold for a metric.
For more information about using CloudWatch and alarms, see the CloudWatch Documentation.
Sign in to the AWS Management Console and open the CloudWatch console at https://
console.aws.amazon.com/cloudwatch/.
2.
3.
In the CloudWatch Metrics by Category pane, under DynamoDB Metrics, select Table Metrics,
and then in the upper pane, scroll down to view the full list of metrics for your table.
The available DynamoDB metric options appear in the Viewing list.
To select or deselect an individual metric, in the results pane, select the check box next to the resource
name and metric. Graphs showing the metrics for the selected items are displayed at the bottom of the
console. To learn more about CloudWatch graphs, see the Amazon CloudWatch Developer Guide.
Install the AWS Command Line Interface (AWS CLI). For instructions, see the AWS Command Line
Interface User Guide.
Use the AWS CLI to fetch information. The relevant CloudWatch parameters for DynamoDB are
listed in DynamoDB Metrics (p. 579).
The following example retrieves CloudWatch metrics on PutItem requests that exceeded a table's
provisioned write capacity during a specific time period.
API
CloudWatch also supports a Query API so you can request information programmatically. For more
information, see the CloudWatch Query API documentation and Amazon CloudWatch API Reference.
When a CloudWatch action requires a parameter that is specific to DynamoDB monitoring, such as
MetricName, use the values listed in DynamoDB Metrics (p. 579).
The following example shows a CloudWatch API request, using the following parameters:
Statistics.member.1 = Average
Dimensions.member.1 = Operation=PutItem,TableName=TestTable
Namespace = AWS/DynamoDB
StartTime = 2013-11-14T00:00:00Z
EndTime = 2013-11-16T00:00:00Z
Period = 300
MetricName = SuccessfulRequestLatency
Here is what the CloudWatch request looks like. However, note that this is just to show the form of the
request; you will need to construct your own request based on your metrics and time frame.
http://monitoring.amazonaws.com/
?SignatureVersion=2
&Action=SuccessfulRequestLatency
&Version=2010-08-01
&StartTime=2013-11-14T00:00:00
&EndTime=2013-11-16T00:00:00
&Period=300
&Statistics.member.1=Average
&Dimensions.member.1=Operation=PutItem,TableName=TestTable
&Namespace=AWS/DynamoDB
&MetricName=SuccessfulRequestLatency
&Timestamp=2013-10-15T17%3A48%3A21.746Z
&AWSAccessKeyId=<AWS Access Key ID>
&Signature=<Signature>
DynamoDB Metrics
The following metrics are available from DynamoDB. Note that DynamoDB only sends metrics to
CloudWatch when they have a non-zero value. For example, the UserErrors metric is incremented
whenever a request generates an HTTP 400 error code; if no requests have resulted in a 400 code during
a particular time period, then no metrics for UserErrors are shown.
Note
Not all statistics, such as Average or Sum, are applicable for every metric. However, all of these
values are available through the console, API, and command line client for all services. In the
following table, each metric has a list of Valid Statistics that is applicable to that metric.
Also note that in August 2015, the base period of the following metrics changed from 5 minutes
to 1 minute:
ConditionalCheckFailedRequests
ConsumedReadCapacityUnits
ConsumedWriteCapacityUnits
ReadThrottleEvents
ReturnedItemCount
SuccessfulRequestLatency
SystemErrors
ThrottledRequests
UserErrors
WriteThrottleEvents
Metric
Description
Note
In August 2015, the base period of this metric
changed from 5 minutes to 1 minute.
A failed conditional write will result in an HTTP 400
error (Bad Request). These events are reflected in
the ConditionalCheckFailedRequests metric,
but not in the UserErrors metric.
Units: Count
Dimensions: TableName
Valid Statistics: Minimum, Maximum, Average, Data Samples,
Sum
Metric
Description
ConsumedReadCapacityUnits
The number of read capacity units consumed over the specified time period, so you can track how much of your provisioned throughput is used. You can retrieve the total consumed read capacity for a table and all of its global secondary
indexes, or for a particular global secondary index. For more
information, see Provisioned Throughput in Amazon DynamoDB.
Note
In August 2015, the base period of this metric
changed from 5 minutes to 1 minute.
Use the Sum statistic to calculate the consumed
throughput. For example, get the Sum value over a
span of 1 minute, and divide it by the number of
seconds in a minute (60) to calculate the average
ConsumedReadCapacityUnits per second (recognizing that this average will not highlight any large but
brief spikes in read activity that occurred during that
minute). You can compare the calculated value to
the provisioned throughput value you provide DynamoDB.
Also note that while valid, Minimum and Maximum
will always be 0.5 for eventually consistent reads
and 1 for strongly consistent reads, and Average will
always range from 0.5 to 1.
Units: Count
Dimensions: TableName, GlobalSecondaryIndexName
Valid Statistics: Minimum, Maximum, Average, Sum
Metric
Description
ConsumedWriteCapacityUnits
The number of write capacity units consumed over the specified time period, so you can track how much of your provisioned throughput is used. You can retrieve the total consumed write capacity for a table and all of its global secondary
indexes, or for a particular global secondary index. For more
information, see Provisioned Throughput in Amazon DynamoDB.
Note
In August 2015, the base period of this metric
changed from 5 minutes to 1 minute.
Use the Sum statistic to calculate the consumed
throughput. For example, get the Sum value over a
span of 1 minute, and divide it by the number of
seconds in a minute (60) to calculate the average
ConsumedWriteCapacityUnits per second (recognizing that this average will not highlight any large but
brief spikes in write activity that occurred during that
minute). You can compare the calculated value to
the provisioned throughput value you provide DynamoDB.
Also note that while valid, Minimum, Maximum, and
Average will always be 1.
Units: Count
Dimensions: TableName, GlobalSecondaryIndexName
Valid Statistics: Minimum, Maximum, Average, Sum
OnlineIndexConsumedWriteCapacity
Metric
Description
OnlineIndexPercentageProgress
OnlineIndexThrottleEvents
ProvisionedReadCapacityUnits
Metric
Description
ProvisionedWriteCapacityUnits
ReadThrottleEvents
The number of read events that exceeded the preset provisioned throughput limits in the specified time period.
A single API request can result in multiple events. For example, a BatchGetItem that reads 10 items is processed
as ten GetItem events. For each event, ReadThrottleEvents is incremented by 1 if that event is throttled.
The ThrottledRequests metric for the entire BatchGetItem is not incremented unless all ten of the GetItem
events are throttled.
The TableName dimension returns the ReadThrottleEvents for the table, but not for any global secondary indexes. To view ReadThrottleEvents for a global
secondary index, you must specify both TableName and
GlobalSecondaryIndex.
Note
In August 2015, the base period of this metric
changed from 5 minutes to 1 minute.
Units: Count
Dimensions: TableName, GlobalSecondaryIndexName
Valid Statistics: Sum, Data Samples
ReturnedItemCount
Note
In August 2015, the base period of this metric
changed from 5 minutes to 1 minute.
Units: Count
Dimensions: TableName
Valid Statistics: Minimum, Maximum, Average, Data Samples,
Sum
Metric
Description
SuccessfulRequestLatency
Note
In August 2015, the base period of this metric
changed from 5 minutes to 1 minute.
CloudWatch also provides a Data Samples statistic:
the total number of successful calls for a sample time
period.
Units: Milliseconds (or a count for Data Samples)
Dimensions: TableName, Operation
Valid Statistics: Minimum, Maximum, Average, Data Samples
SystemErrors
Note
In August 2015, the base period of this metric
changed from 5 minutes to 1 minute.
Units: Count
Dimensions: All dimensions
Valid Statistics: Sum, Data Samples
Metric
Description
ThrottledRequests
The number of user requests that exceeded the preset provisioned throughput limits in the specified time period.
ThrottledRequests is incremented by 1 if any event within
a request exceeds a provisioned throughput limit. For example, if you update an item in a table with global secondary
indexes, there are multiple events a write to the table, and
a write to each index. If one or more of these events are
throttled, then ThrottledRequests is incremented by 1.
Important
In a batch request, ThrottledRequests is only
incremented if every request in the batch (such as
BatchGetItem) is throttled. Individual throttle requests
in the batch result in incrementing ReadThrottleEvents (for GetItem events) or
WriteThrottleEvents (for PutItem and DeleteItem events).
To gain insight into which event is throttling a request, compare ThrottledRequests with the ReadThrottleEvents
and WriteThrottleEvents for the table and its indexes.
Note
In August 2015, the base period of this metric
changed from 5 minutes to 1 minute.
A throttled request will result in an HTTP 400 error
(Bad Request). These events are reflected in the
ThrottledRequests metric, but not in the UserErrors metric.
Units: Count
Dimensions: TableName, Operation
Valid Statistics: Sum, Data Samples
Metric
Description
UserErrors
Note
In August 2015, the base period of this metric
changed from 5 minutes to 1 minute.
Units: Count
This is a region account level metric. It represents the aggregate of HTTP 400 errors for DynamoDB requests for all tables
in this region, for this AWS account.
Valid Statistics: Sum, Data Samples
WriteThrottleEvents
The number of write events that exceeded the preset provisioned throughput limits in the specified time period.
A single API request can result in multiple events. For example, a PutItem request on a table with three global secondary indexes would result in four events the table write,
and each of the three index writes. For each event, the
WriteThrottleEvents metric is incremented by 1 if that
event is throttled. For single PutItem requests, if any of the
events are throttled, ThrottledRequests is also incremented by 1. For BatchWriteItem, the ThrottledRequests
metric for the entire BatchWriteItem is not incremented
unless all of the individual PutItem or DeleteItem events
are throttled.
The TableName dimension returns the
WriteThrottleEvents for the table, but not for any global
secondary indexes. To view WriteThrottleEvents for a
global secondary index, you must specify both TableName
and GlobalSecondaryIndex.
Note
In August 2015, the base period of this metric
changed from 5 minutes to 1 minute.
Units: Count
Dimensions: TableName, GlobalSecondaryIndexName
Valid Statistics: Sum, Data Samples
Description
TableName
This dimension limits the data you request to a specific table. This
value can be any table name for the current account.
GlobalSecondaryIndexName This dimension limits the data you request to a global secondary index
on a table. If you specify GlobalSecondaryIndexName, you must
also specify TableName.
Operation
Example Policies for API Actions and Resource Access (p. 592)
Fine-Grained Access Control for DynamoDB (p. 597)
Example Policies for Fine-Grained Access Control (p. 599)
Using Web Identity Federation (p. 605)
Amazon DynamoDB integrates with AWS Identity and Access Management (IAM), a service that enables
you to do the following:
Create users and groups under your AWS account
Easily share your AWS resources between the users in your AWS account
Assign unique security credentials to each user
Here is another example ARN for an index named TitleIndex on the Books table:
"Resource": "arn:aws:dynamodb:us-west-2:123456789012:table/Books/index/TitleIn
dex"
Note
To find your AWS account number, go to the AWS Management Console and click My Account.
Your AWS account number is shown in the upper right portion of the Manage Your Account
page. The account number is formatted using dashes (for example, 1234-5678-9012); however,
if you use it in an ARN, be sure to remove the dashes (for example, 123456789012).
You can use resource-level ARNs in IAM policies for all DynamoDB actions, with the exception of
ListTables. The ListTables action returns the table names owned by the current account making the
request for the current region; it is the only DynamoDB action that does not support resource-level ARN
policies.
DynamoDB Actions
In an IAM policy, you can specify any of the actions in the DynamoDB API. You must prefix each action
name with the lowercase string dynamodb:. Here are some examples:
dynamodb:CreateTable
dynamodb:PutItem
dynamodb:Query
dynamodb:UpdateItem
For a list of API actions, see the Amazon DynamoDB API Reference.
DynamoDB allows customers to purchase Reserved Capacity, as described at http://aws.amazon.com/
dynamodb/pricing. With Reserved Capacity, you pay a one-time upfront fee and commit to paying for a
minimum usage level, at significant savings, over a period of time. The following actions are available for
controlling access to Reserved Capacity management:
dynamodb:PurchaseReservedCapacityOfferings
dynamodb:DescribeReservedCapacityOfferings
dynamodb:DescribeReservedCapacity
The operators that are available depend on the condition type being used. For example, with a String
value, you can specify StringEquals, StringNotEquals, StringEqualsIgnoreCase,
StringNotEqualsIgnoreCase, StringLike, or StringNotLike.
You can optionally specify a set operator in a condition. The following IAM set operators are available:
ForAnyValue Returns true if any one of the key values matches any one of the condition values.
ForAllValues Returns true if there's a match between every one of the specified key values and
at least one condition value.
For more information about IAM condition types and operators, see the Condition section in IAM User
Guide.
AttributesToGet
AttributeUpdates
UpdateItem
Expected
Item
PutItem
ScanFilter
Scan
In addition to product-specific policy keys, DynamoDB supports the following keys that are common to
other AWS services that use AWS Identity and Access Management:
Note
Key names are case sensitive.
For more information about AWS-wide policy keys, see Condition in IAM User Guide.
Allow read-only access on items in the AWS account's tables (p. 593)
Allow put, update, and delete operations on one table (p. 593)
Allow access to a specific table and all of its indexes (p. 593)
Prevent a partner from using API actions that change data (p. 594)
{
"Version": "2012-10-17",
"Statement": [
{
"Effect":"Allow",
"Action":"dynamodb:*",
"Resource":"*"
}
]
}
In this example, we create a policy that gives access to all actions on the table named "Books" and all of
its indexes. To test this policy in your own environment, you will need to replace the example account ID
"123456789012" with your AWS account ID.
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": ["dynamodb:*"],
"Resource": [
"arn:aws:dynamodb:us-west-2:123456789012:table/Books",
"arn:aws:dynamodb:us-west-2:123456789012:table/Books/index/*"
]
}
]
}
Note
This example uses an Allow action and enumerates each of the "read" actions supported by
DynamoDB. An alternative approach could use a Deny action and enumerate each of the "write"
actions. However, the illustrated Allow approach is recommended because new "write" actions
may be added to DynamoDB in the future, which could result in unintended access with the
Deny approach.
testing work might affect the production environment, because, for example, the limits on concurrent
create and delete actions are set at the AWS account level. As a result, each action in the test environment
reduces the number of actions that are available in your production environment. There is also a risk that
the code in your test environment might accidentally access tables in the production environment. To
prevent these issues, you might consider creating separate AWS accounts for the production and testing.
Suppose further that you have two developers, Bob and Alice, who are testing the ProductCatalog table.
Instead of creating a separate AWS account for every developer, your developers can share the same
test account.You might create a copy of the same table for each developer, such as Bob_ProductCatalog
and Alice_ProductCatalog . In this case, you can create IAM users Bob and Alice in the AWS account
that you created for the test environment. You can then allow these users to perform DynamoDB actions
on to the tables that they own. You have the following policy options to grant the user permissions:
Create a separate policy for each user and attach the policy to the users separately. For example, you
can attach the following policy to user Alice to allow her access to all DynamoDB actions on the
Alice_ProductCatalog table.
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": ["dynamodb:*"],
"Resource": "arn:aws:dynamodb:us-west2:123456789012:table/Alice_ProductCatalog"
}
]
}
You would then create a similar policy with a different resource ( Bob_ProductCatalog table) for user
Bob.
To test these policies in your own environment, you will need to replace the example account ID
"123456789012" with your AWS account ID. If you want to test them on the DynamoDB management
console, the console requires permission for additional DynamoDB, CloudWatch, and Amazon Simple
Notification Service actions, as shown in the following policy:
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": ["dynamodb:*"],
"Resource": "arn:aws:dynamodb:us-west2:123456789012:table/Alice_ProductCatalog"
},
{
"Effect": "Allow",
"Action": [
"dynamodb:ListTables",
"dynamodb:DescribeTable",
"cloudwatch:*",
"sns:*"
],
"Resource": "*"
}
]
}
Instead of attaching policies to individual users, you can use IAM policy variables to write a single policy
and attach it a group. You will need to create a group and, for this example, add both users Alice and
user Bob to the group. The following example allows all DynamoDB actions on the
${aws:username}_ProductCatalog table. The policy variable ${aws:username} is replaced by
the requester's user name when the policy is evaluated. For example, if Alice sends a request to add
an item, the action is allowed only if Alice is adding item to the Alice_ProductCatalog table.
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": ["dynamodb:*"],
"Resource": "arn:aws:dynamodb:us-west2:123456789012:table/${aws:username}_ProductCatalog"
},
{
"Effect": "Allow",
"Action": [
"dynamodb:ListTables",
"dynamodb:DescribeTable",
"cloudwatch:*",
"sns:*"
],
"Resource": "*"
}
]
}
Note
When using IAM policy variables, you must explicitly specify version 2012-10-17 in the policy.
The default version of the access policy language, 2008-10-17, does not support policy variables.
Note that, instead of identifying a specific table as a resource, you could use a wild card (*) to grant
permissions on all tables whose name is prefixed with the name of the IAM user who is logged making
the request.
"Resource":"arn:aws:dynamodb:us-west-2:123456789012:table/${aws:username}_*"
"Statement": [
{
"Action": [
"dynamodb:DescribeTable",
"dynamodb:ListTables",
"cloudwatch:DescribeAlarms",
"cloudwatch:ListMetrics"
],
"Effect": "Allow",
"Resource": "*"
}
]
}
An app for targeted advertising that stores data about ad impressions and click tracking. The app can
only write data items for the current user, and can only retrieve targeted ad recommendations for that
user.
An IAM Condition element is the central feature of a fine-grained access control policy. By adding a
Condition to a policy, you can allow or deny access to items and attributes in DynamoDB tables and
indexes, based upon your particular business requirements.
Using fine-grained access control, you can "hide" information in a DynamoDB table in a horizontal fashion
by matching primary key values:
To hide information vertically, you can control which attributes are visible by listing those values in a policy
document:
You can also implement horizontal and vertical information hiding in the same policy.
To show how fine-grained access control works, consider a mobile gaming app. This app lets players
select from and play a variety of different games. The app uses a DynamoDB table named GameScores
to keeps track of high scores and other user data. Each item in the table is uniquely identified by a user
ID and the name of the game that the user played. Users should only have access to game data associated
with their user ID.
Here is the primary key for GameScores:
Table Name
GameScores (UserId,
GameTitle, ...)
Type: String
Type: String
A user that wants to play a game must belong to an IAM role named GameRole, which has a security
policy attached to it. Here is the policy document:
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"dynamodb:GetItem",
"dynamodb:BatchGetItem",
"dynamodb:Query",
"dynamodb:PutItem",
"dynamodb:UpdateItem",
"dynamodb:DeleteItem",
"dynamodb:BatchWriteItem"
],
"Resource": [
"arn:aws:dynamodb:us-west-2:123456789012:table/GameScores"
],
"Condition": {
"ForAllValues:StringEquals": {
"dynamodb:LeadingKeys": ["${www.amazon.com:user_id}"],
"dynamodb:Attributes": [
"UserId","GameTitle","Wins","Losses",
"TopScore","TopScoreDateTime"
]
},
"StringEqualsIfExists": {"dynamodb:Select": "SPECIFIC_ATTRIB
UTES"}
}
}
]
}
The Condition clause implements fine-grained access control, hiding information both horizontally and
vertically:
The dynamodb:LeadingKeys policy key lets a user access items where the hash key value matches
their user identifier. This identifier is provided by the ${www.amazon.com:user_id} substitution
variable. (More information about such substitution variables is presented in Using Web Identity
Federation (p. 605).)
The dynamodb:Attributes policy key allows access to only a subset of attributes in any item. No
other attributes are returned by any of the listed actions. In addition, the StringEqualsIfExists
clause ensures that the app must always provide a list of specific attributes to act upon. It is not possible
to request all attributes.
When an IAM policy is evaluated, the result will always be true (access is allowed) or false (access is
denied). If any part of the Condition element is false, then the entire policy evaluates to false and access
is denied.
Important
If you use dynamodb:Attributes, you must specify the names of all of the primary key and
index key attributes, for the table and any secondary indexes that are listed the policy. Otherwise,
DynamoDB will not be able to use these key attributes to perform the requested action.
The attribute names and leading key names in an IAM policy cannot have any characters other
than TAB, CR, LF, SPACE, and ASCII codes 33 (0x21) through 255 (0xFF). Please refer to the
ASCII table at http://www.asciitable.com.
Many of these policies allow users to access only those items in a table where the hash key value matches
the user identifier. The IAM substitution variables ${www.amazon.com:user_id},
${graph.facebook.com:id}, and ${accounts.google.com:sub} contain user identifiers for Login
with Amazon, Facebook, and Google. To learn how an application logs in to one of these identity providers
and obtains these identifiers, see Using Web Identity Federation (p. 605).
Note
In each of these examples, we set the Effect clause to Allow and specify only the actions,
resources and parameters that will be allowed. Access is permitted only to what is explicitly listed
in the IAM policy.
In some cases, it is possible to rewrite these policies so that they are deny-based that is,
setting the Effect clause to Deny and inverting all of the logic in the policy. However, we
recommend that you avoid using deny-based policies with DynamoDB because they are difficult
to write correctly, compared to allow-based policies. In addition, future changes to the DynamoDB
API (or changes to existing API inputs) can render a deny-based policy ineffective.
Note
When using policy variables, you must explicitly specify version 2012-10-17 in the policy. The
default version of the access policy language, 2008-10-17, does not support policy variables.
If we wanted to implement read-only access, we could remove any actions that could modify the data. In
the following policy, only those actions that provide read-only access are included in the condition.
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"dynamodb:GetItem",
"dynamodb:BatchGetItem",
"dynamodb:Query"
],
"Resource": ["arn:aws:dynamodb:us-west2:123456789012:table/GameScores"],
"Condition": {
"ForAllValues:StringEquals": {"dynamodb:LeadingKeys":
["${www.amazon.com:user_id}"]}
}
}
]
}
We can also filter the data items that are returned, so that the user only sees specific attributes. In the
following policy, only GameTitle and TopScore will be returned.
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"dynamodb:GetItem",
"dynamodb:BatchGetItem",
"dynamodb:Query"
],
"Resource": ["arn:aws:dynamodb:us-west2:123456789012:table/GameScores"],
"Condition": {
"ForAllValues:StringEquals": {
"dynamodb:LeadingKeys": ["${www.amazon.com:user_id}"],
"dynamodb:Attributes": ["GameTitle","TopScore"]
},
"StringEquals": {"dynamodb:Select": "SPECIFIC_ATTRIBUTES"}
}
}
]
}
Important
If you use dynamodb:Attributes, you must specify the names of all of the primary key and
index key attributes, for the table and any secondary indexes that are listed the policy. Otherwise,
DynamoDB will not be able to use these key attributes to perform the requested action.
"Statement": [
{
"Effect": "Allow",
"Action": [
"dynamodb:UpdateItem",
"dynamodb:GetItem",
"dynamodb:Query",
"dynamodb:BatchGetItem",
"dynamodb:Scan"
],
"Resource": ["arn:aws:dynamodb:us-west2:123456789012:table/GameScores"],
"Condition": {
"ForAllValues:StringEquals": {
"dynamodb:Attributes": ["UserId","TopScore"]
},
"StringEqualsIfExists": {
"dynamodb:Select": "SPECIFIC_ATTRIBUTES",
"dynamodb:ReturnValues": [
"NONE",
"UPDATED_OLD",
"UPDATED_NEW"
]
}
}
}
]
}
Note
The policy takes a "whitelist" approach, allowing access to a named set of attributes. It is possible
to write an equivalent policy that disallows access to other attributes instead. This "blacklist"
approach is not recommended, because users could determine the names of these blacklisted
attributes by repeatedly issuing requests for all possible attribute names, eventually finding an
attribute that they are not allowed access to. To avoid this, follow the principle of least privilege
and use a whitelist approach to enumerate all of the allowed values, rather than specifying the
disallowed attribute names.
This policy does not permit PutItem, DeleteItem or BatchWriteItem, because those actions always
replace the entire previous item. This would allow users to delete the previous values for attributes that
they are not allowed to access.
The StringEqualsIfExists clause ensures the following:
If the user specifies the Select parameter, then its value must be SPECIFIC_ATTRIBUTES. This
prevents the API action from returning any non-allowed attributes, such as from an index projection.
If the user specifies the ReturnValues parameter, then its value must be NONE, UPDATED_OLD or
UPDATED_NEW. This is because the UpdateItem action also perform implicit reads, to check whether
an item exists before replacing it, or so that previous attribute values can be returned if requested.
Restricting ReturnValues in this way ensures that users can only read or write the allowed attributes.
The StringEqualsIfExists clause assures that only one of these parameters Select or
ReturnValues can be used per request, in the context of the allowed actions.
Here are some important considerations about the limits of fine-grained access policy controls:
If you are limiting access to certain attributes, you must allow the primary key attribute names. If you
want to allow Query actions on a secondary index, you must also allow the index range key attribute
name.
UpdateItem is actually an "upsert", meaning that if an item does not exist with the specified primary
key, then DynamoDB will put a new item into the table. This implies that users could put new items
without having any of the whitelisted attributes defined. To avoid this, ensure that your applications are
designed to expect upsert behavior, and that they will not be vulnerable to any kinds of exploits from
it.
In this policy, PutItem and DeleteItem are not allowed. These actions always replace the entire item,
which means there is no way to prevent a user from modifying other attributes. Like other write actions,
in DynamoDB, UpdateItem also performs a read, in order to return the values as they appeared either
before or after they were updated. To ensure that other attributes are not seen, the calling application
must set the ReturnValues parameter to NONE, UPDATED_OLD, or UPDATED_NEW. (ALL_OLD and
ALL_NEW are not included in this policy.)
The following policy is similar, but the query must request all of the attributes that have been projected
into the index.
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": ["dynamodb:Query"],
"Resource": ["arn:aws:dynamodb:us-west2:123456789012:table/GameScores/index/TopScoreDateTimeIndex"],
"Condition": {"StringEquals": {"dynamodb:Select": "ALL_PROJECTED_AT
TRIBUTES"}}
}
]
}
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"dynamodb:UpdateItem",
"dynamodb:GetItem",
"dynamodb:Query",
"dynamodb:BatchGetItem"
],
"Resource": [
"arn:aws:dynamodb:us-west-2:123456789012:table/GameScores",
"arn:aws:dynamodb:us-west-2:123456789012:table/GameScores/in
dex/TopScoreDateTimeIndex"
],
"Condition": {
"ForAllValues:StringEquals" : {
"dynamodb:LeadingKeys" : ["${graph.facebook.com:id}"],
"dynamodb:Attributes" : [ "allowed_attribute", "another_al
lowed_attribute" ]
},
"StringEqualsIfExists": {
"dynamodb:Select": "SPECIFIC_ATTRIBUTES",
"dynamodb:ReturnValues": [
"NONE",
"UPDATED_OLD",
"UPDATED_NEW"
]
}
}
}
]
}
In this policy:
The user can only access items where the hash key values match the unique identifier from Facebook.
The identifier is unique for this user and this application.
Write actions can only modify allowed_attribute or another_allowed_attribute. To prevent
other attributes from being modified, PutItem, DeleteItem and BatchWriteItem are omitted from
the list of allowed actions. However, an application can insert new items using UpdateItem, and those
hidden attributes will be null in the new items. If these attributes are projected into
TopScoreDateTimeIndex, the policy has the added benefit of preventing queries that would cause
fetches from the table.
Applications cannot read any attributes other than those listed in dynamodb:Attributes
(allowed_attribute and another_allowed_attribute). An application must now set the Select
parameter to SPECIFIC_ATTRIBUTES in read requests, and only whitelisted attributes can be requested.
For write requests, the application cannot set ReturnValues to ALL_OLD or ALL_NEW and it cannot
perform conditional writes based on any other attributes.
individual IAM users; instead, users can sign in to an identity provider and then obtain temporary security
credentials from AWS Security Token Service (AWS STS). The app can then use these credentials to
access AWS services.
Web identity federation supports the following identity providers:
Login with Amazon
Facebook
Google
GameScores (UserId,
GameTitle, ...)
Type: String
Type: String
Now suppose that a mobile gaming app uses this table, and that app needs to support thousands, or
even millions, of users. At this scale, it becomes very difficult to manage individual app users, and to
guarantee that each user can only access their own data in the GameScores table. Fortunately, many
users already have accounts with a third-party identity provider, such as Facebook, Google, or Login with
Amazon so it makes sense to leverage one of these providers for authentication tasks.
To do this using web identity federation, the app developer must register the app with an identity provider
(such as Login with Amazon) and obtain a unique app ID. Next, the developer needs to create an IAM
role. (For this example, we will give this role a name of GameRole.) The role must have an IAM policy
document attached to it, specifying the conditions under which the app can access GameScores table.
When a user want to play a game, he signs in to his Login with Amazon account from within the gaming
app. The app then calls AWS Security Token Service (AWS STS), providing the Login with Amazon app
ID and requesting membership in GameRole. AWS STS returns temporary AWS credentials to the app
and allows it to access the GameScores table, subject to the GameRole policy document.
The following diagram shows how these pieces fit together.
1. The app calls a third-party identity provider to authenticate the user and the app. The identity provider
returns a web identity token to the app.
2. The app calls AWS STS and passes the web identity token as input. AWS STS authorizes the app
and gives it temporary AWS access credentials.The app is allowed to assume an IAM role (GameRole)
and access AWS resources in accordance with the role's security policy.
3. The app calls DynamoDB to access the GameScores table. Because it has assumed the GameRole,
the app is subject to the security policy associated with that role. The policy document prevents the
app from accessing data that does not belong to the user.
Once again, here is the security policy for GameRole that was shown in Fine-Grained Access Control for
DynamoDB (p. 597):
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"dynamodb:GetItem",
"dynamodb:BatchGetItem",
"dynamodb:Query",
"dynamodb:PutItem",
"dynamodb:UpdateItem",
"dynamodb:DeleteItem",
"dynamodb:BatchWriteItem"
],
"Resource": [
"arn:aws:dynamodb:us-west-2:123456789012:table/GameScores"
],
"Condition": {
"ForAllValues:StringEquals": {
"dynamodb:LeadingKeys": ["${www.amazon.com:user_id}"],
"dynamodb:Attributes": [
"UserId","GameTitle","Wins","Losses",
"TopScore","TopScoreDateTime"
]
},
"StringEqualsIfExists": {"dynamodb:Select": "SPECIFIC_ATTRIB
UTES"}
}
}
]
}
The Condition clause determines which items in GameScores are visible to the app. It does this by
comparing the Login with Amazon ID to the UserId hash key values in GameScores. Only the items
belonging to the current user can be processed using one of DynamoDB actions that are listed in this
policy; other items in the table cannot be accessed. Furthermore, only the specific attributes listed in the
policy can be accessed.
Note
As an alternative to AWS Security Token Service, you can use Amazon Cognito. Amazon Cognito
is now the preferred service for managing temporary credentials for mobile apps. For more
information, go to the following pages:
How to Authenticate Users (AWS SDK for iOS)
How to Authenticate Users (AWS SDK for Android)
Sign in to the AWS Management Console and open the DynamoDB console at https://
console.aws.amazon.com/dynamodb/.
In the Tables pane, click the table you want to create the policy for, and then click Access Control.
The Table Access Permissions wizard opens.
3.
In the Set Permissions pane, choose the identity provider, actions, and attributes for the policy.
4.
You can now go to the IAM console to create a new IAM role. For step-by-step instructions, see Creating
a Role for Web Identity Federation section in IAM User Guide. You will need to specify the third-party
identity provider you want to use, along with the app ID that you obtained from that provider. When you
are asked to set permissions for the role, choose Custom Policy and paste your DynamoDB policy in
the Policy Document field.
After the identity provider authenticates the user, the provider returns a web identity token to your app.
The format of this token depends on the provider, but is typically a very long string of characters.
2. Obtain temporary AWS security credentials. To do this, your app sends a
AssumeRoleWithWebIdentity request to AWS Security Token Service (AWS STS). This request
contains:
The web identity token from the previous step
The app ID from the identity provider
The Amazon Resource Name (ARN) of the IAM role that you created for this identity provider for
this app
AWS STS returns a set of AWS security credentials that expire after a certain amount of time (3600
seconds, by default).
The following is a sample request and response from a AssumeRoleWithWebIdentity action in
AWS STS. The web identity token was obtained from the Login with Amazon identity provider.
GET / HTTP/1.1
Host: sts.amazonaws.com
Content-Type: application/json; charset=utf-8
URL: https://sts.amazonaws.com/?ProviderId=www.amazon.com
&DurationSeconds=900&Action=AssumeRoleWithWebIdentity
&Version=2011-06-15&RoleSessionName=web-identity-federation
&RoleArn=arn:aws:iam::123456789012:role/GameRole
&WebIdentityToken=Atza|IQEBLjAsAhQluyKqyBiYZ8-kclvGTYM81e...(remaining char
acters omitted)
<AssumeRoleWithWebIdentityResponse
xmlns="https://sts.amazonaws.com/doc/2011-06-15/">
<AssumeRoleWithWebIdentityResult>
<SubjectFromWebIdentityToken>amzn1.ac
count.AGJZDKHJKAUUSW6C44CHPEXAMPLE</SubjectFromWebIdentityToken>
<Credentials>
<SessionToken>AQoDYXdzEMf//////////wEa8AP6nNDwcSLnf+cHupC...(remaining
characters omitted)</SessionToken>
<SecretAccessKey>8Jhi60+EWUUbbUShTEsjTxqQtM8UKvsM6XAjdA==</SecretAccess
Key>
<Expiration>2013-10-01T22:14:35Z</Expiration>
<AccessKeyId>06198791C436IEXAMPLE</AccessKeyId>
</Credentials>
<AssumedRoleUser>
<Arn>arn:aws:sts::123456789012:assumed-role/GameRole/web-identity-fed
eration</Arn>
<AssumedRoleId>AROAJU4SA2VW5SZRF2YMG:web-identity-federation</Assumed
RoleId>
</AssumedRoleUser>
</AssumeRoleWithWebIdentityResult>
<ResponseMetadata>
<RequestId>c265ac8e-2ae4-11e3-8775-6969323a932d</RequestId>
</ResponseMetadata>
</AssumeRoleWithWebIdentityResponse>
3. Access AWS resources. The response from AWS STS contains information that your app will require
in order to access DynamoDB resources:
The AccessKeyID, SecretAccessKey and SessionToken fields contain security credentials that
are valid for this user and this app only.
API Version 2012-08-10
610
The Expiration field signifies the time limit for these credentials, after which they will no longer
be valid.
The AssumedRoleId field contains the name of a session-specific IAM role that has been assumed
by the app. The app will honor the access controls in the IAM policy document for the duration of
this session.
The SubjectFromWebIdentityToken field contains the unique ID that appears in an IAM policy
variable for this particular identity provider. The following are the IAM policy variables for supported
providers, and some example values for them:
Policy Variable
Example Value
${www.amazon.com:user_id} amzn1.account.AGJZDKHJKAUUSW6C44CHPEXAMPLE
${graph.facebook.com:id}
123456789
${ac123456789012345678901
counts.google.com:sub}
For example IAM policies where these policy variables are used, see Example Policies for Fine-Grained
Access Control (p. 599).
For more information about how AWS Security Token Service generates temporary access credentials,
go to Creating Auth Tokens in Using Temporary Security Credentials.
DescribeReservedCapacityOfferings
PurchaseReservedCapacityOfferings
Every log entry contains information about who generated the request. The user identity information in
the log helps you determine whether the request was made with root or IAM user credentials, with
temporary security credentials for a role or federated user, or by another AWS service. For more
information, see the userIdentity field in the CloudTrail Event Reference.
You can store your log files in your bucket for as long as you want, but you can also define Amazon S3
lifecycle rules to archive or delete log files automatically. By default, your log files are encrypted by using
Amazon S3 server-side encryption (SSE).
You can choose to have CloudTrail publish Amazon SNS notifications when new log files are delivered
if you want to take quick action upon log file delivery. For more information, see Configuring Amazon
SNS Notifications.
You can also aggregate DynamoDB log files from multiple AWS regions and multiple AWS accounts into
a single Amazon S3 bucket. For more information, see Aggregating CloudTrail Log Files to a Single
Amazon S3 Bucket.
{"Records": [
{
"eventVersion": "1.03",
"userIdentity": {
"type": "AssumedRole",
"principalId": "AKIAIOSFODNN7EXAMPLE:bob",
"arn": "arn:aws:sts::111122223333:assumed-role/users/bob",
"accountId": "111122223333",
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"sessionContext": {
"attributes": {
"mfaAuthenticated": "false",
"creationDate": "2015-05-28T18:06:01Z"
},
"sessionIssuer": {
"type": "Role",
"principalId": "AKIAI44QH8DHBEXAMPLE",
"arn": "arn:aws:iam::444455556666:role/admin-role",
"accountId": "444455556666",
"userName": "bob"
}
}
},
"eventTime": "2015-05-01T07:24:55Z",
"eventSource": "dynamodb.amazonaws.com",
"eventName": "CreateTable",
"awsRegion": "us-west-2",
"sourceIPAddress": "192.0.2.0",
"userAgent": "console.aws.amazon.com",
"requestParameters": {
"provisionedThroughput": {
"writeCapacityUnits": 10,
"readCapacityUnits": 10
},
"tableName": "Music",
"keySchema": [
{
"attributeName": "Artist",
"keyType": "HASH"
},
{
"attributeName": "SongTitle",
"keyType": "RANGE"
}
],
"attributeDefinitions": [
{
"attributeType": "S",
"attributeName": "Artist"
},
{
"attributeType": "S",
"attributeName": "SongTitle"
}
]
},
"responseElements": {"tableDescription": {
"tableName": "Music",
"attributeDefinitions": [
{
"attributeType": "S",
"attributeName": "Artist"
},
{
"attributeType": "S",
"attributeName": "SongTitle"
}
],
"itemCount": 0,
"provisionedThroughput": {
"writeCapacityUnits": 10,
"numberOfDecreasesToday": 0,
"readCapacityUnits": 10
},
"creationDateTime": "May 1, 2015 7:24:55 AM",
"keySchema": [
{
"attributeName": "Artist",
"keyType": "HASH"
},
{
"attributeName": "SongTitle",
"keyType": "RANGE"
}
],
"tableStatus": "CREATING",
"tableSizeBytes": 0
}},
"requestID": "KAVGJR1Q0I5VHF8FS8V809EV7FVV4KQNSO5AEMVJF66Q9ASUAAJG",
"eventID": "a8b5f864-480b-43bf-bc22-9b6d77910a29",
"eventType": "AwsApiCall",
"apiVersion": "2012-08-10",
"recipientAccountId": "111122223333"
},
{
"eventVersion": "1.03",
"userIdentity": {
"type": "AssumedRole",
"principalId": "AKIAIOSFODNN7EXAMPLE:bob",
"arn": "arn:aws:sts::111122223333:assumed-role/users/bob",
"accountId": "444455556666",
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"sessionContext": {
"attributes": {
"mfaAuthenticated": "false",
"creationDate": "2015-05-28T18:06:01Z"
},
"sessionIssuer": {
"type": "Role",
"principalId": "AKIAI44QH8DHBEXAMPLE",
"arn": "arn:aws:iam::444455556666:role/admin-role",
"accountId": "444455556666",
"userName": "bob"
}
}
},
"eventTime": "2015-05-04T02:43:11Z",
"eventSource": "dynamodb.amazonaws.com",
"eventName": "DescribeTable",
"awsRegion": "us-west-2",
"sourceIPAddress": "192.0.2.0",
"userAgent": "console.aws.amazon.com",
"requestParameters": {"tableName": "Music"},
"responseElements": null,
"requestID": "DISTSH6DQRLCC74L48Q51LRBHFVV4KQNSO5AEMVJF66Q9ASUAAJG",
"eventID": "c07befa7-f402-4770-8c1b-1911601ed2af",
"eventType": "AwsApiCall",
"apiVersion": "2012-08-10",
"recipientAccountId": "111122223333"
},
{
"eventVersion": "1.03",
"userIdentity": {
"type": "AssumedRole",
"principalId": "AKIAIOSFODNN7EXAMPLE:bob",
"arn": "arn:aws:sts::111122223333:assumed-role/users/bob",
"accountId": "111122223333",
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"sessionContext": {
"attributes": {
"mfaAuthenticated": "false",
"creationDate": "2015-05-28T18:06:01Z"
},
"sessionIssuer": {
"type": "Role",
"principalId": "AKIAI44QH8DHBEXAMPLE",
"arn": "arn:aws:iam::444455556666:role/admin-role",
"accountId": "444455556666",
"userName": "bob"
}
}
},
"eventTime": "2015-05-04T02:14:52Z",
"eventSource": "dynamodb.amazonaws.com",
"eventName": "UpdateTable",
"awsRegion": "us-west-2",
"sourceIPAddress": "192.0.2.0",
"userAgent": "console.aws.amazon.com",
"requestParameters": {"provisionedThroughput": {
"writeCapacityUnits": 25,
"readCapacityUnits": 25
}},
"responseElements": {"tableDescription": {
"tableName": "Music",
"attributeDefinitions": [
{
"attributeType": "S",
"attributeName": "Artist"
},
{
"attributeType": "S",
"attributeName": "SongTitle"
}
],
"itemCount": 0,
"provisionedThroughput": {
"writeCapacityUnits": 10,
"numberOfDecreasesToday": 0,
"readCapacityUnits": 10,
"lastIncreaseDateTime": "May 3, 2015 11:34:14 PM"
},
"creationDateTime": "May 3, 2015 11:34:14 PM",
"keySchema": [
{
"attributeName": "Artist",
"keyType": "HASH"
},
{
"attributeName": "SongTitle",
"keyType": "RANGE"
}
],
"tableStatus": "UPDATING",
"tableSizeBytes": 0
}},
"requestID": "AALNP0J2L244N5O15PKISJ1KUFVV4KQNSO5AEMVJF66Q9ASUAAJG",
"eventID": "eb834e01-f168-435f-92c0-c36278378b6e",
"eventType": "AwsApiCall",
"apiVersion": "2012-08-10",
"recipientAccountId": "111122223333"
},
{
"eventVersion": "1.03",
"userIdentity": {
"type": "AssumedRole",
"principalId": "AKIAIOSFODNN7EXAMPLE:bob",
"arn": "arn:aws:sts::111122223333:assumed-role/users/bob",
"accountId": "111122223333",
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"sessionContext": {
"attributes": {
"mfaAuthenticated": "false",
"creationDate": "2015-05-28T18:06:01Z"
},
"sessionIssuer": {
"type": "Role",
"principalId": "AKIAI44QH8DHBEXAMPLE",
"arn": "arn:aws:iam::444455556666:role/admin-role",
"accountId": "444455556666",
"userName": "bob"
}
}
},
"eventTime": "2015-05-04T02:42:20Z",
"eventSource": "dynamodb.amazonaws.com",
"eventName": "ListTables",
"awsRegion": "us-west-2",
"sourceIPAddress": "192.0.2.0",
"userAgent": "console.aws.amazon.com",
"requestParameters": null,
"responseElements": null,
"requestID": "3BGHST5OVHLMTPUMAUTA1RF4M3VV4KQNSO5AEMVJF66Q9ASUAAJG",
"eventID": "bd5bf4b0-b8a5-4bec-9edf-83605bd5e54e",
"eventType": "AwsApiCall",
"apiVersion": "2012-08-10",
"recipientAccountId": "111122223333"
},
{
"eventVersion": "1.03",
"userIdentity": {
"type": "AssumedRole",
"principalId": "AKIAIOSFODNN7EXAMPLE:bob",
"arn": "arn:aws:sts::111122223333:assumed-role/users/bob",
"accountId": "111122223333",
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"sessionContext": {
"attributes": {
"mfaAuthenticated": "false",
"creationDate": "2015-05-28T18:06:01Z"
},
"sessionIssuer": {
"type": "Role",
"principalId": "AKIAI44QH8DHBEXAMPLE",
Tip
The DynamoDB console provides a point-and-click interface for exporting data to Amazon S3,
and for importing data from Amazon S3 to DynamoDB. Using the console is the easiest way to
leverage AWS Data Pipeline for exporting and importing DynamoDB data. For more information,
see Using the AWS Management Console to Export and Import Data (p. 618).
To export a table, you use the console to create a new AWS Data Pipeline. The pipeline, in turn, launches
an Amazon EMR cluster to perform the actual export. The Amazon EMR cluster reads the data from a
table in DynamoDB, and writes the data to an export file in an Amazon S3 bucket.
The process is similar for an import, except that the data is read from the Amazon S3 bucket and written
to the DynamoDB table.
Important
When you export or import DynamoDB data, you will incur additional costs for the underlying
AWS services that are used:
AWS Data Pipeline manages the import/export workflow for you.
Amazon S3 contains the data that you export from DynamoDB, or import into DynamoDB.
Amazon Elastic MapReduce (Amazon EMR) runs a managed Hadoop cluster to performs
reads and writes between DynamoDB to Amazon S3. The cluster configuration is one
m1.medium instance master node and one m1.medium instance core node.
For more information see AWS Data Pipeline Pricing, Amazon EMR Pricing, and Amazon S3
Pricing.
Important
The IAM user that performs the exports and imports must have an active AWS Access Key Id
and Secret Key. For more information, go to Administering Access Keys for IAM Users in IAM
User Guide.
Note
If you have previously used the AWS Data Pipeline console to create a pipeline, then
DataPipelineDefaultRole and DataPipelineDefaultResourceRole were created for you at that
time. No further action is required; you can skip this section and begin creating pipelines using
the DynamoDB console. For more information, see Exporting Data From DynamoDB to Amazon
S3 (p. 624) and Importing Data From Amazon S3 to DynamoDB (p. 625).
Sign in to the AWS Management Console and open the IAM console at https://
console.aws.amazon.com/iam/.
2.
3.
In the Role Name field, type DataPipelineDefaultRole and then click Next Step.
b.
In the Select Role Type panel, in the list of AWS Service Roles, go to AWS Data Pipeline and
click Select.
In the Attach Policy panel, click the box next to the AWSDataPipelineRole policy, and then
click Next Step.
In the Review panel, click Create Role.
c.
d.
4.
In the Role Name field, type DataPipelineDefaultResourceRole and then click Next Step.
b.
In the Select Role Type panel, in the list of AWS Service Roles, go to Amazon EC2 Role for
Data Pipeline and click Select.
In the Attach Policy panel, click the box next to the AmazonEC2RoleforDataPipelineRole
policy, and then click Next Step.
In the Review panel, click Create Role.
c.
d.
Now that you have created these roles, you can begin creating pipelines using the DynamoDB console.
For more information, see Exporting Data From DynamoDB to Amazon S3 (p. 624) and Importing Data
From Amazon S3 to DynamoDB (p. 625).
Granting IAM Users and Groups Permission to Perform Export and Import
Tasks
If you are a DynamoDB administrator and you want to allow other IAM users or groups to export and
import your DynamoDB table data, you can create an IAM policy and attach it to the users or groups that
you designate. The policy contains only the necessary permissions for performing these tasks.
Sign in to the AWS Management Console and open the IAM console at https://
console.aws.amazon.com/iam/.
2.
3.
From the IAM Console Dashboard, click Users and select the user you want to modify.
In the Permissions panel, click Attach Policy.
4.
Note
You can use a similar procedure to attach this managed policy to a group, rather than to a user.
Sign in to the AWS Management Console and open the IAM console at https://
console.aws.amazon.com/iam/.
From the IAM Console Dashboard, click Policies and then click Create Policy.
In the Create Policy panel, go to Copy an AWS Managed Policy and click Select.
In the Copy an AWS Managed Policy panel, go to
AmazonDynamoDBFullAccesswithDataPipeline and click Select.
In the Review Policy panel, do the following:
a.
b.
Review the autogenerated Policy Name and Description. If you want, you can modify these
values.
In the Policy Document text box, edit the policy to restrict access to specific tables. By default,
the policy permits all DynamoDB API actions on all of your tables:
{
"Version": "2012-10-17",
"Statement": [
{
"Action": [
"cloudwatch:DeleteAlarms",
"cloudwatch:DescribeAlarmHistory",
"cloudwatch:DescribeAlarms",
"cloudwatch:DescribeAlarmsForMetric",
"cloudwatch:GetMetricStatistics",
"cloudwatch:ListMetrics",
"cloudwatch:PutMetricAlarm",
"dynamodb:*",
"sns:CreateTopic",
"sns:DeleteTopic",
"sns:ListSubscriptions",
"sns:ListSubscriptionsByTopic",
"sns:ListTopics",
"sns:Subscribe",
"sns:Unsubscribe"
],
"Effect": "Allow",
"Resource": "*",
"Sid": "DDBConsole"
},
"dynamodb:*",
Next, construct a new Action that allows access to only the Forum, Thread and Reply tables:
{
"Action": [
"dynamodb:*"
],
"Effect": "Allow",
"Resource": [
"arn:aws:dynamodb:us-west-2:123456789012:table/Forum",
"arn:aws:dynamodb:us-west-2:123456789012:table/Thread",
"arn:aws:dynamodb:us-west-2:123456789012:table/Reply"
]
},
Note
Replace us-west-2 with the region in which your DynamoDB tables reside. Replace
123456789012 with your AWS account number. For more information, see Amazon
Resource Names (ARNs) for DynamoDB (p. 589).
Finally, add the new Action to the policy document:
{
"Version": "2012-10-17",
"Statement": [
{
"Action": [
"dynamodb:*"
],
"Effect": "Allow",
"Resource": [
"arn:aws:dynamodb:us-west-2:123456789012:table/Forum",
"arn:aws:dynamodb:us-west-2:123456789012:table/Thread",
"arn:aws:dynamodb:us-west-2:123456789012:table/Reply"
]
},
{
"Action": [
"cloudwatch:DeleteAlarms",
"cloudwatch:DescribeAlarmHistory",
"cloudwatch:DescribeAlarms",
"cloudwatch:DescribeAlarmsForMetric",
"cloudwatch:GetMetricStatistics",
"cloudwatch:ListMetrics",
"cloudwatch:PutMetricAlarm",
"sns:CreateTopic",
When the policy settings are as you want them, click Create Policy.
Now that you have created the policy, you can attach it to an IAM user.
From the IAM Console Dashboard, click Users and select the user you want to modify.
In the Permissions panel, click Attach Policy.
In the Attach Policy panel, select the name of your policy and click Attach Policy.
Note
You can use a similar procedure to attach your policy to a group, rather than to a user.
Important
If you have never used AWS Data Pipeline before, you will need to set up two IAM roles before
following this procedure. For more information, see Creating IAM Roles for AWS Data
Pipeline (p. 620).
Sign in to the AWS Management Console and open the DynamoDB console at https://
console.aws.amazon.com/dynamodb/.
2.
3.
4.
a.
In the S3 Output Folder text box, enter an Amazon S3 URI where the export file will be written.
For example: s3://mybucket/exports
The format of this URI is s3://bucketname/folder where:
bucketname is the name of your Amazon S3 bucket.
folder is the name of a folder within that bucket. If the folder does not exist, it will be created
automatically. If you do not specify a name for the folder, a name will be assigned for it in the
form s3://bucketname/region/tablename.
b.
c.
d.
e.
f.
In the S3 Log Folder text box, enter an Amazon S3 URI where the log file for the export will be
written. For example: s3://mybucket/logs/
The URI format for S3 Log Folder is the same as for S3 Output Folder. The URI must resolve
to a folder; log files cannot be written to the top level of the S3 bucket.
In the Throughput Rate text box, choose a percentage from the drop-down list. This percentage
will be used during the export process to regulate the amount of provisioned read throughput
consumed. For example, suppose you are exporting a source table that has a
ReadCapacityUnits setting of 20, and you set the throughput rate percentage to 40%. The
export job will consume no more than 8 read capacity units per second from your table's
provisioned read throughput.
If you are exporting multiple tables, the Throughput Rate will be applied to each of the tables
during the export process.
In the Execution Timeout text box, enter the number of hours after which the export job will
time out. If the job has not completed within this period, it will fail.
In the Send notifications to text box, enter your email address. After the pipeline is created,
you will receive an email message inviting you to subscribe to a topic in Amazon Simple
Notification Service (Amazon SNS); if you accept this invite, you will receive periodic notifications
via email as the export progresses.
In the Schedule section, choose one of the following:
One-time Export the export will begin immediately after the pipeline is created.
Daily Export the export will begin at the time of day you specify, and will be repeated every
day at that time.
g.
h.
When the settings are as you want them, click Create Export Pipeline.
Your pipeline will now be created; this process can take several minutes to complete. To view the current
status, see Managing Export and Import Pipelines (p. 627).
If you chose a one-time export, the export job will begin immediately after the pipeline has been created.
If you chose a daily export, the job will begin at the time you have selected, and will repeat at that time
each day.
When the export has finished, you can go to the Amazon S3 console to view your export file. The file will
be in a folder with the same name as your table, and the file will be named using the following format:
YYYY-MM-DD_HH.MM. The internal format of this file is described at Verify Data Export File in the AWS
Data Pipeline Developer Guide.
We will use the term source table for the original table from which the data was exported, and destination
table for the table that will receive the imported data. You can import data from an export file in Amazon
S3, provided that all of the following are true:
The destination table already exists. (The import process will not create the table for you.)
The destination table has the same name as the source table.
The destination table has the same key schema as the source table.
The destination table does not have to be empty. However, the import process will replace any data items
in the table that have the same keys as the items in the export file. For example, suppose you have a
Customer table with a key of CustomerId, and that there are only three items in the table (CustomerId 1,
2, and 3). If your export file also contains data items for CustomerID 1, 2, and 3, the items in the destination
table will be replaced with those from the export file. If the export file also contains a data item for
CustomerId 4, then that item will be added to the table.
The destination table can be in a different AWS region. For example, suppose you have a Customer table
in the US West (Oregon) region and export its data to Amazon S3. You could then import that data into
an identical Customer table in the EU (Ireland) region. This is referred to as a cross-region export and
import. For a list of AWS regions, go to Regions and Endpoints in the AWS General Reference.
Note that the AWS Management Console lets you export multiple source tables at once. However, you
can only import one table at a time.
Important
If you have never used AWS Data Pipeline before, you will need to set up two AWS Identity and
Access Management roles before following this procedure. For more information, see Creating
IAM Roles for AWS Data Pipeline (p. 620).
3.
4.
5.
Sign in to the AWS Management Console and open the DynamoDB console at https://
console.aws.amazon.com/dynamodb/.
(Optional) If you want to perform a cross region import, click Select a Region in the upper right
corner of the console and click the destination region. The console will display all of the DynamoDB
tables in that region. If the destination table does not already exist, you can create it using the console.
On the Amazon DynamoDB Tables page, click Export/Import.
On the Export/Import page, select the destination table for your data, and then click Import into
DynamoDB.
On the Create Import Table Data Pipeline page, do the following:
a.
In the S3 Input Folder text box, enter an Amazon S3 URI where the export file can be found.
For example: s3://mybucket/exports
The format of this URI is s3://bucketname/folder where:
bucketname is the name of your Amazon S3 bucket.
folder is the name of the folder that contains the export file.
The import job will expect to find a file at the specified Amazon S3 location. The internal format
of the file is described at Verify Data Export File in the AWS Data Pipeline Developer Guide.
b.
In the S3 Log Folder text box, enter an Amazon S3 URI where the log file for the import will be
written. For example: s3://mybucket/logs/
The URI format for S3 Log Folder is the same as for S3 Input Folder. The URI must resolve
to a folder; log files cannot be written to the top level of the S3 bucket.
c.
In the Throughput Ratio text box, choose a percentage from the drop-down list. This percentage
will be used during the import process to regulate the amount of provisioned write throughput
consumed. For example, suppose you are importing data into a table that has a
WriteCapacityUnits setting of 10, and you set the throughput ratio percentage to 60%. The
import job will consume no more than 6 write capacity units per second from your table's
provisioned write throughput.
d.
In the Execution Timeout text box, enter the number of hours after which the import job will
time out. If the job has not completed within this period, it will fail.
e.
In the Send notifications to text box, enter your email address. After the pipeline is created,
you will receive an email message inviting you to subscribe to a topic in Amazon Simple
Notification Service (Amazon SNS); if you accept this invite, you will receive periodic notifications
via email as the import proceeds.
In the Associate pipeline with a role section, in Data Pipeline Role, select
DataPipelineDefaultRole.
In the Associate pipeline compute resources with a role section, in Resource Role, select
DataPipelineDefaultResourceRole
f.
g.
When the settings are as you want them, click Create Export Pipeline.
Your pipeline will now be created; this process can take several minutes to complete. To view the current
status, see Managing Export and Import Pipelines (p. 627).
The import job will begin immediately after the pipeline has been created.
Note
This page displays only the export and import pipelines that you have created in the DynamoDB
console. If you have created other pipelines using the AWS Data Pipeline, those pipelines will
not be shown here.
To view all of your pipelines, including those that are not used for DynamoDB export, and imports,
go to the AWS Data Pipeline console.
Each pipeline has a Pipeline Status field; the status changes in response to events within that pipeline.
To get more details about a pipeline, click its name:
This page provides a summary of the pipeline's events and its current status.
If you need more information, go to the lower right corner and click Data Pipeline Console. This will open
the AWS Data Pipeline console, where you can review the pipeline and all of its tasks in detail.
API Version 2012-08-10
628
Sign in to the AWS Management Console and open the DynamoDB console at https://
console.aws.amazon.com/dynamodb/.
2.
3.
4.
5.
On the Data Pipeline Detail page, go to the lower right corner and click Data Pipeline Console.
In the AWS Data Pipeline console, look for a task that has a status of RUNNING. (This will most
likely be a task of type EmrActivity; however, you can cancel any task in the pipeline using the
console.).
In the Actions drop-down list, click Cancel.
6.
Note
Even if you cancel a task, the pipeline itself will remain intact. If the pipeline is for a daily export,
the job will restart the next day at its scheduled time.
Deleting a Pipeline
If you create an export or import pipeline, it remains available until you delete it.You can delete a pipeline
at any time using the DynamoDB console. In addition, if you delete a table using the console, you can
also delete all of the table's pipelines at that time.
Note that if an import or export job is still running, the job will be cancelled first before its pipeline is deleted.
Sign in to the AWS Management Console and open the DynamoDB console at https://
console.aws.amazon.com/dynamodb/.
On the Amazon DynamoDB Tables page, click Export/Import.
On the Export/Import page, go to the pipeline and click its name.
On the Data Pipeline Detail page, go to the lower right corner and click Delete This Pipeline.
5.
Note
Each DynamoDB table can have a maximum of three pipelines associated with it:
1. A one-time export pipeline.
2. A daily export pipeline.
3. A one-time import pipeline.
If you want to perform a one-time export or import, you must first delete any existing pipeline of
that type for the table, and then re-create the pipeline. Similarly, if you currently have a daily
export pipeline but want to perform the tasks at a different time, you will need to delete and then
re-create the existing pipeline.
After you delete a table's pipeline, you can create a new one of the same type. See Exporting
Data From DynamoDB to Amazon S3 (p. 624) and Importing Data From Amazon S3 to
DynamoDB (p. 625) for instructions on how to create new pipelines.
If you delete a table using the DynamoDB console, you can also delete all of the pipelines associated
with that table.
Sign in to the AWS Management Console and open the DynamoDB console at https://
console.aws.amazon.com/dynamodb/.
2.
3.
4.
In the Delete Table confirmation window, select Delete all export/import pipelines for this table
and then click Delete.
Troubleshooting
This section covers some basic failure modes and troubleshooting for DynamoDB exports.
If an error occurs during an export or import, the pipeline status in the DynamoDB console will display as
FAILED. If this happens, click the name of the failed pipeline to go to the Data Pipeline Detail page. On
that page, take note of any errors that you see.
Next, go to the lower right corner and click Data Pipeline Console. This will show details about all of the
steps in the pipeline, and the status of each one.
DynamoDBDataNode represents the DynamoDB table to be exported.
S3DataNode represents the Amazon S3 bucket where the export file is to be written.
EmrCluster represents the provisioning process for the Amazon EMR cluster that will perform the
export.
EmrActivity represents the Amazon EMR cluster running the export job.
In the AWS Data Pipeline console, click each of these steps and take note of any errors. In particular,
examine the execution stack traces and look for errors there.
Finally, go to your Amazon S3 bucket and look for any export or import log files that were written there.
The following are some common issues that may cause a pipeline to fail, along with corrective actions.
To diagnose your pipeline, compare the errors you have seen with the issues noted below.
For an import, ensure that the destination table already exists, and the destination table has the same
key schema as the source table. These conditions must be met, or the import will fail.
Ensure that the Amazon S3 bucket you specified has been created, and that you have read and write
permissions on it.
The pipeline might have exceeded its execution timeout. (You set this parameter when you created
the pipeline.) For example, you might have set the execution timeout for 1 hour, but the export job might
have required more time than this. Try deleting and then re-creating the pipeline, but with a longer
execution timeout interval this time.
You might not have the correct permissions for performing an export or import. For more information,
see Prerequisites to Export and Import Data (p. 620).
You might have reached a resource limit in your AWS account, such as the maximum number of
Amazon EC2 instances or the maximum number of AWS Data Pipeline pipelines. For more information,
including how to request increases in these limits, see AWS Service Limits in the AWS General
Reference.
API Version 2012-08-10
630
Tip
For more details on troubleshooting a pipeline, go to Troubleshooting in the AWS Data Pipeline
Developer Guide.
To perform each of the tasks above, you'll launch an Amazon EMR job flow, specify the location of the
data in DynamoDB, and issue Hive commands to manipulate the data in DynamoDB.
Amazon EMR runs Apache Hadoop on Amazon EC2 instances. Hadoop is an application that implements
the map-reduce algorithm, in which a computational task is mapped to multiple computers that work in
parallel to process a task. The output of these computers is reduced together onto a single computer to
produce the final result. Using Amazon EMR you can quickly and efficiently process large amounts of
data, such as data stored in DynamoDB. For more information about Amazon EMR, go to the Amazon
Elastic MapReduce Developer Guide.
Apache Hive is a software layer that you can use to query map reduce job flows using a simplified,
SQL-like query language called HiveQL. It runs on top of the Hadoop architecture. For more information
about Hive and HiveQL, go to the HiveQL Language Manual.
There are several ways to launch an Amazon EMR job flow: you can use the AWS Management Console
Amazon EMR tab, the Amazon EMR command-line interface (CLI), or you can program your job flow
using the AWS SDK or the API. You can also choose whether to run a Hive job flow interactively or from
a script. In this document, we will show you how to launch an interactive Hive job flow from the console
and the CLI.
Using Hive interactively is a great way to test query performance and tune your application. Once you
have established a set of Hive commands that will run on a regular basis, consider creating a Hive script
that Amazon EMR can run for you. For more information about how to run Hive from a script, go to How
to Create a Job Flow Using Hive.
Warning
Amazon EMR read and write operations on a DynamoDB table count against your established
provisioned throughput, potentially increasing the frequency of provisioned throughput exceptions.
For large requests, Amazon EMR implements retries with exponential backoff to manage the
request load on the DynamoDB table. Running Amazon EMR jobs concurrently with other traffic
may cause you to exceed the allocated provisioned throughput level. You can monitor this by
checking the ThrottleRequests metric in CloudWatch. If the request load is too high, you can
relaunch the job flow and set Read Percent Setting (p. 651) and Write Percent Setting (p. 651) to
lower values to throttle the Amazon EMR read and write operations. For information about
DynamoDB throughput settings, see Specifying Read and Write Requirements for Tables (p. 62).
Note
The integration of DynamoDB with Amazon EMR does not currently support Binary and Binary
Set type attributes.
Sign in to the AWS Management Console and open the Amazon EC2 console at https://
console.aws.amazon.com/ec2/.
In the upper right hand corner of the console, select a Region from the Region drop-down menu.
This should be the same region that your DynamoDB database is in.
3.
4.
The console displays a list of key pairs associated with your account.
Click Create Key Pair.
5.
6.
Enter a name for the key pair, such as mykeypair, for the new key pair in the Key Pair Name field
and click Create.
Download the private key file. The file name will end with .pem, (such as mykeypair.pem). Keep
this private key file in a safe place. You will need it to access any instances that you launch with this
key pair.
Important
If you lose the key pair, you cannot connect to your Amazon EC2 instances.
API Version 2012-08-10
633
For more information about key pairs, see Amazon Elastic Compute Cloud Key Pairs in the Amazon
EC2 User Guide for Linux Instances.
Sign in to the AWS Management Console and open the Amazon EMR console at https://
console.aws.amazon.com/elasticmapreduce/.
Click Create Cluster.
In the Create Cluster page, in the Cluster Configuration section, verify the fields according to the
following table.
Field
Action
Cluster name
Choose Enabled.
This determines whether Amazon EMR captures detailed log data to Amazon
S3.
For more information, see View Log Files in the Amazon EMR Developer
Guide.
Log folder S3 loca- Enter an Amazon S3 path to store your debug logs if you enabled logging in
tion
the previous field.
When this value is set, Amazon EMR copies the log files from the EC2 instances in the cluster to Amazon S3. This prevents the log files from being
lost when the cluster ends and the EC2 instances hosting the cluster are terminated. These logs are useful for troubleshooting purposes.
For more information, see View Log Files in the Amazon EMR Developer
Guide.
Field
Action
Debugging
Choose Enabled.
This option creates a debug log index in SimpleDB (additional charges apply)
to enable detailed debugging in the Amazon EMR console. You can only set
this when the cluster is created. For more information about Amazon SimpleDB,
go to the Amazon SimpleDB product description page.
4.
In the Software Configuration section, verify the fields according to the following table.
Field
Action
Hadoop distribution
Choose Amazon.
This determines which distribution of Hadoop to run on your cluster. You can
choose to run the Amazon distribution of Hadoop or one of several MapR distributions. For more information, see Using the MapR Distribution for Hadoop
in the Amazon EMR Developer Guide.
AMI version
Applications to be A default Hive version should already be selected and displayed in the list. If
installed - Hive
it does not appear, choose it from the Additional applications list.
For more information, see Analyze Data with Hive in the Amazon EMR Developer Guide.
Applications to be A default Pig version should already be selected and displayed in the list. If it
installed - Pig
does not appear, choose it from the Additional applications list.
For more information, see Process Data with Pig in the Amazon EMR Developer
Guide.
5.
In the Hardware Configuration section, verify the fields according to the following table.
Note
The default maximum number of nodes per AWS account is twenty. For example, if you
have two clusters running, the total number of nodes running for both clusters must be 20
or less. Exceeding this limit will result in cluster failures. If you need more than 20 nodes,
you must submit a request to increase your Amazon EC2 instance limit. Ensure that your
requested limit increase includes sufficient capacity for any temporary, unplanned increases
in your needs. For more information, go to the Request to Increase Amazon EC2 Instance
Limit Form.
Field
Action
Network
EC2 Availability
Zone
Choose No preference.
Optionally, you can launch the cluster in a specific EC2 Availability Zone.
For more information, see Regions and Availability Zones in the Amazon EC2
User Guide.
Master - Amazon
EC2 Instance
Type
For this tutorial, use the default EC2 instance type that is shown in this field.
This specifies the EC2 instance types to use as master nodes. The master
node assigns Hadoop tasks to core and task nodes, and monitors their status.
There is always one master node in each cluster.
For more information, see Instance Groups in the Amazon EMR Developer
Guide.
Core - Amazon
EC2 Instance
Type
For this tutorial, use the default EC2 instance type that is shown in this field.
This specifies the EC2 instance types to use as core nodes. A core node is an
EC2 instance that runs Hadoop map and reduce tasks and stores data using
the Hadoop Distributed File System (HDFS). Core nodes are managed by the
master node.
For more information, see Instance Groups in the Amazon EMR Developer
Guide.
Count
Choose 2.
Task - Amazon
EC2 Instance
Type
For this tutorial, use the default EC2 instance type that is shown in this field.
This specifies the EC2 instance types to use as task nodes. A task node only
processes Hadoop tasks and don't store data. You can add and remove them
from a cluster to manage the EC2 instance capacity your cluster uses, increasing capacity to handle peak loads and decreasing it later. Task nodes only run
a TaskTracker Hadoop daemon.
For more information, see Instance Groups in the Amazon EMR Developer
Guide.
Count
Choose 0.
Field
Action
6.
In the Security and Access section, complete the fields according to the following table.
Field
Action
Choose the key pair that you created in Step 1: Create a Key Pair (p. 633).
For more information, see Create SSH Credentials for the Master Node in the
Amazon EMR Developer Guide.
If you do not enter a value in this field, you will not be able to connect to the
master node using SSH. For more information, see Connect to the Cluster in
the Amazon EMR Developer Guide.
IAM role
7.
Review the Bootstrap Actions section, but note that you do not need to make any changes. There
are no bootstrap actions necessary for this sample configuration.
Optionally, you can use bootstrap actions, which are scripts that can install additional software and
change the configuration of applications on the cluster before Hadoop starts. For more information,
see Create Bootstrap Actions to Install Additional Software (Optional) in the Amazon EMR Developer
Guide.
8.
9.
Review your configuration and if you are satisfied with the settings, click Create Cluster.
When the cluster starts, you see the Summary pane.
In the Amazon EMR console, select the cluster from the list of running clusters in the WAITING state.
API Version 2012-08-10
637
The DNS name you use to connect to the instance is listed as Master Public DNS Name.
Go to the command prompt on your system. (On Mac OS X, use the Terminal program in
/Applications/Utilities/Terminal.)
2.
Set the permissions on the .pem file for your Amazon EC2 key pair so that only the key owner has
permissions to access the key. For example, if you saved the file as mykeypair.pem in the user's
home directory, the command is:
chmod og-rwx ~/mykeypair.pem
3.
If you do not perform this step, SSH returns an error saying that your private key file is unprotected
and rejects the key. You only need to perform this step the first time you use the private key to
connect.
To establish the connection to the master node, enter the following command line, which assumes
the .pem file is in the user's home directory. Replace master-public-dns-name with the Master
Public DNS Name of your cluster and replace ~/mykeypair.pem with the location and filename of
your .pem file.
4.
A warning states that the authenticity of the host you are connecting to can't be verified.
Type yes to continue.
Note
If you are asked to log in, enter hadoop.
2.
3.
4.
5.
Launch PuTTYgen.
Click Load.
Select the PEM file you created earlier. Note that you may have to change the search parameters
from file of type PuTTY Private Key Files (*.ppk) to All Files (*.*).
Click Open.
6.
7.
8.
Click OK on the PuTTYgen notice telling you the key was successfully imported.
Click Save private key to save the key in the PPK format.
When PuTTYgen prompts you to save the key without a pass phrase, click Yes.
9.
Start PuTTY.
API Version 2012-08-10
638
2.
Select Session in the Category list. Enter hadoop@DNS in the Host Name field. The input looks
similar to [email protected].
3.
In the Category list, expand Connection, expand SSH, and then select Auth.The Options controlling
the SSH authentication pane appears.
4.
For Private key file for authentication, click Browse and select the private key file you generated
earlier. If you are following this guide, the file name is mykeypair.ppk.
5.
Click Open.
6.
Note
If you are asked to log in, enter hadoop.
After you connect to the master node using either SSH or PuTTY, you should see a Hadoop command
prompt and you are ready to start a Hive interactive session.
At the command prompt for the current master node, type hive.
You should see a hive prompt: hive>
2.
Enter a Hive command that maps a table in the Hive application to the data in DynamoDB. This table
acts as a reference to the data stored in Amazon DynamoDB; the data is not stored locally in Hive
and any queries using this table run against the live data in DynamoDB, consuming the tables read
or write capacity every time a command is run. If you expect to run multiple Hive commands against
the same dataset, consider exporting it first.
The following shows the syntax for mapping a Hive table to a DynamoDB table.
When you create a table in Hive from DynamoDB, you must create it as an external table using the
keyword EXTERNAL. The difference between external and internal tables is that the data in internal
tables is deleted when an internal table is dropped. This is not the desired behavior when connected
to Amazon DynamoDB, and thus only external tables are supported.
For example, the following Hive command creates a table named hivetable1 in Hive that references
the DynamoDB table named dynamodbtable1. The DynamoDB table dynamodbtable1 has a
hash-and-range primary key schema. The hash key element is name (string type), the range key
element is year (numeric type), and each item has an attribute value for holidays (string set type).
Line 1 uses the HiveQL CREATE EXTERNAL TABLE statement. For hivetable1, you need to establish
a column for each attribute name-value pair in the DynamoDB table, and provide the data type.These
values are not case-sensitive, and you can give the columns any name (except reserved words).
Line 2 uses the STORED BY statement.The value of STORED BY is the name of the class that handles
the connection between Hive and DynamoDB. It should be set to
'org.apache.hadoop.hive.dynamodb.DynamoDBStorageHandler'.
Line 3 uses the TBLPROPERTIES statement to associate "hivetable1" with the correct table and
schema in DynamoDB. Provide TBLPROPERTIES with values for the dynamodb.table.name
parameter and dynamodb.column.mapping parameter. These values are case-sensitive.
Note
All DynamoDB attribute names for the table must have corresponding columns in the Hive
table. Otherwise, the Hive table won't contain the name-value pair from DynamoDB. If you
do not map the DynamoDB primary key attributes, Hive generates an error. If you do not
map a non-primary key attribute, no error is generated, but you won't see the data in the
Hive table. If the data types do not match, the value is null.
Then you can start running Hive operations on hivetable1. Queries run against hivetable1 are internally
run against the DynamoDB table dynamodbtable1 of your DynamoDB account, consuming read or write
units with each execution.
When you run Hive queries against a DynamoDB table, you need to ensure that you have provisioned a
sufficient amount of read capacity units.
For example, suppose that you have provisioned 100 units of read capacity for your DynamoDB table.
This will let you perform 100 reads, or 409,600 bytes, per second. If that table contains 20GB of data
(21,474,836,480 bytes), and your Hive query performs a full table scan, you can estimate how long the
query will take to run:
21,474,836,480 / 409,600 = 52,429 seconds = 14.56 hours
The only way to decrease the time required would be to adjust the read capacity units on the source
DynamoDB table. Adding more Amazon EMR nodes will not help.
In the Hive output, the completion percentage is updated when one or more mapper processes are
finished. For a large DynamoDB table with a low provisioned read capacity setting, the completion
percentage output might not be updated for a long time; in the case above, the job will appear to be 0%
complete for several hours. For more detailed status on your job's progress, go to the Amazon EMR
console; you will be able to view the individual mapper task status, and statistics for data reads.
You can also log on to Hadoop interface on the master node and see the Hadoop statistics. This will show
you the individual map task status and some data read statistics. For more information, see the following
topics:
Web Interfaces Hosted on the Master Node
View the Hadoop Web Interfaces
For more information about sample HiveQL statements to perform tasks such as exporting or importing
data from DynamoDB and joining tables, see Hive Command Examples for Exporting, Importing, and
Querying Data in Amazon DynamoDB in the Amazon EMR Developer Guide.
You can also create a file that contains a series of commands, launch a cluster, and reference that file
to perform the operations. For more information, see Interactive and Batch Modes in the Amazon EMR
Developer Guide.
2.
At the shell prompt, enter the Kill Command from the initial server response to your request.
Alternatively, you can run the following command from the command line of the master node to kill
the Hadoop job, where job-id is the identifier of the Hadoop job and can be retrieved from the
Hadoop user interface. For more information about the Hadoop user interface, see How to Use the
Hadoop User Interface in the Amazon EMR Developer Guide.
DynamoDB type
string
string (S)
bigint or double
number (N)
binary
binary (B)
array
The bigint type in Hive is the same as the Java long type, and the Hive double type is the same as the
Java double type in terms of precision. This means that if you have numeric data stored in DynamoDB
that has precision higher than is available in the Hive datatypes, using Hive to export, import, or reference
the DynamoDB data could lead to a loss in precision or a failure of the Hive query.
Exports of the binary type from DynamoDB to Amazon Simple Storage Service (Amazon S3) or HDFS
are stored as a Base64-encoded string. If you are importing data from Amazon S3 or HDFS into the
DynamoDB binary type, it should be encoded as a Base64 string.
Hive Options
You can set the following Hive options to manage the transfer of data out of Amazon DynamoDB. These
options only persist for the current Hive session. If you close the Hive command prompt and reopen it
later on the cluster, these settings will have returned to the default values.
Hive Options
Description
The value of 0.5 is the default read rate, which means that
Hive will attempt to consume half of the read provisioned
throughout resources in the table. Increasing this value
above 0.5 increases the read request rate. Decreasing it
below 0.5 decreases the read request rate. This read rate
is approximate. The actual read rate will depend on factors
such as whether there is a uniform distribution of keys in
DynamoDB.
If you find your provisioned throughput is frequently exceeded by the Hive operation, or if live read traffic is being
throttled too much, then reduce this value below 0.5. If you
have enough capacity and want a faster Hive operation,
set this value above 0.5. You can also oversubscribe by
setting it up to 1.5 if you believe there are unused input/output operations available.
dynamodb.throughput.write.percent
dynamodb.endpoint
Hive Options
Description
dynamodb.max.map.tasks
dynamodb.retry.duration
Specify the number of minutes to use as the timeout duration for retrying Hive commands. This value must be an integer equal to or greater than 0.The default timeout duration
is two minutes.
These options are set using the SET command as shown in the following example.
SET dynamodb.throughput.read.percent=1.0;
INSERT OVERWRITE TABLE s3_export SELECT *
FROM hiveTableName;
If you are using the AWS SDK for Java, you can use the -e option of Hive to pass in the command directly,
as shown in the last line of the following example.
steps.add(new StepConfig()
.withName("Run Hive Script")
.withHadoopJarStep(new HadoopJarStepConfig()
.withJar("s3://us-west-2.elasticmapreduce/libs/script-runner/script-runner.jar")
.withArgs("s3://us-west-2.elasticmapreduce/libs/hive/hive-script",
"--base-path","s3://us-west-2.elasticmapreduce/libs/hive/","--run-hive-script",
"--args","-e","SET dynamodb.throughput.read.percent=1.0;")));
Note
When you map a Hive table to a location in Amazon S3, do not map it to the root path of the
bucket, s3://mybucket, as this may cause errors when Hive writes the data to Amazon S3. Instead
map the table to a subpath of the bucket, s3://mybucket/mypath.
Create a Hive table that references data stored in DynamoDB. Then you can call the INSERT
OVERWRITE command to write the data to an external directory. In the following example,
s3://bucketname/path/subpath/ is a valid path in Amazon S3. Adjust the columns and datatypes
in the CREATE command to match the values in your DynamoDB. You can use this to create an
archive of your DynamoDB data in Amazon S3.
Create an external table that references a location in Amazon S3. This is shown below as s3_export.
During the CREATE call, specify row formatting for the table. Then, when you use INSERT
OVERWRITE to export data from DynamoDB to s3_export, the data is written out in the specified
format. In the following example, the data is written out as comma-separated values (CSV).
Create a Hive table that references data stored in DynamoDB.This is similar to the preceding example,
except that you are not specifying a column mapping. The table must have exactly one column of
type map<string, string>. If you then create an EXTERNAL table in Amazon S3 you can call the
INSERT OVERWRITE command to write the data from DynamoDB to Amazon S3. You can use this
to create an archive of your DynamoDB data in Amazon S3. Because there is no column mapping,
you cannot query tables that are exported this way. Exporting data without specifying a column
mapping is available in Hive 0.8.1.5 or later, which is supported on Amazon EMR AMI 2.2.x and later.
Note
DynamoDB tables that contain JSON types (list, map, boolean, null) can only be exported
without specifying a column mapping. This is supported on Amazon EMR AMI 3.3.2 and
later.
Hive provides several compression codecs you can set during your Hive session. Doing so causes
the exported data to be compressed in the specified format. The following example compresses the
exported files using the Lempel-Ziv-Oberhumer (LZO) algorithm.
SET hive.exec.compress.output=true;
SET io.seqfile.compression.type=BLOCK;
SET mapred.output.compression.codec = com.hadoop.compression.lzo.LzopCodec;
org.apache.hadoop.io.compress.GzipCodec
org.apache.hadoop.io.compress.DefaultCodec
com.hadoop.compression.lzo.LzoCodec
com.hadoop.compression.lzo.LzopCodec
org.apache.hadoop.io.compress.BZip2Codec
org.apache.hadoop.io.compress.SnappyCodec
Use the following Hive command, where hdfs:///directoryName is a valid HDFS path and
hiveTableName is a table in Hive that references DynamoDB. This export operation is faster than
exporting a DynamoDB table to Amazon S3 because Hive 0.7.1.1 uses HDFS as an intermediate
step when exporting data to Amazon S3. The following example also shows how to set
dynamodb.throughput.read.percent to 1.0 in order to increase the read request rate.
You can also export data to HDFS using formatting and compression as shown above for the export
to Amazon S3. To do so, simply replace the Amazon S3 directory in the examples above with an
HDFS directory.
You can read and write non-printable UTF-8 character data with Hive by using the STORED AS
SEQUENCEFILE clause when you create the table. A SequenceFile is Hadoop binary file format; you
need to use Hadoop to read this file.The following example shows how to export data from DynamoDB
into Amazon S3. You can use this functionality to handle non-printable UTF-8 encoded characters.
You can use Amazon EMR (Amazon EMR) and Hive to write data from Amazon S3 to DynamoDB.
Create an EXTERNAL table that references data stored in Amazon S3 that was previously exported
from DynamoDB. Before importing, ensure that the table exists in DynamoDB and that it has the
same key schema as the previously exported DynamoDB table. In addition, the table must have
exactly one column of type map<string, string>. If you then create a Hive table that is linked to
DynamoDB, you can call the INSERT OVERWRITE command to write the data from Amazon S3 to
DynamoDB. Because there is no column mapping, you cannot query tables that are imported this
way. Importing data without specifying a column mapping is available in Hive 0.8.1.5 or later, which
is supported on Amazon EMR AMI 2.2.3 and later.
Note
DynamoDB tables that contain JSON types (list, map, boolean, null) can only be imported
without specifying a column mapping. This is supported on Amazon EMR AMI 3.3.2 and
later.
You can use Amazon EMR and Hive to write data from HDFS to DynamoDB.
Use Hive commands like the following. In the first command, the CREATE statement creates a Hive
table that references data stored in DynamoDB.The SELECT statement then uses that table to query
data stored in DynamoDB. The following example finds the largest order placed by a given customer.
You can use the GROUP BY clause to collect data across multiple records. This is often used with
an aggregate function such as sum, count, min, or max. The following example returns a list of the
largest orders from customers who have placed more than three orders.
The following example maps two Hive tables to data stored in DynamoDB. It then calls a join across
those two tables. The join is computed on the cluster and returned. The join does not take place in
DynamoDB. This example returns a list of customers and their purchases for customers that have
placed more than two orders.
In the following example, Customer_S3 is a Hive table that loads a CSV file stored in Amazon S3
and hive_purchases is a table that references data in DynamoDB. The following example joins
together customer data stored as a CSV file in Amazon S3 with order data stored in DynamoDB to
return a set of data that represents orders placed by customers who have "Miller" in their name.
Note
In the preceding examples, the CREATE TABLE statements were included in each example for
clarity and completeness. When running multiple queries or export operations against a given
Hive table, you only need to create the table one time, at the beginning of the Hive session.
The number of map tasks run on an instance depends on the EC2 instance type. For more information
about the supported EC2 instance types and the number of mappers each one provides, go to Hadoop
Configuration Reference in the Amazon EMR Developer Guide. There, you will find a "Task Configuration"
section for each of the supported configurations.
Another way to increase the number of mapper daemons is to change the
mapred.tasktracker.map.tasks.maximum configuration parameter of Hadoop to a higher value.
This has the advantage of giving you more mappers without increasing either the number or the size of
EC2 instances, which saves you money. A disadvantage is that setting this value too high can cause the
EC2 instances in your cluster to run out of memory.To set mapred.tasktracker.map.tasks.maximum,
launch the cluster and specify the Configure Hadoop bootstrap action, passing in a value for
mapred.tasktracker.map.tasks.maximum as one of the arguments of the bootstrap action. This is
shown in the following example.
--bootstrap-action s3n://elasticmapreduce/bootstrap-actions/configure-hadoop \
--args -m,mapred.tasktracker.map.tasks.maximum=10
For more information about bootstrap actions, see Create Bootstrap Actions to Install Additional Software
(Optional) in the Amazon EMR Developer Guide.
Process Duration
Data consistency in DynamoDB depends on the order of read and write operations on each node. While
a Hive query is in progress, another application might load new data into the DynamoDB table or modify
or delete existing data. In this case, the results of the Hive query might not reflect changes made to the
data while the query was running.
Request Time
Scheduling Hive queries that access a DynamoDB table when there is lower demand on the DynamoDB
table improves performance. For example, if most of your application's users live in San Francisco, you
might choose to export daily data at 4 a.m. PST, when the majority of users are asleep, and not updating
records in your DynamoDB database.
Time-Based Tables
If the data is organized as a series of time-based DynamoDB tables, such as one table per day, you can
export the data when the table becomes no longer active. You can use this technique to back up data to
Amazon S3 on an ongoing fashion.
Archived Data
If you plan to run many Hive queries against the data stored in DynamoDB and your application can
tolerate archived data, you may want to export the data to HDFS or Amazon S3 and run the Hive queries
against a copy of the data instead of DynamoDB. This conserves your read operations and provisioned
throughput.
Video
Video: Using Amazon Elastic MapReduce (Amazon EMR) to Export and Analyze DynamoDB Data
Step-by-Step Instructions
Topics
Setting Up the Environment (p. 654)
Exporting Data to Amazon S3 (p. 655)
Exporting DynamoDB Data to a Native Hive Table and Executing Queries (p. 658)
Final Cleanup (p. 661)
When you have completed this walkthrough, you will have a DynamoDB table with sample data, an
Amazon S3 bucket with exported data, an Amazon EMR job flow, two Apache Hive external tables, and
one native Hive table.
2.
The ProductCatalog table used in the video is one of the tables you create by following the steps
in the Creating Tables and Loading Sample Data (p. 14) section to create and populate the DynamoDB
tables.
Create a bucket in Amazon S3.
3.
For step-by-step instructions, go to the Creating an Amazon S3 Bucket topic in the Amazon Simple
Storage Service Getting Started Guide.
Set up an Amazon EMR job flow.
This Amazon EMR job flow handles the queries between DynamoDB, Apache Hive, and Amazon
S3. Follow the Prerequisites and Steps 1 through 3 in the Exporting, Importing, Querying, and Joining
Tables in DynamoDB Using Amazon EMR section of the DynamoDB documentation to set up your
job flow for these operations.
When you have completed the environment setup, your SSH session will look like this screen shot. You
can now proceed with the rest of the walkthrough.
2.
Create the external Hive table pc_dynamodb that maps to the ProductCatalog table in DynamoDB.
Copy and paste the following code into your Hive session.
CREATE EXTERNAL TABLE pc_dynamodb (
id bigint
,title string
,isbn string
,authors array<string>
,price bigint
,dimensions string
,pagecount bigint
,inpublication bigint
,productcategory string
,description string
,bicycletype string
,brand string
,gender string
,color array<string>)
STORED BY 'org.apache.hadoop.hive.dynamodb.DynamoDBStorageHandler'
TBLPROPERTIES ("dynamodb.table.name"="ProductCatalog","dynamodb.column.map
ping" = "id:Id,title:Title
,isbn:ISBN,authors:Authors,price:Price,dimensions:Dimensions,page
count:PageCount
,inpublication:InPublication,productcategory:ProductCategory,descrip
tion:Description
,bicycletype:BicycleType,brand:Brand,gender:Gender,color:Color");
When it has completed creating the table, Hive responds OK. You can verify the existence of the
table by typing show tables; at the command line.
3.
Create a second external Hive table that maps to a folder in the specified Amazon S3 bucket.
Copy and paste the following code into your Hive session. The external Hive table name is pc_s3,
and it maps to a folder in the Amazon S3 bucket myawsbucket1/catalog. Note that we specify
ROW FORMAT to request comma-separated values in the resulting Amazon S3 object. Before copying
and pasting this code, adjust the name of the Amazon S3 bucket in the last line to the name of the
bucket and folder you created in the To set up the walkthrough environment (p. 654) procedure.
When it has completed creating the table, Hive responds OK. Now you can export the DynamoDB
table data to an Amazon S3 bucket.
This statement selects data from the Dynamo DB table and inserts it into a folder in the specified
Amazon S3 bucket through the mapped tables.
Verify the resulting object by returning to the AWS Management Console at https://
console.aws.amazon.com/s3/home and locating the bucket you created.
3.
To download the file, right-click the file, and then click Download in the context menu.
Click the Download button to save the file to your local drive.
4.
Open the file in a text editor to see the data. Depending on your platform, you may need to add a
".txt" file name extension to open the file.
Note
You can import data from Amazon S3 to a DynamoDB table, too. This is a useful way to
import existing data into a new DynamoDB table or perform periodic bulk uploads of data
from another application. With Amazon EMR's support for scripting, you can save your
scripts and run them according to a schedule.
throughput in DynamoDB, but queries on the data stored natively in an Amazon EMR cluster do not
consume DynamoDB provisioned throughput.
You already have an external Hive table (pc_dynamodb) mapped to our DynamoDB ProductCatalog
table as shown in the preceding figure. Now you need only create a native Hive table where you will load
the data for your query.
Copy and paste the following code into your Hive session.
CREATE TABLE pc_hive (
id bigint
,title string
,isbn string
,authors array<string>
,price bigint
,dimensions string
,pagecount bigint
,inpublication bigint
,productcategory string
,description string
,bicycletype string
,brand string
,gender string
,color array<string>
);
This statement creates the native Hive table. Notice that the EXTERNAL key word is not used.
2.
Upload the DynamoDB table data into the new Hive table using an INSERT statement.
INSERT OVERWRITE TABLE pc_hive
SELECT * FROM pc_dynamodb;
Copy and paste the following code into your Hive session.
SELECT ProductCategory, count(*)
FROM pc_hive
GROUP BY ProductCategory;
With this SELECT statement, you are querying the native Hive table, and not querying DynamoDB
at all. Therefore, you are not using any DynamoDB provisioned throughput nor affecting your live
tables.
In the preceding screen shot, the query results are shown in the white box.
Tip
For more information about SQL statements using HiveQL, go to SQL Operations on the
Getting Started page for Apache Hive.
Final Cleanup
When you have completed this walkthrough, you can remove the DynamoDB table, the Amazon S3
bucket, and the Amazon EMR job flow to avoid incurring additional charges.
1.
2.
Delete the sample tables by following the instructions in Step 5: Delete Example Tables (p. 51).
Delete the bucket in Amazon S3.
3.
In this example, the source table in DynamoDB is my-favorite-movies-table. The target table in
Amazon Redshift is favoritemovies.The readratio 50 clause regulates the percentage of provisioned
throughput that is consumed; in this case, the COPY command will use no more than 50 percent of the
read capacity units provisioned for my-favorite-movies-table. We highly recommend setting this
ratio to a value less than the average unused provisioned throughput.
For detailed instructions on loading data from DynamoDB into Amazon Redshift, refer to the following
sections in the Amazon Redshift Database Developer Guide:
Loading data from a DynamoDB table
The COPY command
COPY examples
Limits in DynamoDB
The following table describes current limits within Amazon DynamoDB (or no limit, in some cases).
Note
Each limit listed below applies on a per-region basis unless otherwise specified.
Table names and secondary index
names
Table size
No practical limit.
UpdateTable: Limits when decreasing You can call UpdateTable to reduce provisioned throughput,
provisioned throughput on tables and
but no more than four times per table in a single UTC calendar
global secondary indexes
day.
In an UpdateTable operation, you can decrease the provisioned throughput for a table, for any global secondary indexes on that table, or for any combination of these.
For every table and global secondary index in an UpdateTable operation, you can decrease ReadCapacityUnits
or WriteCapacityUnits (or both). The new provisioned
throughput settings do not take effect until the UpdateTable
operation is complete.
Maximum concurrent CreateTable/Up- In general, you can have up to 10 of these requests running
dateTable/DeleteTable API requests at the same time. For example, the cumulative number of
tables in the CREATING, UPDATING or DELETING state cannot
exceed 10.
The only exception is when you are creating a table with one
or more secondary indexes. You can have up to 5 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce
the number of concurrent requests below 5.
Maximum number of secondary indexes You can define up to 5 local secondary indexes and 5 global
per table
secondary indexes per table.
Maximum number of projected second- You can project a total of up to 20 attributes into all of a table's
ary index attributes per table
local and global secondary indexes. This only applies to userspecified projected attributes.
In a CreateTable operation, if you specify a ProjectionType of INCLUDE, the total count of attributes specified in
NonKeyAttributes, summed across all of the secondary
indexes, must not exceed 20. If you project the same attribute
name into two different indexes, this counts as two distinct
attributes when determining the total.
This limit does not apply for secondary indexes with a ProjectionType of KEYS_ONLY or ALL.
Attribute name lengths
Item size
Attribute values
All strings must conform to the UTF-8 encoding. Since UTF8 is a variable width encoding, string sizes are determined
using the UTF-8 bytes.
Number
Expression parameters
Up to 100 items retrieved. The total size of all the items retrieved cannot exceed 16 MB.
Up to 25 PutItem or DeleteItem operations per BatchWriteItem call. The total size of all the items written cannot
exceed 16 MB.
Query
The result set is limited to 1 MB per API call. You can use the
LastEvaluatedKey from the query response to retrieve
more results.
Scan
Change
Description
Amazon DynamoDB
Storage Backend for
Titan
Date Changed
Change
Description
Date Changed
Amazon DynamoDB
Streams, Cross-Region
Replication, and Scan
with Strongly Consistent Reads
Change
Description
Date Changed
Scan API for secondary In DynamoDB, a Scan operation reads all of the items in a
February 10,
indexes
2015
table, applies user-defined filtering criteria, and returns the
selected data items to the application. This same capability
is now available for secondary indexes too. To scan a local
secondary index or a global secondary index, you specify the
index name and the name of its parent table. By default, an
index Scan returns all of the data in the index; you can use
a filter expression to narrow the results that are returned to
the application. For more information, see Query and Scan
Operations in DynamoDB (p. 193).
Online operations for
global secondary indexes
Online indexing lets you add or remove global secondary in- January 27,
dexes on existing tables. With online indexing, you do not
2015
need to define all of a table's indexes when you create a table;
instead, you can add a new index at any time. Similarly, if you
decide you no longer need an index, you can remove it at any
time. Online indexing operations are non-blocking, so that the
table remains available for read and write activity while indexes are being added or removed. For more information,
see Managing Global Secondary Indexes (p. 269).
Flexible scaling
For tables and global secondary indexes, you can increase October 7,
provisioned read and write throughput capacity by any
2014
amount, provided that you stay within your per-table and peraccount limits. For more information, see Limits in DynamoDB (p. 664).
October 7,
2014
Change
Description
Date Changed
Improved conditional
expressions
Query filter
The DynamoDB Query API supports a new QueryFilter April 24, 2014
option. By default, a Query finds items that match a specific
hash key value and an optional range key condition. A Query
filter applies conditional expressions to other, non-key attributes; if a Query filter is present, then items that do not match
the filter conditions are discarded before the Query results
are returned to the application. For more information, see
Query and Scan Operations in DynamoDB (p. 193).
Data export and import The DynamoDB console has been enhanced to simplify ex- March 6, 2014
using the AWS Manage- ports and imports of data in DynamoDB tables. With just a
ment Console
few clicks, you can set up an AWS Data Pipeline to orchestrate the workflow, and an Amazon Elastic MapReduce cluster
to copy data from DynamoDB tables to an Amazon S3 bucket,
or vice-versa. You can perform an export or import one time
only, or set up a daily export job.You can even perform crossregion exports and imports, copying DynamoDB data from a
table in one AWS region to a table in another AWS region.
For more information, see Using the AWS Management
Console to Export and Import Data (p. 618) and Global Secondary Indexes (p. 261).
Reorganized higherlevel API documentation
January 20,
2014
Change
Description
Date Changed
Fine-grained access
control
DynamoDB adds support for fine-grained access control. This October 29,
feature allows customers to specify which principals (users, 2013
groups, or roles) can access individual items and attributes
in a DynamoDB table or secondary index. Applications can
also leverage web identity federation to offload the task of
user authentication to a third-party identity provider, such as
Facebook, Google, or Login with Amazon. In this way, applications (including mobile apps) can handle very large numbers
of users, while ensuring that no one can access DynamoDB
data items unless they are authorized to do so. For more information, see Fine-Grained Access Control for DynamoDB (p. 597).
4 KB read capacity unit The capacity unit size for reads has increased from 1 KB to May 14, 2013
size
4 KB. This enhancement can reduce the number of provisioned read capacity units required for many applications.
For example, prior to this release, reading a 10 KB item would
consume 10 read capacity units; now that same 10 KB read
would consume only 3 units (10 KB / 4 KB, rounded up to the
next 4 KB boundary). For more information, see Provisioned
Throughput in Amazon DynamoDB (p. 11).
Parallel scans
DynamoDB adds support for parallel Scan operations. Applic- May 14, 2013
ations can now divide a table into logical segments and scan
all of the segments simultaneously. This feature reduces the
time required for a Scan to complete, and fully utilizes a table's
provisioned read capacity. For more information, see Parallel
Scan (p. 198).
Change
Description
Date Changed
With this release, DynamoDB introduces a new API version April 18, 2013
(2012-08-10). The previous API version (2011-12-05) is still
supported for backward compatibility with existing applications.
New applications should use the new API version 2012-0810. We recommend that you migrate your existing applications
to API version 2012-08-10, since new DynamoDB features
(such as local secondary indexes) will not be backported to
the previous API version. For more information on API version
2012-08-10, see the Amazon DynamoDB API Reference.
PHP code samples up- Version 2 of the AWS SDK for PHP is now available. The
January 23,
dated for AWS SDK for PHP code samples in the Amazon DynamoDB Developer
2013
PHP version 2
Guide have been updated to use this new SDK. For more information on Version 2 of the SDK, see AWS SDK for PHP.
New endpoint
New endpoint
New endpoint
DynamoDB expands to the Asia Pacific (Sydney) region. For November 13,
the current list of supported endpoints, see Regions and En- 2012
dpoints.
Change
Description
Date Changed
Support for binary data In addition to the Number and String types, DynamoDB now August 21,
type
supports Binary data type.
2012
Prior to this release, to store binary data, you converted your
binary data into string format and stored it in DynamoDB. In
addition to the required conversion work on the client-side,
the conversion often increased the size of the data item requiring more storage and potentially additional provisioned
throughput capacity.
With the binary type attributes you can now store any binary
data, for example compressed data, encrypted data, and images. For more information see DynamoDB Data
Types (p. 6). For working examples of handling binary type
data using the AWS SDKs, see the following sections:
Example: Handling Binary Type Attributes Using the AWS
SDK for Java Document API (p. 140)
Example: Handling Binary Type Attributes Using the AWS
SDK for .NET Low-Level API (p. 173)
For the added binary data type support in the AWS SDKs,
you will need to download the latest SDKs and you might also
need to update any existing applications. For information
about downloading the AWS SDKs, see Using the AWS SDKs
with DynamoDB (p. 53).
DynamoDB table items
can be updated and
copied using the DynamoDB console
DynamoDB users can now update and copy table items using August 14,
the DynamoDB Console, in addition to being able to add and 2012
delete items.This new functionality simplifies making changes
to individual items through the Console. For more information,
see the Working with Items and Attributes (p. 400) topic in the
Amazon DynamoDB Developer Guide.
DynamoDB lowers
minimum table
throughput requirements
DynamoDB and
For more information, see Walkthrough: Using DynamoDB
Amazon Elastic
and Amazon Elastic MapReduce (p. 653).
MapReduce (Amazon
EMR) integration video
and walkthrough added
Signature Version 4
support
July 5, 2012
Change
Description
Date Changed
Table explorer support The DynamoDB Console now supports a table explorer that May 22, 2012
in DynamoDB Console enables you to browse and query the data in your tables.You
can also insert new items or delete existing items. The Creating Tables and Loading Sample Data (p. 14) and DynamoDB
Console (p. 398) sections have been updated for these features.
New endpoints
DynamoDB now supports a batch write API that enables you April 19, 2012
to put and delete several items from one or more tables in a
single API call. For more information about the DynamoDB
batch write API, see BatchWriteItem (p. 742).
For information about working with items and using batch
write feature using AWS SDKs, see Working with Items in
DynamoDB (p. 92) and Using the AWS SDKs with DynamoDB (p. 53).
April 5, 2012
New endpoint
The AWS SDK for PHP returns scan results as a SimpleXM- February 2,
LElement object. For an example of how to iterate through
2012
the scan results, see Scanning Using the AWS SDK for PHP
Low-Level API (p. 241).
Change
Description
Date Changed
Added examples for in- DynamoDB supports incrementing and decrementing existing January 25,
crementing values
numeric values. Examples show adding to existing values in 2012
the "Updating an Item" sections at:
Working with Items Using the AWS SDK for Java Document
API (p. 121).
Working with Items Using the AWS SDK for .NET Low-Level
API (p. 143).
Working with Items Using the AWS SDK for PHP Low-Level
API (p. 178).
Initial product release
January 18,
2012
DynamoDB Appendix
Topics
Example Tables and Data (p. 678)
Creating Example Tables and Uploading Data (p. 683)
Reserved Words in DynamoDB (p. 718)
Legacy Conditional Parameters (p. 728)
Current API Version (2012-08-10) (p. 736)
Previous API Version (2011-12-05) (p. 737)
Primary
Key Type
Hash
Attribute Name: Id
Type: Number
Hash
Hash and
Range
Hash and
Range
Attribute Name: Id
Type: String
Index Name
Attribute to Index
Projected Attributes
PostedBy-index
PostedBy
The ProductCatalog table represents a table in which each product item is uniquely identified by an Id.
Because each table is like a property bag, you can store all kinds of products in this table. For illustration,
we store book and bicycle items. In a DynamoDB table, an attribute can be multivalued. For example, a
book can have multiple authors. All the book items stored have an Authors attribute that stores one or
more author names and the bicycle items have a Color multivalued attribute for the available colors.
The Forum, Thread, and Reply tables are modeled after the AWS forums. Each AWS service maintains
one or more forums. Customers start a thread by posting a message that has a unique subject. Each
thread might receive one or more replies at different times. These replies are stored in the Reply table.
For more information, see AWS Forums.
DynamoDB does not support table joins. Additionally, when accessing data, queries are the most efficient
and table scans should be avoided because of performance issues. These should be taken into
consideration when you design your table schemas. For example, you might want to join the Reply and
Thread tables. The Reply table Id attribute is set up as a concatenation of the forum name and subject
values with a "#" in between to enable efficient queries. If you have a reply item, you can parse the Id to
find forum name and thread subject. You can then use these values to query the Forum or the Thread
table as you need.
For more information about the DynamoDB data model, see DynamoDB Data Model (p. 3).
Other Attributes
{
Title = "Book 101 Title"
ISBN = "111-1111111111"
Authors = "Author 1"
Price = -2
Dimensions = "8.5 x 11.0 x 0.5"
PageCount = 500
InPublication = true
ProductCategory = "Book"
}
102
{
Title = "Book 102 Title"
ISBN = "222-2222222222"
Authors = [ "Author 1", "Author 2" ]
Price = 20
Dimensions = "8.5 x 11.0 x 0.8"
PageCount = 600
InPublication = true
ProductCategory = "Book"
}
Id (Primary Key)
103
Other Attributes
{
Title = "Book 103 Title"
ISBN = "333-3333333333"
Authors = [ "Author 1", "Author2", "Author 3" ]
Price = 200
Dimensions = "8.5 x 11.0 x 1.5"
PageCount = 700
InPublication = false
ProductCategory = "Book"
}
201
{
Title = "18-Bicycle 201"
Description = "201 description"
BicycleType = "Road"
Brand = "Brand-Company A"
Price = 100
Gender = "M"
Color = [ "Red", "Black" ]
ProductCategory = "Bike"
}
202
{
Title = "21-Bicycle 202"
Description = "202 description"
BicycleType = "Road"
Brand = "Brand-Company A"
Price = 200
Gender = "M"
Color = [ "Green", "Black" ]
ProductCategory = "Bike"
}
203
{
Title = "19-Bicycle 203"
Description = "203 description"
BicycleType = "Road"
Brand = "Brand-Company B"
Price = 300
Gender = "W"
Color = [ "Red", "Green", "Black" ]
ProductCategory = "Bike"
}
Id (Primary Key)
Other Attributes
204
{
Title = "18-Bicycle 204"
Description = "204 description"
BicycleType = "Mountain"
Brand = "Brand-Company B"
Price = 400
Gender = "W"
Color = [ "Red" ]
ProductCategory = "Bike"
}
205
{
Title = "20-Bicycle 205"
Description = "205 description"
BicycleType = "Hybrid"
Brand = "Brand-Company C"
Price = 500
Gender = "B"
Color = [ "Red", "Black" ]
ProductCategory = "Bike"
}
Other Attributes
{
Category="Amazon Web Services"
Threads=3
Messages=4
Views=1000
LastPostBy="User A"
LastPostDateTime= "2012-01-03T00:40:57.165Z"
}
"Amazon S3"
{
Category="AWS"
Threads=1
}
Other Attributes
ForumName = "DynamoDB"
Subject = "DynamoDB Thread 1"
{
Message = "DynamoDB thread 1 message text"
LastPostedBy = "User A"
Views = 0
Replies = 0
Answered = 0
Tags = [ "index", "primarykey", "table" ]
LastPostDateTime = "2012-01-03T00:40:57.165Z"
}
ForumName = "DynamoDB"
Subject = "DynamoDB Thread 2"
{
Message = "DynamoDB thread 2 message text"
LastPostedBy = "User A"
Views = 0
Replies = 0
Answered = 0
Tags = [ "index", "primarykey", "rangekey" ]
LastPostDateTime = "2012-01-03T00:40:57.165Z"
}
{
Message = "Amazon S3 Thread 1 message text"
LastPostedBy = "User A"
Views = 0
Replies = 0
Answered = 0
Tags = [ "largeobject", "multipart upload" ]
LastPostDateTime = "2012-01-03T00:40:57.165Z"
}
Primary Key
Other Attributes
Id = "DynamoDB#DynamoDB Thread
{
1"
Message = "DynamoDB Thread 1 Reply 1 text"
ReplyDateTime = "2011-12PostedBy = "User A"
11T00:40:57.165Z"
}
Id = "DynamoDB#DynamoDB Thread
{
1"
Message = "DynamoDB Thread 1 Reply 1 text"
ReplyDateTime = "2011-12PostedBy = "User A"
18T00:40:57.165Z"
}
Id = "DynamoDB#DynamoDB Thread
{
1"
Message = "DynamoDB Thread 1 Reply 3 text"
ReplyDateTime = "2011-12PostedBy = "User B"
25T00:40:57.165Z"
}
Id = "DynamoDB#DynamoDB Thread
{
2"
Message = "DynamoDB Thread 2 Reply 1 text"
ReplyDateTime = "2011-12PostedBy = "User A"
25T00:40:57.165Z"
}
Id = "DynamoDB#DynamoDB Thread
{
2"
ReplyDateTime = "2012-0103T00:40:57.165Z"
}
java.text.SimpleDateFormat;
java.util.ArrayList;
java.util.Arrays;
java.util.Date;
java.util.HashSet;
java.util.TimeZone;
import
import
import
import
import
import
import
import
import
import
import
import
import
com.amazonaws.auth.profile.ProfileCredentialsProvider;
com.amazonaws.services.dynamodbv2.AmazonDynamoDBClient;
com.amazonaws.services.dynamodbv2.document.DynamoDB;
com.amazonaws.services.dynamodbv2.document.Item;
com.amazonaws.services.dynamodbv2.document.Table;
com.amazonaws.services.dynamodbv2.model.AttributeDefinition;
com.amazonaws.services.dynamodbv2.model.CreateTableRequest;
com.amazonaws.services.dynamodbv2.model.KeySchemaElement;
com.amazonaws.services.dynamodbv2.model.KeyType;
com.amazonaws.services.dynamodbv2.model.LocalSecondaryIndex;
com.amazonaws.services.dynamodbv2.model.Projection;
com.amazonaws.services.dynamodbv2.model.ProjectionType;
com.amazonaws.services.dynamodbv2.model.ProvisionedThroughput;
String
String
String
String
productCatalogTableName = "ProductCatalog";
forumTableName = "Forum";
threadTableName = "Thread";
replyTableName = "Reply";
.withKeyType(KeyType.HASH));
ArrayList<AttributeDefinition> attributeDefinitions = new ArrayL
ist<AttributeDefinition>();
attributeDefinitions.add(new AttributeDefinition()
.withAttributeName(hashKeyName)
.withAttributeType(hashKeyType));
if (rangeKeyName != null) {
keySchema.add(new KeySchemaElement()
.withAttributeName(rangeKeyName)
.withKeyType(KeyType.RANGE));
attributeDefinitions.add(new AttributeDefinition()
.withAttributeName(rangeKeyName)
.withAttributeType(rangeKeyType));
}
CreateTableRequest request = new CreateTableRequest()
.withTableName(tableName)
.withKeySchema(keySchema)
.withProvisionedThroughput( new ProvisionedThroughput()
.withReadCapacityUnits(readCapacityUnits)
.withWriteCapacityUnits(writeCapacityUnits));
// If this is the Reply table, define a local secondary index
if (replyTableName.equals(tableName)) {
attributeDefinitions.add(new AttributeDefinition()
.withAttributeName("PostedBy")
.withAttributeType("S"));
ArrayList<LocalSecondaryIndex> localSecondaryIndexes = new Ar
rayList<LocalSecondaryIndex>();
localSecondaryIndexes.add(new LocalSecondaryIndex()
.withIndexName("PostedBy-Index")
.withKeySchema(
new KeySchemaElement().withAttributeName(hashKey
Name).withKeyType(KeyType.HASH),
new KeySchemaElement() .withAttributeName("PostedBy")
.withKeyType(KeyType.RANGE))
.withProjection(new Projection() .withProjectionType(Projec
tionType.KEYS_ONLY)));
request.setLocalSecondaryIndexes(localSecondaryIndexes);
}
request.setAttributeDefinitions(attributeDefinitions);
System.out.println("Issuing CreateTable request for " + tableName);
Table table = dynamoDB.createTable(request);
System.out.println("Waiting for " + tableName
+ " to be created...this may take a while...");
table.waitForActive();
} catch (Exception e) {
System.err.println("CreateTable request failed for " + tableName);
System.err.println(e.getMessage());
}
}
private static void loadSampleProducts(String tableName) {
Table table = dynamoDB.getTable(tableName);
try {
System.out.println("Adding data to " + tableName);
Item item = new Item()
.withPrimaryKey("Id", 101)
.withString("Title", "Book 101 Title")
.withString("ISBN", "111-1111111111")
.withStringSet("Authors", new HashSet<String>(
Arrays.asList("Author1")))
.withNumber("Price", 2)
.withString("Dimensions", "8.5 x 11.0 x 0.5")
.withNumber("PageCount", 500)
.withBoolean("InPublication", true)
.withString("ProductCategory", "Book");
table.putItem(item);
item = new Item()
.withPrimaryKey("Id", 102)
.withString("Title", "Book 102 Title")
.withString("ISBN", "222-2222222222")
.withStringSet( "Authors", new HashSet<String>(
Arrays.asList("Author1", "Author2")))
.withNumber("Price", 20)
.withString("Dimensions", "8.5 x 11.0 x 0.8")
.withNumber("PageCount", 600)
.withBoolean("InPublication", true)
.withString("ProductCategory", "Book");
table.putItem(item);
item = new Item()
.withPrimaryKey("Id", 103)
.withString("Title", "Book 103 Title")
.withString("ISBN", "333-3333333333")
.withStringSet( "Authors", new HashSet<String>(
Arrays.asList("Author1", "Author2")))
// Intentional. Later we'll run Scan to find price error. Find
// items > 1000 in price.
.withNumber("Price", 2000)
.withString("Dimensions", "8.5 x 11.0 x 1.5")
.withNumber("PageCount", 600)
.withBoolean("InPublication", false)
.withString("ProductCategory", "Book");
table.putItem(item);
// Add bikes.
item = new Item()
.withPrimaryKey("Id", 201)
.withString("Title", "18-Bike-201")
// Size, followed by some title.
.withString("Description", "201 Description")
.withString("BicycleType", "Road")
.withString("Brand", "Mountain A")
// Trek, Specialized.
.withNumber("Price", 100)
.withString("Gender", "M")
// Men's
.withStringSet("Color", new HashSet<String>(
Arrays.asList("Red", "Black")))
.withString("ProductCategory", "Bicycle");
table.putItem(item);
item = new Item()
.withPrimaryKey("Id", 202)
.withString("Title", "21-Bike-202")
.withString("Description", "202 Description")
.withString("BicycleType", "Road")
.withString("Brand", "Brand-Company A")
.withNumber("Price", 200)
.withString("Gender", "M")
.withStringSet( "Color", new HashSet<String>(
Arrays.asList("Green", "Black")))
.withString("ProductCategory", "Bicycle");
table.putItem(item);
item = new Item()
.withPrimaryKey("Id", 203)
.withString("Title", "19-Bike-203")
.withString("Description", "203 Description")
.withString("BicycleType", "Road")
.withString("Brand", "Brand-Company B")
.withNumber("Price", 300)
.withString("Gender", "W")
// Women's
.withStringSet( "Color", new HashSet<String>(
Arrays.asList("Red", "Green", "Black")))
.withString("ProductCategory", "Bicycle");
table.putItem(item);
item = new Item()
.withPrimaryKey("Id", 204)
.withString("Title", "18-Bike-204")
.withString("Description", "204 Description")
.withString("BicycleType", "Mountain")
.withString("Brand", "Brand-Company B")
.withNumber("Price", 400)
.withString("Gender", "W")
.withStringSet("Color", new HashSet<String>(
Arrays.asList("Red")))
.withString("ProductCategory", "Bicycle");
table.putItem(item);
item = new Item()
.withPrimaryKey("Id", 205)
.withString("Title", "20-Bike-205")
.withString("Description", "205 Description")
.withString("BicycleType", "Hybrid")
.withString("Brand", "Brand-Company C")
.withNumber("Price", 500)
.withString("Gender", "B")
// Boy's
.withStringSet("Color", new HashSet<String>(
Arrays.asList("Red", "Black")))
.withString("ProductCategory", "Bicycle");
table.putItem(item);
} catch (Exception e) {
System.err.println("Failed to create item in " + tableName);
System.err.println(e.getMessage());
}
}
private static void loadSampleForums(String tableName) {
Table table = dynamoDB.getTable(tableName);
try {
System.out.println("Adding data to " + tableName);
Item item = new Item().withPrimaryKey("Name", "Amazon DynamoDB")
.withString("Category", "Amazon Web Services")
.withNumber("Threads", 2).withNumber("Messages", 4)
.withNumber("Views", 1000);
table.putItem(item);
item = new Item().withPrimaryKey("Name", "Amazon S3")
.withString("Category", "Amazon Web Services")
.withNumber("Threads", 0);
table.putItem(item);
} catch (Exception e) {
System.err.println("Failed to create item in " + tableName);
System.err.println(e.getMessage());
}
}
private static void loadSampleThreads(String tableName) {
try {
long time1 = (new Date()).getTime() - (7 * 24 * 60 * 60 * 1000);
// 7
// days
// ago
long time2 = (new Date()).getTime() - (14 * 24 * 60 * 60 * 1000);
// 14
// days
// ago
long time3 = (new Date()).getTime() - (21 * 24 * 60 * 60 * 1000);
// 21
// days
// ago
Date date1 = new Date();
date1.setTime(time1);
Date date2 = new Date();
date2.setTime(time2);
Date date3 = new Date();
date3.setTime(time3);
dateFormatter.setTimeZone(TimeZone.getTimeZone("UTC"));
Table table = dynamoDB.getTable(tableName);
System.out.println("Adding data to " + tableName);
Item item = new Item()
.withPrimaryKey("ForumName", "Amazon DynamoDB")
.withString("Subject", "DynamoDB Thread 1")
.withString("Message", "DynamoDB thread 1 message")
.withString("LastPostedBy", "User A")
.withString("LastPostedDateTime", dateFormatter.format(date2))
.withNumber("Views", 0)
.withNumber("Replies", 0)
.withNumber("Answered", 0)
.withStringSet( "Tags", new HashSet<String>(
Arrays.asList("index", "primarykey", "table")));
table.putItem(item);
item = new Item()
.withPrimaryKey("ForumName", "Amazon DynamoDB")
.withString("Subject", "DynamoDB Thread 2")
.withString("Message", "DynamoDB thread 2 message")
.withString("LastPostedBy", "User A")
.withString("LastPostedDateTime", dateFormatter.format(date3))
.withNumber("Views", 0)
.withNumber("Replies", 0)
.withNumber("Answered", 0)
.withStringSet( "Tags", new HashSet<String>(
Arrays.asList("index", "primarykey", "rangekey")));
table.putItem(item);
item = new Item()
.withPrimaryKey("ForumName", "Amazon S3")
.withString("Subject", "S3 Thread 1")
.withString("Message", "S3 Thread 3 message")
.withString("LastPostedBy", "User A")
.withString("LastPostedDateTime", dateFormatter.format(date1))
.withNumber("Views", 0)
.withNumber("Replies", 0)
.withNumber("Answered", 0)
.withStringSet( "Tags", new HashSet<String>(
Arrays.asList("largeobjects", "multipart upload")));
table.putItem(item);
} catch (Exception e) {
System.err.println("Failed to create item in " + tableName);
System.err.println(e.getMessage());
}
}
private static void loadSampleReplies(String tableName) {
try {
// 1 day ago
long time0 = (new Date()).getTime() - (1 * 24 * 60 * 60 * 1000);
// 7 days ago
long time1 = (new Date()).getTime() - (7 * 24 * 60 * 60 * 1000);
// 14 days ago
long time2 = (new Date()).getTime() - (14 * 24 * 60 * 60 * 1000);
// 21 days ago
long time3 = (new Date()).getTime() - (21 * 24 * 60 * 60 * 1000);
Date date0 = new Date();
date0.setTime(time0);
Date date1 = new Date();
date1.setTime(time1);
Date date2 = new Date();
date2.setTime(time2);
Date date3 = new Date();
date3.setTime(time3);
dateFormatter.setTimeZone(TimeZone.getTimeZone("UTC"));
Table table = dynamoDB.getTable(tableName);
System.out.println("Adding data to " + tableName);
// Add threads.
Item item = new Item()
.withPrimaryKey("Id", "Amazon DynamoDB#DynamoDB Thread 1")
.withString("ReplyDateTime", (dateFormatter.format(date3)))
.withString("Message", "DynamoDB Thread 1 Reply 1 text")
.withString("PostedBy", "User A");
table.putItem(item);
item = new Item()
.withPrimaryKey("Id", "Amazon DynamoDB#DynamoDB Thread 1")
.withString("ReplyDateTime", dateFormatter.format(date2))
.withString("Message", "DynamoDB Thread 1 Reply 2 text")
.withString("PostedBy", "User B");
table.putItem(item);
item = new Item()
.withPrimaryKey("Id", "Amazon DynamoDB#DynamoDB Thread 2")
.withString("ReplyDateTime", dateFormatter.format(date1))
.withString("Message", "DynamoDB Thread 2 Reply 1 text")
.withString("PostedBy", "User A");
table.putItem(item);
namespace com.amazonaws.codesamples
{
class CreateTablesLoadData
{
private static AmazonDynamoDBClient client = new AmazonDynamoDBClient();
try
{
//DeleteAllTables(client);
DeleteTable("ProductCatalog");
DeleteTable("Forum");
DeleteTable("Thread");
DeleteTable("Reply");
// Create tables (using the AWS SDK for .NET low-level API).
CreateTableProductCatalog();
CreateTableForum();
CreateTableThread(); // ForumTitle, Subject */
CreateTableReply();
{
try
{
var deleteTableResponse = client.DeleteTable(new DeleteTableRe
quest() { TableName = tableName });
WaitTillTableDeleted(client, tableName, deleteTableResponse);
}
catch (ResourceNotFoundException)
{
// There is no such table.
}
}
new KeySchemaElement
{
AttributeName = "Id",
KeyType = "HASH"
}
},
ProvisionedThroughput = new ProvisionedThroughput
{
ReadCapacityUnits = 10,
WriteCapacityUnits = 5
}
});
}
},
KeySchema = new List<KeySchemaElement>()
{
new KeySchemaElement
{
AttributeName = "Name", // forum Title
KeyType = "HASH"
}
},
ProvisionedThroughput = new ProvisionedThroughput
{
ReadCapacityUnits = 10,
WriteCapacityUnits = 5
}
});
new AttributeDefinition
{
AttributeName = "ForumName", // Hash attribute
AttributeType = "S"
},
new AttributeDefinition
{
AttributeName = "Subject",
AttributeType = "S"
}
},
KeySchema = new List<KeySchemaElement>()
{
new KeySchemaElement
{
AttributeName = "ForumName", // Hash attribute
KeyType = "HASH"
},
new KeySchemaElement
{
AttributeName = "Subject", // Range attribute
KeyType = "RANGE"
}
},
ProvisionedThroughput = new ProvisionedThroughput
{
ReadCapacityUnits = 10,
WriteCapacityUnits = 5
}
});
},
KeySchema = new List<KeySchemaElement>()
{
new KeySchemaElement()
{
AttributeName = "Id",
KeyType = "HASH"
},
new KeySchemaElement()
{
AttributeName = "ReplyDateTime",
KeyType = "RANGE"
}
},
LocalSecondaryIndexes = new List<LocalSecondaryIndex>()
{
new LocalSecondaryIndex()
{
IndexName = "PostedBy_index",
},
ProvisionedThroughput = new ProvisionedThroughput
{
ReadCapacityUnits = 10,
WriteCapacityUnits = 5
}
});
});
Console.WriteLine("Table name: {0}, status: {1}",
res.Table.TableName,
res.Table.TableStatus);
status = res.Table.TableStatus;
}
// Try-catch to handle potential eventual-consistency issue.
catch (ResourceNotFoundException)
{ }
}
}
res.Table.TableStatus);
status = res.Table.TableStatus;
}
}
catch (ResourceNotFoundException)
{
// Table deleted.
}
}
book1["PageCount"] = 500;
book1["InPublication"] = true;
book1["ProductCategory"] = "Book";
productCatalogTable.PutItem(book1);
book2["Id"] = 102;
book2["Title"] = "Book 102 Title";
book2["ISBN"] = "222-2222222222";
book2["Authors"] = new List<string> { "Author 1", "Author 2" }; ;
book2["Price"] = 20;
book2["Dimensions"] = "8.5 x 11.0 x 0.8";
book2["PageCount"] = 600;
book2["InPublication"] = true;
book2["ProductCategory"] = "Book";
productCatalogTable.PutItem(book2);
forumTable.PutItem(forum1);
forumTable.PutItem(forum2);
}
// Thread 1.
var thread1 = new Document();
thread1["ForumName"] = "Amazon DynamoDB"; // Hash attribute.
thread1["Subject"] = "DynamoDB Thread 1"; // Range attribute.
thread1["Message"] = "DynamoDB thread 1 message text";
thread1["LastPostedBy"] = "User A";
thread1["LastPostedDateTime"] = DateTime.UtcNow.Subtract(new
TimeSpan(14, 0, 0, 0));
thread1["Views"] = 0;
thread1["Replies"] = 0;
thread1["Answered"] = false;
thread1["Tags"] = new List<string> { "index", "primarykey", "table"
};
threadTable.PutItem(thread1);
// Thread 2.
var thread2 = new Document();
thread2["ForumName"] = "Amazon DynamoDB"; // Hash attribute.
thread2["Subject"] = "DynamoDB Thread 2"; // Range attribute.
thread2["Message"] = "DynamoDB thread 2 message text";
thread2["LastPostedBy"] = "User A";
thread2["LastPostedDateTime"] = DateTime.UtcNow.Subtract(new
TimeSpan(21, 0, 0, 0));
thread2["Views"] = 0;
thread2["Replies"] = 0;
thread2["Answered"] = false;
thread2["Tags"] = new List<string> { "index", "primarykey",
"rangekey" };
threadTable.PutItem(thread2);
// Thread 3.
var thread3 = new Document();
thread3["ForumName"] = "Amazon S3"; // Hash attribute.
thread3["Subject"] = "S3 Thread 1"; // Range attribute.
thread3["Message"] = "S3 thread 3 message text";
thread3["LastPostedBy"] = "User A";
thread3["LastPostedDateTime"] = DateTime.UtcNow.Subtract(new
TimeSpan(7, 0, 0, 0));
thread3["Views"] = 0;
thread3["Replies"] = 0;
thread3["Answered"] = false;
thread3["Tags"] = new List<string> { "largeobjects", "multipart
upload" };
threadTable.PutItem(thread3);
}
// Reply 1 - thread 1.
var thread1Reply1 = new Document();
thread1Reply1["Id"] = "Amazon DynamoDB#DynamoDB Thread 1"; // Hash
attribute.
thread1Reply1["ReplyDateTime"] = DateTime.UtcNow.Subtract(new
TimeSpan(21, 0, 0, 0)); // Range attribute.
thread1Reply1["Message"] = "DynamoDB Thread 1 Reply 1 text";
thread1Reply1["PostedBy"] = "User A";
replyTable.PutItem(thread1Reply1);
// Reply 2 - thread 1.
var thread1reply2 = new Document();
thread1reply2["Id"] = "Amazon DynamoDB#DynamoDB Thread 1"; // Hash
attribute.
thread1reply2["ReplyDateTime"] = DateTime.UtcNow.Subtract(new
TimeSpan(14, 0, 0, 0)); // Range attribute.
thread1reply2["Message"] = "DynamoDB Thread 1 Reply 2 text";
thread1reply2["PostedBy"] = "User B";
replyTable.PutItem(thread1reply2);
// Reply 3 - thread 1.
var thread1Reply3 = new Document();
thread1Reply3["Id"] = "Amazon DynamoDB#DynamoDB Thread 1"; // Hash
attribute.
thread1Reply3["ReplyDateTime"] = DateTime.UtcNow.Subtract(new
TimeSpan(7, 0, 0, 0)); // Range attribute.
thread1Reply3["Message"] = "DynamoDB Thread 1 Reply 3 text";
thread1Reply3["PostedBy"] = "User B";
replyTable.PutItem(thread1Reply3);
// Reply 1 - thread 2.
var thread2Reply1 = new Document();
thread2Reply1["Id"] = "Amazon DynamoDB#DynamoDB Thread 2"; // Hash
attribute.
thread2Reply1["ReplyDateTime"] = DateTime.UtcNow.Subtract(new
TimeSpan(7, 0, 0, 0)); // Range attribute.
thread2Reply1["Message"] = "DynamoDB Thread 2 Reply 1 text";
replyTable.PutItem(thread2Reply1);
// Reply 2 - thread 2.
var thread2Reply2 = new Document();
thread2Reply2["Id"] = "Amazon DynamoDB#DynamoDB Thread 2"; // Hash
attribute.
thread2Reply2["ReplyDateTime"] = DateTime.UtcNow.Subtract(new
TimeSpan(1, 0, 0, 0)); // Range attribute.
thread2Reply2["Message"] = "DynamoDB Thread 2 Reply 2 text";
thread2Reply2["PostedBy"] = "User A";
replyTable.PutItem(thread2Reply2);
}
}
}
$response = $client->createTable(array(
'TableName' => $tableName,
'AttributeDefinitions' => array(
array(
'AttributeName' => 'Id',
'AttributeType' => 'N'
)
),
'KeySchema' => array(
array(
'AttributeName' => 'Id',
'KeyType' => 'HASH'
)
),
'ProvisionedThroughput' => array(
'ReadCapacityUnits'
=> 10,
'WriteCapacityUnits' => 5
)
));
$tableNames[] = $tableName;
$tableName = 'Forum';
echo "Creating table $tableName..." . PHP_EOL;
$response = $client->createTable(array(
'TableName' => $tableName,
'AttributeDefinitions' => array(
array(
'AttributeName' => 'Name',
'AttributeType' => 'S'
)
),
'KeySchema' => array(
array(
'AttributeName' => 'Name',
'KeyType' => 'HASH'
)
),
'ProvisionedThroughput' => array(
'ReadCapacityUnits'
=> 10,
'WriteCapacityUnits' => 5
)
));
$tableNames[] = $tableName;
$tableName = 'Thread';
echo "Creating table $tableName..." . PHP_EOL;
$response = $client->createTable(array(
'TableName' => $tableName,
'AttributeDefinitions' => array(
array(
'AttributeName' => 'ForumName',
'AttributeType' => 'S'
),
array(
'AttributeName' => 'Subject',
array(
'AttributeName' => 'Id',
'KeyType' => 'HASH'
),
array(
'AttributeName' => 'ReplyDateTime',
'KeyType' => 'RANGE'
)
),
'ProvisionedThroughput' => array(
'ReadCapacityUnits'
=> 10,
'WriteCapacityUnits' => 5
)
));
$tableNames[] = $tableName;
foreach($tableNames as $tableName) {
echo "Waiting for table $tableName to be created." . PHP_EOL;
$client->waitUntilTableExists(array('TableName' => $tableName));
echo "Table $tableName has been created." . PHP_EOL;
}
?>
The following PHP code example uploads data to the tables. The resulting table structure and data is
shown in Example Tables and Data (p. 678).
<?php
use Aws\DynamoDb\DynamoDbClient;
$client = DynamoDbClient::factory(array(
'profile' => 'default',
'region' => 'us-west-2' // replace with your desired region
));
# Setup some local variables for dates
date_default_timezone_set('UTC');
$oneDayAgo = date('Y-m-d H:i:s', strtotime('-1 days'));
$sevenDaysAgo = date('Y-m-d H:i:s', strtotime('-7 days'));
$fourteenDaysAgo = date('Y-m-d H:i:s', strtotime('-14 days'));
$twentyOneDaysAgo = date('Y-m-d H:i:s', strtotime('-21 days'));
$tableName = 'ProductCatalog';
echo "Adding data to the $tableName table..." . PHP_EOL;
$response = $client->batchWriteItem(array(
'RequestItems' => array(
$tableName => array(
array(
'PutRequest' => array(
'Item' => array(
'Id'
=> array('N' => '1101'),
'Title'
=> array('S' => 'Book 101 Title'),
'ISBN'
=> array('S' => '111-1111111111'),
'Authors'
'Price'
'Dimensions'
'PageCount'
=> array('N' => '500'),
'InPublication'
=> array('N' => '1'),
'ProductCategory' => array('S' => 'Book')
)
),
),
array(
'PutRequest' => array(
'Item' => array(
'Id'
'Title'
'ISBN'
'Authors'
=>
=>
=>
=>
'Author2')),
'Price'
'Dimensions'
'PageCount'
=> array('N' => '600'),
'InPublication'
=> array('N' => '1'),
'ProductCategory' => array('S' => 'Book')
)
),
),
array(
'PutRequest' => array(
'Item' => array(
'Id'
'Title'
'ISBN'
'Authors'
=>
=>
=>
=>
'Author2')),
'Price'
'Dimensions'
'PageCount'
=> array('N' => '600'),
'InPublication'
=> array('N' => '0'),
'ProductCategory' => array('S' => 'Book')
)
),
),
array(
'PutRequest' => array(
'Item' => array(
'Id'
'Title'
'Description'
'BicycleType'
'Brand'
'Price'
'Gender'
'Color'
'Black')),
'ProductCategory' => array('S' => 'Bicycle')
)
),
),
array(
'PutRequest' => array(
'Item' => array(
'Id'
'Title'
'Description'
'BicycleType'
'Brand'
'Price'
'Gender'
'Color'
'Black')),
'ProductCategory' => array('S' => 'Bicycle')
)
),
),
array(
'PutRequest' => array(
'Item' => array(
'Id'
'Title'
'Description'
'BicycleType'
'Brand'
'Price'
'Gender'
'Color'
'Black')),
'ProductCategory' => array('S' => 'Bicycle')
)
),
),
array(
'PutRequest' => array(
'Item' => array(
'Id'
'Title'
'Description'
'BicycleType'
'Brand'
'Price'
'Gender'
'Color'
'ProductCategory'
=>
=>
=>
=>
),
),
array(
'PutRequest' => array(
'Item' => array(
'Id'
'Title'
'Description'
'BicycleType'
'Brand'
'Price'
'Gender'
'Color'
=>
=>
=>
=>
=>
=>
=>
=>
'Black')),
'ProductCategory' => array('S' => 'Bicycle')
)
)
)
),
),
));
echo "done." . PHP_EOL;
$tableName = 'Forum';
echo "Adding data to the $tableName table..." . PHP_EOL;
$response = $client->batchWriteItem(array(
'RequestItems' => array(
$tableName => array(
array(
'PutRequest' => array(
'Item' => array(
'Name'
=> array('S'
'Category' => array('S'
'Threads' => array('N'
'Messages' => array('N'
'Views'
=> array('N'
)
)
),
array(
'PutRequest' => array(
'Item' => array(
'Name'
=> array('S'
'Category' => array('S'
'Threads' => array('N'
)
)
),
)
)
));
echo "done." . PHP_EOL;
=>
=>
=>
=>
=>
'Amazon DynamoDB'),
'Amazon Web Services'),
'0'),
'0'),
'1000')
$tableName = 'Reply';
echo "Adding data to the $tableName table..." . PHP_EOL;
$response = $client->batchWriteItem(array(
'RequestItems' => array(
$tableName => array(
array(
'PutRequest' => array(
'Item' => array(
'Id'
=> array('S' => 'Amazon DynamoDB#DynamoDB
Thread 1'),
'ReplyDateTime' => array('S' => $fourteenDaysAgo),
'Message'
=> array('S' => 'DynamoDB Thread 1 Reply
2 text'),
'PostedBy'
=> array('S' => 'User B')
)
)
),
array(
'PutRequest' => array(
'Item' => array(
'Id'
=> array('S' => 'Amazon DynamoDB#DynamoDB
Thread 2'),
'ReplyDateTime' => array('S' => $twentyOneDaysAgo),
'Message'
=> array('S' => 'DynamoDB Thread 2 Reply
3 text'),
'PostedBy'
=> array('S' => 'User B')
)
)
),
array(
'PutRequest' => array(
'Item' => array(
'Id'
=> array('S' => 'Amazon DynamoDB#DynamoDB
Thread 2'),
'ReplyDateTime' => array('S' => $sevenDaysAgo),
'Message'
=> array('S' => 'DynamoDB Thread 2 Reply
2 text'),
'PostedBy'
=> array('S' => 'User A')
)
)
),
array(
'PutRequest' => array(
'Item' => array(
'Id'
=> array('S' => 'Amazon DynamoDB#DynamoDB
Thread 2'),
'ReplyDateTime' => array('S' => $oneDayAgo),
'Message'
=> array('S' => 'DynamoDB Thread 2 Reply
1 text'),
'PostedBy'
=> array('S' => 'User A')
)
)
)
),
)
));
echo "done." . PHP_EOL;
?>
ABORT
ABSOLUTE
ACTION
ADD
AFTER
AGENT
AGGREGATE
ALL
ALLOCATE
ALTER
ANALYZE
AND
ANY
ARCHIVE
ARE
ARRAY
AS
ASC
ASCII
ASENSITIVE
ASSERTION
ASYMMETRIC
AT
ATOMIC
ATTACH
ATTRIBUTE
AUTH
AUTHORIZATION
AUTHORIZE
AUTO
AVG
BACK
BACKUP
BASE
BATCH
BEFORE
BEGIN
BETWEEN
BIGINT
BINARY
BIT
BLOB
BLOCK
BOOLEAN
BOTH
BREADTH
BUCKET
BULK
BY
BYTE
CALL
CALLED
CALLING
CAPACITY
CASCADE
CASCADED
CASE
CAST
CATALOG
CHAR
CHARACTER
CHECK
CLASS
CLOB
CLOSE
CLUSTER
CLUSTERED
CLUSTERING
CLUSTERS
COALESCE
COLLATE
COLLATION
COLLECTION
COLUMN
COLUMNS
COMBINE
COMMENT
COMMIT
COMPACT
COMPILE
COMPRESS
CONDITION
CONFLICT
CONNECT
CONNECTION
CONSISTENCY
CONSISTENT
CONSTRAINT
CONSTRAINTS
CONSTRUCTOR
CONSUMED
CONTINUE
CONVERT
COPY
CORRESPONDING
COUNT
COUNTER
CREATE
CROSS
CUBE
CURRENT
CURSOR
CYCLE
DATA
DATABASE
DATE
DATETIME
DAY
DEALLOCATE
DEC
DECIMAL
DECLARE
DEFAULT
DEFERRABLE
DEFERRED
DEFINE
DEFINED
DEFINITION
DELETE
DELIMITED
DEPTH
DEREF
DESC
DESCRIBE
DESCRIPTOR
DETACH
DETERMINISTIC
DIAGNOSTICS
DIRECTORIES
DISABLE
DISCONNECT
DISTINCT
DISTRIBUTE
DO
DOMAIN
DOUBLE
DROP
DUMP
DURATION
DYNAMIC
EACH
ELEMENT
ELSE
ELSEIF
EMPTY
ENABLE
END
EQUAL
EQUALS
ERROR
ESCAPE
ESCAPED
EVAL
EVALUATE
EXCEEDED
EXCEPT
EXCEPTION
EXCEPTIONS
EXCLUSIVE
EXEC
EXECUTE
EXISTS
EXIT
EXPLAIN
EXPLODE
EXPORT
EXPRESSION
EXTENDED
EXTERNAL
EXTRACT
FAIL
FALSE
FAMILY
FETCH
FIELDS
FILE
FILTER
FILTERING
FINAL
FINISH
FIRST
FIXED
FLATTERN
FLOAT
FOR
FORCE
FOREIGN
FORMAT
FORWARD
FOUND
FREE
FROM
FULL
FUNCTION
FUNCTIONS
GENERAL
GENERATE
GET
GLOB
GLOBAL
GO
GOTO
GRANT
GREATER
GROUP
GROUPING
HANDLER
HASH
HAVE
HAVING
HEAP
HIDDEN
HOLD
HOUR
IDENTIFIED
IDENTITY
IF
IGNORE
IMMEDIATE
IMPORT
IN
INCLUDING
INCLUSIVE
INCREMENT
INCREMENTAL
INDEX
INDEXED
INDEXES
INDICATOR
INFINITE
INITIALLY
INLINE
INNER
INNTER
INOUT
INPUT
INSENSITIVE
INSERT
INSTEAD
INT
INTEGER
INTERSECT
INTERVAL
INTO
INVALIDATE
IS
ISOLATION
ITEM
ITEMS
ITERATE
JOIN
KEY
KEYS
LAG
LANGUAGE
LARGE
LAST
LATERAL
LEAD
LEADING
LEAVE
LEFT
LENGTH
LESS
LEVEL
LIKE
LIMIT
LIMITED
LINES
LIST
LOAD
LOCAL
LOCALTIME
LOCALTIMESTAMP
LOCATION
LOCATOR
LOCK
LOCKS
LOG
LOGED
LONG
LOOP
LOWER
MAP
MATCH
MATERIALIZED
MAX
MAXLEN
MEMBER
MERGE
METHOD
METRICS
MIN
MINUS
MINUTE
MISSING
MOD
MODE
MODIFIES
MODIFY
MODULE
MONTH
MULTI
MULTISET
NAME
NAMES
NATIONAL
NATURAL
NCHAR
NCLOB
NEW
NEXT
NO
NONE
NOT
NULL
NULLIF
NUMBER
NUMERIC
OBJECT
OF
OFFLINE
OFFSET
OLD
ON
ONLINE
ONLY
OPAQUE
OPEN
OPERATOR
OPTION
OR
ORDER
ORDINALITY
OTHER
OTHERS
OUT
OUTER
OUTPUT
OVER
OVERLAPS
OVERRIDE
OWNER
PAD
PARALLEL
PARAMETER
PARAMETERS
PARTIAL
PARTITION
PARTITIONED
PARTITIONS
PATH
PERCENT
PERCENTILE
PERMISSION
PERMISSIONS
PIPE
PIPELINED
PLAN
POOL
POSITION
PRECISION
PREPARE
PRESERVE
PRIMARY
PRIOR
PRIVATE
PRIVILEGES
PROCEDURE
PROCESSED
PROJECT
PROJECTION
PROPERTY
PROVISIONING
PUBLIC
PUT
QUERY
QUIT
QUORUM
RAISE
RANDOM
RANGE
RANK
RAW
READ
READS
REAL
REBUILD
RECORD
RECURSIVE
REDUCE
REF
REFERENCE
REFERENCES
REFERENCING
REGEXP
REGION
REINDEX
RELATIVE
RELEASE
REMAINDER
RENAME
REPEAT
REPLACE
REQUEST
RESET
RESIGNAL
RESOURCE
RESPONSE
RESTORE
RESTRICT
RESULT
RETURN
RETURNING
RETURNS
REVERSE
REVOKE
RIGHT
ROLE
ROLES
ROLLBACK
ROLLUP
ROUTINE
ROW
ROWS
RULE
RULES
SAMPLE
SATISFIES
SAVE
SAVEPOINT
SCAN
SCHEMA
SCOPE
SCROLL
SEARCH
SECOND
SECTION
SEGMENT
SEGMENTS
SELECT
SELF
SEMI
SENSITIVE
SEPARATE
SEQUENCE
SERIALIZABLE
SESSION
SET
SETS
SHARD
SHARE
SHARED
SHORT
SHOW
SIGNAL
SIMILAR
SIZE
SKEWED
SMALLINT
SNAPSHOT
SOME
SOURCE
SPACE
SPACES
SPARSE
SPECIFIC
SPECIFICTYPE
SPLIT
SQL
SQLCODE
SQLERROR
SQLEXCEPTION
SQLSTATE
SQLWARNING
START
STATE
STATIC
STATUS
STORAGE
STORE
STORED
STREAM
STRING
STRUCT
STYLE
SUB
SUBMULTISET
SUBPARTITION
SUBSTRING
SUBTYPE
SUM
SUPER
SYMMETRIC
SYNONYM
SYSTEM
TABLE
TABLESAMPLE
TEMP
TEMPORARY
TERMINATED
TEXT
THAN
THEN
THROUGHPUT
TIME
TIMESTAMP
TIMEZONE
TINYINT
TO
TOKEN
TOTAL
TOUCH
TRAILING
TRANSACTION
TRANSFORM
TRANSLATE
TRANSLATION
TREAT
TRIGGER
TRIM
TRUE
TRUNCATE
TTL
TUPLE
TYPE
UNDER
UNDO
UNION
UNIQUE
UNIT
UNKNOWN
UNLOGGED
UNNEST
UNPROCESSED
UNSIGNED
UNTIL
UPDATE
UPPER
URL
USAGE
USE
USER
USERS
USING
UUID
VACUUM
VALUE
VALUED
VALUES
VARCHAR
VARIABLE
VARIANCE
VARINT
VARYING
VIEW
VIEWS
VIRTUAL
VOID
WAIT
WHEN
WHENEVER
WHERE
WHILE
WINDOW
WITH
WITHIN
WITHOUT
WORK
WRAPPED
WRITE
YEAR
ZONE
Note
New applications should use expression parameters. For more information, see Reading and
Writing Items Using Expressions (p. 98).
The following table shows the legacy conditional parameters, and the expression parameters
that have superseded them:
Legacy Conditional
Parameter
Expression Parameter
AttributesToGet
ProjectionExpression
Expected
ConditionExpresssion
AttributeUpdates
UpdateExpression
KeyConditions
KeyConditionExpression
DynamoDB does not allow mixing legacy conditional parameters and expression parameters in
a single API call. For example, calling the Query API with AttributesToGet and
ConditionExpression will result in an error.
Note
New applications should use expression parameters instead. For more information, see Reading
and Writing Items Using Expressions (p. 98).
Simple Conditions
With attribute values, you can write conditions for comparisons against table attributes. A condition always
evaluates to true or false, and consists of:
ComparisonOperator greater than, less than, equal to, and so on.
AttributeValueList (optional) attribute value(s) to compare against. Depending on the
ComparisonOperator being used, the AttributeValueList might contain one, two, or more
values; or it might not be present at all.
The following sections describe the various comparison operators, along with examples of how to use
them in conditions.
AttributeValueList can contain only one value of type String, Number, or Binary (not a set). If an
item contains an AttributeValue of a different type than the one specified in the request, the value
does not match.
CONTAINS - true if a value is present within a set, or if one value contains another.
AttributeValueList can contain only one value of type String, Number, or Binary (not a set). If the
target attribute of the comparison is a String, then the operator checks for a substring match. If the
target attribute of the comparison is Binary, then the operator looks for a subsequence of the target
that matches the input. If the target attribute of the comparison is a set, then the operator evaluates to
true if it finds an exact match with any member of the set.
NOT_CONTAINS - true if a value is not present within a set, or if one value does not contain another
value.
AttributeValueList can contain only one value of type String, Number, or Binary (not a set). If the
target attribute of the comparison is a String, then the operator checks for the absence of a substring
match. If the target attribute of the comparison is Binary, then the operator checks for the absence of
a subsequence of the target that matches the input. If the target attribute of the comparison is a set,
then the operator evaluates to true if it does not find an exact match with any member of the set.
BEGINS_WITH - true if the first few characters of an attribute match the provided value. Do not use this
operator for comparing numbers.
AttributeValueList can contain only one value of type String or Binary (not a Number or a set).
The target attribute of the comparison must be a String or Binary (not a Number or a set).
Use these operators to compare an attribute with a value. You must specify an AttributeValueList
consisting of a single value. For most of the operators, this value must be a scalar; however, the EQ and
NE operators also support sets.
Examples
The following expressions evaluate to true if:
A product's price is greater than 100.
{
Price: {
ComparisonOperator: GT,
AttributeValueList: [ 100 ]
}
}
{
ProductCategory: {
ComparisonOperator: BEGINS_WITH,
AttributeValueList: [ "Bo" ]
}
}
Note
When comparing set data types, the order of the elements does not matter. DynamoDB will
return only the items with the same set of values, regardless of the order in which you specify
them in your request.
Use this operator to determine if an attribute value is within a range. The AttributeValueList must
contain two scalar elements of the same type - String, Number, or Binary.
Example
The following expression evaluates to true if a product's price is between 100 and 200.
{
Price: {
ComparisonOperator: BETWEEN,
AttributeValueList: [ 100, 200 ]
}
}
AttributeValueList can contain one or more values of type String, Number, or Binary (not a set).
The target attribute of the comparison must be of the same type and exact value to match. A String
never matches a String set.
Use this operator to determine whether the supplied value is within an enumerated list. You can specify
any number of scalar values in AttributeValueList, but they all must be of the same data type.
Example
The following expression evaluates to true if the value for Id is 201, 203, or 205.
{
Id: {
ComparisonOperator: IN,
AttributeValueList: [ 201, 203, 205 ]
}
}
EQ,
[ "Book" ]
GE,
[ 600 ]
You can use ConditionalOperator to clarify that an AND operation will take place. The following
example behaves in the same manner as the previous one.
{
ConditionalOperator : AND,
ProductCategory: {
ComparisonOperator: EQ,
AttributeValueList: [ "Book" ]
},
PageCount: {
ComparisonOperator: GE,
AttributeValueList: [ 600 ]
}
}
You can also set ConditionalOperator to OR, which means that at least one of the conditions must
evaluate to true.
Example
The following expression evaluates to true if a product is a mountain bike, if it is a particular brand name,
or if its price is greater than 100.
{
ConditionalOperator : OR,
BicycleType: {
ComparisonOperator: EQ,
AttributeValueList: [ "Mountain" ]
},
Brand: {
ComparisonOperator: EQ,
AttributeValueList: [ "Brand-Company A" ]
},
Price: {
ComparisonOperator: GT,
AttributeValueList: [ 100 ]
}
}
Note
In a complex expression, the conditions are processed in order, from the first condition to the
last.
You cannot use both AND and OR in a single expression.
Example
A DeleteItem can check to see whether a book is no longer in publication, and only delete it if this
condition is true. Here is an example using a legacy condition:
{
TableName: "Product",
Item: {
Id: 600,
Title: "Book 600 Title"
},
Expected: {
InPublication: {
Exists: true,
Value : false
}
}
}
The following example does the same thing, but does not use a legacy condition:
{
TableName: "Product",
Item: {
Id: 600,
Title: "Book 600 Title"
},
Expected: {
InPublication: {
ComparisonOperator: EQ,
AttributeValueList: [ false ]
}
}
}
Example
A PutItem operation can protect against overwriting an existing item with the same primary key attributes.
Here is an example using a legacy condition:
{
TableName: "Product",
Item: {
Id: 500,
Title: "Book 500 Title"
},
Expected: {
Id: {
Exists: false
}
}
}
The following example does the same thing, but does not use a legacy condition:
{
TableName: "Product",
Item: {
Id: 500,
Title: "Book 500 Title"
},
Expected: {
Id: {
ComparisonOperator: NULL
}
}
}
Note
For conditions in the Expected map, do not use the legacy Value and Exists options together
with ComparisonOperator and AttributeValueList. If you do this, your conditional write
will fail.
BatchWriteItem
CreateTable
DeleteItem
DeleteTable
DescribeTable
GetItem
ListTables
API Version 2012-08-10
736
PutItem
Query
Scan
UpdateItem
UpdateTable
BatchGetItem
Important
This section refers to the previous API version (2011-12-05). For the most recent API version,
go to the Amazon DynamoDB API Reference.
Description
The BatchGetItem operation returns the attributes for multiple items from multiple tables using their
primary keys. The maximum number of items that can be retrieved for a single operation is 100. Also,
the number of items retrieved is constrained by a 1 MB size limit. If the response size limit is exceeded
or a partial result is returned because the tables provisioned throughput is exceeded, or because of an
internal processing failure, DynamoDB returns an UnprocessedKeys value so you can retry the operation
starting with the next item to get. DynamoDB automatically adjusts the number of items returned per page
to enforce this limit. For example, even if you ask to retrieve 100 items, but each individual item is 50 KB
in size, the system returns 20 items and an appropriate UnprocessedKeys value so you can get the
next page of results. If desired, your application can include its own logic to assemble the pages of results
into one set.
If no items could be processed because of insufficient provisioned throughput on each of the tables
involved in the request, DynamoDB returns a ProvisionedThroughputExceededException error.
Note
By default, BatchGetItem performs eventually consistent reads on every table in the request.
You can set the ConsistentRead parameter to true, on a per-table basis, if you want consistent
reads instead.
BatchGetItem fetches items in parallel to minimize response latencies.
When designing your application, keep in mind that DynamoDB does not guarantee how attributes
are ordered in the returned response. Include the primary key values in the AttributesToGet
for the items in your request to help parse the response by item.
If the requested items do not exist, nothing is returned in the response for those items. Requests
for non-existent items consume the minimum read capacity units according to the type of read.
For more information, see Capacity Units Calculations for Various Operations (p. 64).
Requests
Syntax
// This header is abbreviated. For a sample of a complete header, see Sample
DynamoDB JSON Request and Response (p. 517).
POST / HTTP/1.1
x-amz-target: DynamoDB_20111205.BatchGetItem
content-type: application/x-amz-json-1.0
{"RequestItems":
{"Table1":
{"Keys":
[{"HashKeyElement": {"S":"KeyValue1"}, "RangeKeyElement":{"N":"Key
Value2"}},
{"HashKeyElement": {"S":"KeyValue3"}, "RangeKeyElement":{"N":"Key
Value4"}},
{"HashKeyElement": {"S":"KeyValue5"}, "RangeKeyElement":{"N":"Key
Value6"}}],
"AttributesToGet":["AttributeName1", "AttributeName2", "Attribute
Name3"]},
"Table2":
{"Keys":
[{"HashKeyElement": {"S":"KeyValue4"}},
{"HashKeyElement": {"S":"KeyValue5"}}],
"AttributesToGet": ["AttributeName4", "AttributeName5", "AttributeName6"]
}
}
}
Name
Description
RequestItems
Required
Name
Description
Required
Table
Table:Keys
Table:AttributesToGet
Table:ConsistentRead
Responses
Syntax
HTTP/1.1 200
x-amzn-RequestId: 8966d095-71e9-11e0-a498-71d736f27375
content-type: application/x-amz-json-1.0
content-length: 855
{"Responses":
{"Table1":
{"Items":
[{"AttributeName1": {"S":"AttributeValue"},
"AttributeName2": {"N":"AttributeValue"},
"AttributeName3": {"SS":["AttributeValue", "AttributeValue", "Attribute
Value"]}
},
{"AttributeName1": {"S": "AttributeValue"},
"AttributeName2": {"S": "AttributeValue"},
"AttributeName3": {"NS": ["AttributeValue", "AttributeValue", "Attrib
uteValue"]}
}],
"ConsumedCapacityUnits":1},
"Table2":
{"Items":
[{"AttributeName1": {"S":"AttributeValue"},
"AttributeName2": {"N":"AttributeValue"},
"AttributeName3": {"SS":["AttributeValue", "AttributeValue", "Attribute
Value"]}
},
Name
Description
Responses
Table
Items
ConsumedCapacityUnits
UnprocessedKeys
Name
Description
Attribute names within the specified table. If attribute names are not specified then all attributes will
be returned. If some attributes are not found, they
will not appear in the result.
Type: Array of attribute names.
Special Errors
Error
Description
Examples
The following examples show an HTTP POST request and response using the BatchGetItem operation.
For examples using the AWS SDK, see Working with Items in DynamoDB (p. 92).
Sample Request
The following sample requests attributes from two different tables.
// This header is abbreviated.
// For a sample of a complete header, see Sample DynamoDB JSON Request and Re
sponse (p. 517).
POST / HTTP/1.1
x-amz-target: DynamoDB_20111205.BatchGetItem
content-type: application/x-amz-json-1.0
content-length: 409
{"RequestItems":
{"comp2":
{"Keys":
[{"HashKeyElement":{"S":"Julie"}},{"HashKeyElement":{"S":"Mingus"}}],
"AttributesToGet":["user","friends"]},
"comp1":
{"Keys":
[{"HashKeyElement":{"S":"Casey"},"RangeKeyEle
ment":{"N":"1319509152"}},
{"HashKeyElement":{"S":"Dave"},"RangeKeyElement":{"N":"1319509155"}},
{"HashKeyElement":{"S":"Riley"},"RangeKeyEle
ment":{"N":"1319509158"}}],
"AttributesToGet":["user","status"]}
}
}
Sample Response
The following sample is the response.
HTTP/1.1 200 OK
x-amzn-RequestId: GTPQVRM4VJS792J1UFJTKUBVV4KQNSO5AEMVJF66Q9ASUAAJG
content-type: application/x-amz-json-1.0
content-length: 373
Date: Fri, 02 Sep 2011 23:07:39 GMT
{"Responses":
{"comp2":
{"Items":
[{"status":{"S":"online"},"user":{"S":"Casey"}},
{"status":{"S":"working"},"user":{"S":"Riley"}},
{"status":{"S":"running"},"user":{"S":"Dave"}}],
"ConsumedCapacityUnits":1.5},
"comp2":
{"Items":
[{"friends":{"SS":["Elisabeth", "Peter"]},"user":{"S":"Mingus"}},
{"friends":{"SS":["Dave", "Peter"]},"user":{"S":"Julie"}}],
"ConsumedCapacityUnits":1}
},
"UnprocessedKeys":{}
}
BatchWriteItem
Important
This section refers to the previous API version (2011-12-05). For the most recent API version,
go to the Amazon DynamoDB API Reference.
Description
This operation enables you to put or delete several items across multiple tables in a single API call.
To upload one item, you can use the PutItem API and to delete one item, you can use the DeleteItem
API. However, when you want to upload or delete large amounts of data, such as uploading large amounts
of data from Amazon Elastic MapReduce (Amazon EMR) or migrate data from another database in to
DynamoDB, this API offers an efficient alternative.
If you use languages such as Java, you can use threads to upload items in parallel. This adds complexity
in your application to handle the threads. Other languages don't support threading. For example, if you
are using PHP, you must upload or delete items one at a time. In both situations, the BatchWriteItem
API provides an alternative where the API performs the specified put and delete operations in parallel,
giving you the power of the thread pool approach without having to introduce complexity in your application.
Note that each individual put and delete specified in a BatchWriteItem operation costs the same in
terms of consumed capacity units, however, the API performs the specified operations in parallel giving
you lower latency. Delete operations on non-existent items consume 1 write capacity unit. For more
information about consumed capacity units, see Working with Tables in DynamoDB (p. 61).
When using this API, note the following limitations:
Maximum operations in a single requestYou can specify a total of up to 25 put or delete operations;
however, the total request size cannot exceed 1 MB (the HTTP payload).
You can use the BatchWriteItem operation only to put and delete items. You cannot use it to update
existing items.
Not an atomic operationIndividual operations specified in a BatchWriteItem are atomic; however
BatchWriteItem as a whole is a "best-effort" operation and not an atomic operation. That is, in a
BatchWriteItem request, some operations might succeed and others might fail.The failed operations
are returned in an UnprocessedItems field in the response. Some of these failures might be because
you exceeded the provisioned throughput configured for the table or a transient failure such as a network
error. You can investigate and optionally resend the requests. Typically, you call BatchWriteItem in
a loop and in each iteration check for unprocessed items, and submit a new BatchWriteItem request
with those unprocessed items.
Does not return any itemsThe BatchWriteItem is designed for uploading large amounts of data
efficiently. It does not provide some of the sophistication offered by APIs such as PutItem and
DeleteItem. For example, the DeleteItem API supports the ReturnValues field in your request
body to request the deleted item in the response. The BatchWriteItem operation does not return
any items in the response.
Unlike the PutItem and DeleteItem APIs, BatchWriteItem does not allow you to specify conditions
on individual write requests in the operation.
Attribute values must not be null; string and binary type attributes must have lengths greater than zero;
and set type attributes must not be empty. Requests that have empty values will be rejected with a
ValidationException.
DynamoDB rejects the entire batch write operation if any one of the following is true:
If one or more tables specified in the BatchWriteItem request does not exist.
If primary key attributes specified on an item in the request does not match the corresponding table's
primary key schema.
If you try to perform multiple operations on the same item in the same BatchWriteItem request. For
example, you cannot put and delete the same item in the same BatchWriteItem request.
If the total request size exceeds the 1 MB request size (the HTTP payload) limit.
If any individual item in a batch exceeds the 64 KB item size limit.
Requests
Syntax
// This header is abbreviated. For a sample of a complete header, see Sample
DynamoDB JSON Request and Response (p. 517).
POST / HTTP/1.1
x-amz-target: DynamoDB_20111205.BatchGetItem
content-type: application/x-amz-json-1.0
{
"RequestItems" :
RequestItems
RequestItems
{
"TableName1" :
"TableName2" :
...
}
Request ::=
PutRequest | DeleteRequest
PutRequest ::=
{
"PutRequest" : {
"Item" : {
"Attribute-Name1" : Attribute-Value,
"Attribute-Name2" : Attribute-Value,
...
}
}
}
DeleteRequest ::=
{
"DeleteRequest" : {
"Key" : PrimaryKey-Value
}
}
Numeric ::=
{
"N": "Number"
}
String ::=
{
"S": "String"
}
Binary ::=
{
In the request body, the RequestItems JSON object describes the operations that you want to perform.
The operations are grouped by tables.You can use the BatchWriteItem API to update or delete several
items across multiple tables. For each specific write request, you must identify the type of request
(PutItem, DeleteItem) followed by detail information about the operation.
For a PutRequest, you provide the item, that is, a list of attributes and their values.
For a DeleteRequest, you provide the primary key name and value.
Responses
Syntax
The following is the syntax of the JSON body returned in the response.
{
"Responses" :
"UnprocessedItems" :
ConsumedCapacityUnitsByTable
RequestItems
}
ConsumedCapacityUnitsByTable
{
"TableName1" : { "ConsumedCapacityUnits", : NumericValue },
"TableName2" : { "ConsumedCapacityUnits", : NumericValue },
...
}
RequestItems
This syntax is identical to the one described in the JSON syntax in the request.
Special Errors
No errors specific to this API.
Examples
The following example shows an HTTP POST request and the response of a BatchWriteItem operation.
The request specifies the following operations on the Reply and the Thread tables:
Put an item and delete an item from the Reply table
Put an item into the Thread table
For examples using the AWS SDK, see Working with Items in DynamoDB (p. 92).
Sample Request
// This header is abbreviated. For a sample of a complete header, see Sample
DynamoDB JSON Request and Response (p. 517).
POST / HTTP/1.1
x-amz-target: DynamoDB_20111205.BatchGetItem
content-type: application/x-amz-json-1.0
{
"RequestItems":{
"Reply":[
{
"PutRequest":{
"Item":{
"ReplyDateTime":{
"S":"2012-04-03T11:04:47.034Z"
},
"Id":{
"S":"DynamoDB#DynamoDB Thread 5"
}
}
}
},
{
"DeleteRequest":{
"Key":{
"HashKeyElement":{
"S":"DynamoDB#DynamoDB Thread 4"
},
"RangeKeyElement":{
"S":"oops - accidental row"
}
}
}
}
],
"Thread":[
{
"PutRequest":{
"Item":{
"ForumName":{
"S":"DynamoDB"
},
"Subject":{
"S":"DynamoDB Thread 5"
}
}
}
}
]
}
}
Sample Response
The following example response shows a put operation on both the Thread and Reply tables succeeded
and a delete operation on the Reply table failed (for reasons such as throttling that is caused when you
exceed the provisioned throughput on the table). Note the following in the JSON response:
The Responses object shows one capacity unit was consumed on both the Thread and Reply tables
as a result of the successful put operation on each of these tables.
The UnprocessedItems object shows the unsuccessful delete operation on the Reply table. You
can then issue a new BatchWriteItem API call to address these unprocessed requests.
HTTP/1.1 200 OK
x-amzn-RequestId: G8M9ANLOE5QA26AEUHJKJE0ASBVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-Type: application/x-amz-json-1.0
Content-Length: 536
Date: Thu, 05 Apr 2012 18:22:09 GMT
{
"Responses":{
"Thread":{
"ConsumedCapacityUnits":1.0
},
"Reply":{
"ConsumedCapacityUnits":1.0
}
},
"UnprocessedItems":{
"Reply":[
{
"DeleteRequest":{
"Key":{
"HashKeyElement":{
"S":"DynamoDB#DynamoDB Thread 4"
},
"RangeKeyElement":{
"S":"oops - accidental row"
}
}
}
}
]
}
}
CreateTable
Important
This section refers to the previous API version (2011-12-05). For the most recent API version,
go to the Amazon DynamoDB API Reference.
Description
The CreateTable operation adds a new table to your account.
The table name must be unique among those associated with the AWS Account issuing the request, and
the AWS region that receives the request (such as dynamodb.us-west-2.amazonaws.com). Each
DynamoDB endpoint is entirely independent. For example, if you have two tables called "MyTable," one
in dynamodb.us-west-2.amazonaws.com and one in dynamodb.us-west-1.amazonaws.com, they are
completely independent and do not share any data.
The CreateTable operation triggers an asynchronous workflow to begin creating the table. DynamoDB
immediately returns the state of the table (CREATING) until the table is in the ACTIVE state. Once the
table is in the ACTIVE state, you can perform data plane operations.
Use the DescribeTables (p. 759) API to check the status of the table.
Requests
Syntax
// This header is abbreviated.
// For a sample of a complete header, see Sample DynamoDB JSON Request and Re
sponse (p. 517).
POST / HTTP/1.1
x-amz-target: DynamoDB_20111205.CreateTable
content-type: application/x-amz-json-1.0
{"TableName":"Table1",
"KeySchema":
{"HashKeyElement":{"AttributeName":"AttributeName1","AttributeType":"S"},
"RangeKeyElement":{"AttributeName":"AttributeName2","Attribute
Type":"N"}},
"ProvisionedThroughput":{"ReadCapacityUnits":5,"WriteCapacityUnits":10}
}
Name
Description
TableName
Required
Name
Description
Required
KeySchema
ProvisionedThroughput
Note
For current maximum/minimum values, see Limits in DynamoDB (p. 664).
Type: Array
ProvisionedThroughput: ReadCa- Sets the minimum number of consistent
Yes
ReadCapacityUnits consumed per second
pacityUnits
for the specified table before DynamoDB balances the load with other operations.
Yes
Responses
Syntax
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
content-type: application/x-amz-json-1.0
content-length: 311
Date: Tue, 12 Jul 2011 21:31:03 GMT
{"TableDescription":
{"CreationDateTime":1.310506263362E9,
"KeySchema":
{"HashKeyElement":{"AttributeName":"AttributeName1","AttributeType":"S"},
"RangeKeyElement":{"AttributeName":"AttributeName2","Attribute
Type":"N"}},
"ProvisionedThroughput":{"ReadCapacityUnits":5,"WriteCapacityUnits":10},
"TableName":"Table1",
"TableStatus":"CREATING"
}
}
Name
Description
TableDescription
CreationDateTime
KeySchema
ProvisionedThroughput
Name
Description
TableStatus
Special Errors
Error
Description
ResourceInUseException
LimitExceededException
Note
For current maximum/minimum values, see Limits
in DynamoDB (p. 664).
.
Examples
The following example creates a table with a composite primary key containing a string and a number.
For examples using the AWS SDK, see Working with Tables in DynamoDB (p. 61).
Sample Request
// This header is abbreviated.
// For a sample of a complete header, see Sample DynamoDB JSON Request and Re
sponse (p. 517).
POST / HTTP/1.1
x-amz-target: DynamoDB_20111205.CreateTable
content-type: application/x-amz-json-1.0
{"TableName":"comp-table",
"KeySchema":
{"HashKeyElement":{"AttributeName":"user","AttributeType":"S"},
"RangeKeyElement":{"AttributeName":"time","AttributeType":"N"}},
"ProvisionedThroughput":{"ReadCapacityUnits":5,"WriteCapacityUnits":10}
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
content-type: application/x-amz-json-1.0
content-length: 311
Date: Tue, 12 Jul 2011 21:31:03 GMT
{"TableDescription":
{"CreationDateTime":1.310506263362E9,
"KeySchema":
{"HashKeyElement":{"AttributeName":"user","AttributeType":"S"},
"RangeKeyElement":{"AttributeName":"time","AttributeType":"N"}},
"ProvisionedThroughput":{"ReadCapacityUnits":5,"WriteCapacityUnits":10},
"TableName":"comp-table",
"TableStatus":"CREATING"
}
}
Related Actions
DescribeTables (p. 759)
DeleteTable (p. 756)
DeleteItem
Important
This section refers to the previous API version (2011-12-05). For the most recent API version,
go to the Amazon DynamoDB API Reference.
Description
Deletes a single item in a table by primary key.You can perform a conditional delete operation that deletes
the item if it exists, or if it has an expected attribute value.
Note
If you specify DeleteItem without attributes or values, all the attributes for the item are deleted.
Unless you specify conditions, the DeleteItem is an idempotent operation; running it multiple
times on the same item or attribute does not result in an error response.
Conditional deletes are useful for only deleting items and attributes if specific conditions are met.
If the conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.
You can perform the expected conditional check on one attribute per operation.
Requests
Syntax
// This header is abbreviated.
// For a sample of a complete header, see Sample DynamoDB JSON Request and Re
sponse (p. 517).
POST / HTTP/1.1
x-amz-target: DynamoDB_20111205.DeleteItem
content-type: application/x-amz-json-1.0
{"TableName":"Table1",
"Key":
{"HashKeyElement":{"S":"AttributeValue1"},"RangeKeyElement":{"N":"At
tributeValue2"}},
"Expected":{"AttributeName3":{"Value":{"S":"AttributeValue3"}}},
"ReturnValues":"ALL_OLD"}
}
Name
Description
Required
TableName
Yes
Key
Yes
Expected
Expected:AttributeName
No
Name
Description
Required
By default, if you use the Expected parameter and provide a Value, DynamoDB assumes
the attribute exists and has a current value to
be replaced. So you don't have to specify
{"Exists":true}, because it is implied.
You can shorten the request to:
"Expected" :
{"Color":{"Value":{"S":"Yellow"}}}
Note
If you specify {"Exists":true}
without an attribute value to check,
DynamoDB returns an error.
ReturnValues
Responses
Syntax
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
content-type: application/x-amz-json-1.0
content-length: 353
Date: Tue, 12 Jul 2011 21:31:03 GMT
{"Attributes":
{"AttributeName3":{"SS":["AttributeValue3","AttributeValue4","Attribute
Value5"]},
"AttributeName2":{"S":"AttributeValue2"},
"AttributeName1":{"N":"AttributeValue1"}
},
"ConsumedCapacityUnits":1
}
Name
Description
Attributes
ConsumedCapacityUnits
Special Errors
Error
Description
Examples
Sample Request
// This header is abbreviated.
// For a sample of a complete header, see Sample DynamoDB JSON Request and Re
sponse (p. 517).
POST / HTTP/1.1
x-amz-target: DynamoDB_20111205.DeleteItem
content-type: application/x-amz-json-1.0
{"TableName":"comp-table",
"Key":
{"HashKeyElement":{"S":"Mingus"},"RangeKeyElement":{"N":"200"}},
"Expected":
{"status":{"Value":{"S":"shopping"}}},
"ReturnValues":"ALL_OLD"
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: U9809LI6BBFJA5N2R0TB0P017JVV4KQNSO5AEMVJF66Q9ASUAAJG
content-type: application/x-amz-json-1.0
content-length: 353
Date: Tue, 12 Jul 2011 22:31:23 GMT
{"Attributes":
{"friends":{"SS":["Dooley","Ben","Daisy"]},
"status":{"S":"shopping"},
"time":{"N":"200"},
"user":{"S":"Mingus"}
},
"ConsumedCapacityUnits":1
}
Related Actions
PutItem (p. 766)
DeleteTable
Important
This section refers to the previous API version (2011-12-05). For the most recent API version,
go to the Amazon DynamoDB API Reference.
Description
The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the
specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the
ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns
a ResourceInUseException error. If the specified table does not exist, DynamoDB returns a
ResourceNotFoundException. If table is already in the DELETING state, no error is returned.
Note
DynamoDB might continue to accept data plane operation requests, such as GetItem and
PutItem, on a table in the DELETING state until the table deletion is complete.
Tables are unique among those associated with the AWS Account issuing the request, and the AWS
region that receives the request (such as dynamodb.us-west-1.amazonaws.com). Each DynamoDB
endpoint is entirely independent. For example, if you have two tables called "MyTable," one in
dynamodb.us-west-2.amazonaws.com and one in dynamodb.us-west-1.amazonaws.com, they are
completely independent and do not share any data; deleting one does not delete the other.
Use the DescribeTables (p. 759) API to check the status of the table.
Requests
Syntax
// This header is abbreviated.
// For a sample of a complete header, see Sample DynamoDB JSON Request and Re
sponse (p. 517).
POST / HTTP/1.1
x-amz-target: DynamoDB_20111205.DeleteTable
content-type: application/x-amz-json-1.0
{"TableName":"Table1"}
Name
Description
Required
TableName
Yes
Responses
Syntax
HTTP/1.1 200 OK
x-amzn-RequestId: 4HONCKIVH1BFUDQ1U68CTG3N27VV4KQNSO5AEMVJF66Q9ASUAAJG
content-type: application/x-amz-json-1.0
content-length: 311
Date: Sun, 14 Aug 2011 22:56:22 GMT
{"TableDescription":
{"CreationDateTime":1.313362508446E9,
"KeySchema":
{"HashKeyElement":{"AttributeName":"user","AttributeType":"S"},
"RangeKeyElement":{"AttributeName":"time","AttributeType":"N"}},
"ProvisionedThroughput":{"ReadCapacityUnits":10,"WriteCapacityUnits":10},
"TableName":"Table1",
"TableStatus":"DELETING"
}
}
Name
Description
TableDescription
CreationDateTime
Name
Description
KeySchema
ProvisionedThroughput
TableStatus
Special Errors
Error
Description
ResourceInUseException
Examples
Sample Request
// This header is abbreviated. For a sample of a complete header, see Sample
DynamoDB JSON Request and Response (p. 517).
POST / HTTP/1.1
x-amz-target: DynamoDB_20111205.DeleteTable
content-type: application/x-amz-json-1.0
content-length: 40
{"TableName":"favorite-movies-table"}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: 4HONCKIVH1BFUDQ1U68CTG3N27VV4KQNSO5AEMVJF66Q9ASUAAJG
content-type: application/x-amz-json-1.0
content-length: 160
Date: Sun, 14 Aug 2011 17:20:03 GMT
{"TableDescription":
{"CreationDateTime":1.313362508446E9,
"KeySchema":
{"HashKeyElement":{"AttributeName":"name","AttributeType":"S"}},
"TableName":"favorite-movies-table",
"TableStatus":"DELETING"
}
Related Actions
CreateTable (p. 748)
DescribeTables (p. 759)
DescribeTables
Important
This section refers to the previous API version (2011-12-05). For the most recent API version,
go to the Amazon DynamoDB API Reference.
Description
Returns information about the table, including the current status of the table, the primary key schema and
when the table was created. DescribeTable results are eventually consistent. If you use DescribeTable
too early in the process of creating a table, DynamoDB returns a ResourceNotFoundException. If you
use DescribeTable too early in the process of updating a table, the new values might not be immediately
available.
Requests
Syntax
// This header is abbreviated.
// For a sample of a complete header, see Sample DynamoDB JSON Request and Re
sponse (p. 517).
POST / HTTP/1.1
x-amz-target: DynamoDB_20111205.DescribeTable
content-type: application/x-amz-json-1.0
{"TableName":"Table1"}
Name
Description
Required
TableName
Yes
Responses
Syntax
HTTP/1.1 200
x-amzn-RequestId: 8966d095-71e9-11e0-a498-71d736f27375
content-type: application/x-amz-json-1.0
Content-Length: 543
{"Table":
{"CreationDateTime":1.309988345372E9,
ItemCount:1,
"KeySchema":
{"HashKeyElement":{"AttributeName":"AttributeName1","AttributeType":"S"},
"RangeKeyElement":{"AttributeName":"AttributeName2","Attribute
Type":"N"}},
"ProvisionedThroughput":{"LastIncreaseDateTime": Date, "LastDecreaseDate
Time": Date, "ReadCapacityUnits":10,"WriteCapacityUnits":10},
"TableName":"Table1",
"TableSizeBytes":1,
"TableStatus":"ACTIVE"
}
}
Name
Description
Table
CreationDateTime
ItemCount
Number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent
changes might not be reflected in this value.
Type: Number
KeySchema
Name
Description
ProvisionedThroughput
TableName
TableSizeBytes
TableStatus
Special Errors
No errors are specific to this API.
Examples
The following examples show an HTTP POST request and response using the DescribeTable operation
for a table named "comp-table". The table has a composite primary key.
Sample Request
// This header is abbreviated.
// For a sample of a complete header, see Sample DynamoDB JSON Request and Re
sponse (p. 517).
POST / HTTP/1.1
x-amz-target: DynamoDB_20111205.DescribeTable
content-type: application/x-amz-json-1.0
{"TableName":"users"}
Sample Response
HTTP/1.1 200
x-amzn-RequestId: 8966d095-71e9-11e0-a498-71d736f27375
content-type: application/x-amz-json-1.0
content-length: 543
{"Table":
{"CreationDateTime":1.309988345372E9,
"ItemCount":23,
"KeySchema":
{"HashKeyElement":{"AttributeName":"user","AttributeType":"S"},
"RangeKeyElement":{"AttributeName":"time","AttributeType":"N"}},
"ProvisionedThroughput":{"LastIncreaseDateTime": 1.309988345384E9, "ReadCa
pacityUnits":10,"WriteCapacityUnits":10},
"TableName":"users",
"TableSizeBytes":949,
"TableStatus":"ACTIVE"
}
}
Related Actions
CreateTable (p. 748)
DeleteTable (p. 756)
ListTables (p. 764)
GetItem
Important
This section refers to the previous API version (2011-12-05). For the most recent API version,
go to the Amazon DynamoDB API Reference.
Description
The GetItem operation returns a set of Attributes for an item that matches the primary key. If there
is no matching item, GetItem does not return any data.
The GetItem operation provides an eventually consistent read by default. If eventually consistent reads
are not acceptable for your application, use ConsistentRead. Although this operation might take longer
than a standard read, it always returns the last updated value. For more information, see Data Read and
Consistency Considerations (p. 10).
Requests
Syntax
// This header is abbreviated.
// For a sample of a complete header, see Sample DynamoDB JSON Request and Re
sponse (p. 517).
POST / HTTP/1.1
x-amz-target: DynamoDB_20111205.GetItem
content-type: application/x-amz-json-1.0
{"TableName":"Table1",
"Key":
{"HashKeyElement": {"S":"AttributeValue1"},
"RangeKeyElement": {"N":"AttributeValue2"}
},
"AttributesToGet":["AttributeName3","AttributeName4"],
"ConsistentRead":Boolean
}
Name
Description
Required
TableName
Key
AttributesToGet
ConsistentRead
Responses
Syntax
HTTP/1.1 200
x-amzn-RequestId: 8966d095-71e9-11e0-a498-71d736f27375
content-type: application/x-amz-json-1.0
content-length: 144
{"Item":{
"AttributeName3":{"S":"AttributeValue3"},
"AttributeName4":{"N":"AttributeValue4"},
"AttributeName5":{"B":"dmFsdWU="}
},
"ConsumedCapacityUnits": 0.5
}
Name
Description
Item
ConsumedCapacityUnits
Special Errors
No errors specific to this API.
Examples
For examples using the AWS SDK, see Working with Items in DynamoDB (p. 92).
Sample Request
// This header is abbreviated.
// For a sample of a complete header, see Sample DynamoDB JSON Request and Re
sponse (p. 517).
POST / HTTP/1.1
x-amz-target: DynamoDB_20111205.GetItem
content-type: application/x-amz-json-1.0
{"TableName":"comptable",
"Key":
{"HashKeyElement":{"S":"Julie"},
"RangeKeyElement":{"N":"1307654345"}},
"AttributesToGet":["status","friends"],
"ConsistentRead":true
}
Sample Response
Notice the ConsumedCapacityUnits value is 1, because the optional parameter ConsistentRead is set
to true. If ConsistentRead is set to false (or not specified) for the same request, the response is
eventually consistent and the ConsumedCapacityUnits value would be 0.5.
HTTP/1.1 200
x-amzn-RequestId: 8966d095-71e9-11e0-a498-71d736f27375
content-type: application/x-amz-json-1.0
content-length: 72
{"Item":
{"friends":{"SS":["Lynda, Aaron"]},
"status":{"S":"online"}
},
"ConsumedCapacityUnits": 1
}
ListTables
Important
This section refers to the previous API version (2011-12-05). For the most recent API version,
go to the Amazon DynamoDB API Reference.
Description
Returns an array of all the tables associated with the current account and endpoint.
Each DynamoDB endpoint is entirely independent. For example, if you have two tables called "MyTable,"
one in dynamodb.us-west-2.amazonaws.com and one in dynamodb.us-east-1.amazonaws.com, they are
API Version 2012-08-10
764
completely independent and do not share any data. The ListTables operation returns all of the table
names associated with the account making the request, for the endpoint that receives the request.
Requests
Syntax
// This header is abbreviated.
// For a sample of a complete header, see Sample DynamoDB JSON Request and Re
sponse (p. 517).
POST / HTTP/1.1
x-amz-target: DynamoDB_20111205.ListTables
content-type: application/x-amz-json-1.0
{"ExclusiveStartTableName":"Table1","Limit":3}
The ListTables operation, by default, requests all of the table names associated with the account making
the request, for the endpoint that receives the request.
Name
Description
Required
Limit
No
ExclusiveStartTableName
Responses
Syntax
HTTP/1.1 200 OK
x-amzn-RequestId: S1LEK2DPQP8OJNHVHL8OU2M7KRVV4KQNSO5AEMVJF66Q9ASUAAJG
content-type: application/x-amz-json-1.0
content-length: 81
Date: Fri, 21 Oct 2011 20:35:38 GMT
{"TableNames":["Table1","Table2","Table3"], "LastEvaluatedTableName":"Table3"}
Name
Description
TableNames
Name
Description
LastEvaluatedTableName
Special Errors
No errors are specific to this API.
Examples
The following examples show an HTTP POST request and response using the ListTables operation.
Sample Request
// This header is abbreviated.
// For a sample of a complete header, see Sample DynamoDB JSON Request and Re
sponse (p. 517).
POST / HTTP/1.1
x-amz-target: DynamoDB_20111205.ListTables
content-type: application/x-amz-json-1.0
{"ExclusiveStartTableName":"comp2","Limit":3}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: S1LEK2DPQP8OJNHVHL8OU2M7KRVV4KQNSO5AEMVJF66Q9ASUAAJG
content-type: application/x-amz-json-1.0
content-length: 81
Date: Fri, 21 Oct 2011 20:35:38 GMT
{"LastEvaluatedTableName":"comp5","TableNames":["comp3","comp4","comp5"]}
Related Actions
DescribeTables (p. 759)
CreateTable (p. 748)
DeleteTable (p. 756)
PutItem
Important
This section refers to the previous API version (2011-12-05). For the most recent API version,
go to the Amazon DynamoDB API Reference.
Description
Creates a new item, or replaces an old item with a new item (including all the attributes). If an item already
exists in the specified table with the same primary key, the new item completely replaces the existing
item. You can perform a conditional put (insert a new item if one with the specified primary key doesn't
exist), or replace an existing item if it has certain attribute values.
Attribute values may not be null; string and binary type attributes must have lengths greater than zero;
and set type attributes must not be empty. Requests with empty values will be rejected with a
ValidationException.
Note
To ensure that a new item does not replace an existing item, use a conditional put operation
with Exists set to false for the primary key attribute, or attributes.
For more information about using this API, see Working with Items in DynamoDB (p. 92).
Requests
Syntax
// This header is abbreviated.
// For a sample of a complete header, see Sample DynamoDB JSON Request and Re
sponse (p. 517).
POST / HTTP/1.1
x-amz-target: DynamoDB_20111205.PutItem
content-type: application/x-amz-json-1.0
{"TableName":"Table1",
"Item":{
"AttributeName1":{"S":"AttributeValue1"},
"AttributeName2":{"N":"AttributeValue2"},
"AttributeName5":{"B":"dmFsdWU="}
},
"Expected":{"AttributeName3":{"Value": {"S":"AttributeValue"}, "Ex
ists":Boolean}},
"ReturnValues":"ReturnValuesConstant"}
Name
Description
Required
TableName
Yes
Item
Name
Description
Required
Expected
Expected:AttributeName
No
By default, if you use the Expected parameter and provide a Value, DynamoDB assumes
the attribute exists and has a current value to
be replaced. So you don't have to specify
{"Exists":true}, because it is implied.
You can shorten the request to:
"Expected" :
{"Color":{"Value":{"S":"Yellow"}}}
Note
If you specify {"Exists":true}
without an attribute value to check,
DynamoDB returns an error.
Name
Description
Required
ReturnValues
Responses
Syntax
The following syntax example assumes the request specified a ReturnValues parameter of ALL_OLD;
otherwise, the response has only the ConsumedCapacityUnits element.
HTTP/1.1 200
x-amzn-RequestId: 8966d095-71e9-11e0-a498-71d736f27375
content-type: application/x-amz-json-1.0
content-length: 85
{"Attributes":
{"AttributeName3":{"S":"AttributeValue3"},
"AttributeName2":{"SS":"AttributeValue2"},
"AttributeName1":{"SS":"AttributeValue1"},
},
"ConsumedCapacityUnits":1
}
Name
Description
Attributes
ConsumedCapacityUnits
Special Errors
Error
Description
Examples
For examples using the AWS SDK, see Working with Items in DynamoDB (p. 92).
Sample Request
// This header is abbreviated. For a sample of a complete header, see Sample
DynamoDB JSON Request and Response (p. 517).
POST / HTTP/1.1
x-amz-target: DynamoDB_20111205.PutItem
content-type: application/x-amz-json-1.0
{"TableName":"comp5",
"Item":
{"time":{"N":"300"},
"feeling":{"S":"not surprised"},
"user":{"S":"Riley"}
},
"Expected":
{"feeling":{"Value":{"S":"surprised"},"Exists":true}}
"ReturnValues":"ALL_OLD"
}
Sample Response
HTTP/1.1 200
x-amzn-RequestId: 8952fa74-71e9-11e0-a498-71d736f27375
content-type: application/x-amz-json-1.0
content-length: 84
{"Attributes":
{"feeling":{"S":"surprised"},
"time":{"N":"300"},
"user":{"S":"Riley"}},
"ConsumedCapacityUnits":1
}
Related Actions
UpdateItem (p. 785)
DeleteItem (p. 752)
GetItem (p. 762)
BatchGetItem (p. 737)
Query
Important
This section refers to the previous API version (2011-12-05). For the most recent API version,
go to the Amazon DynamoDB API Reference.
Description
A Query operation gets the values of one or more items and their attributes by primary key (Query is
only available for hash-and-range primary key tables). You must provide a specific HashKeyValue, and
can narrow the scope of the query using comparison operators on the RangeKeyValue of the primary
key. Use the ScanIndexForward parameter to get results in forward or reverse order by range key.
Queries that do not return results consume the minimum read capacity units according to the type of
read.
Note
If the total number of items meeting the query parameters exceeds the 1MB limit, the query stops
and results are returned to the user with a LastEvaluatedKey to continue the query in a
subsequent operation. Unlike a Scan operation, a Query operation never returns an empty result
set and a LastEvaluatedKey. The LastEvaluatedKey is only provided if the results exceed
1MB, or if you have used the Limit parameter.
The result can be set for a consistent read using the ConsistentRead parameter.
Requests
Syntax
// This header is abbreviated.
// For a sample of a complete header, see Sample DynamoDB JSON Request and Re
sponse (p. 517).
POST / HTTP/1.1
x-amz-target: DynamoDB_20111205.Query
content-type: application/x-amz-json-1.0
{"TableName":"Table1",
"Limit":2,
"ConsistentRead":true,
"HashKeyValue":{"S":"AttributeValue1":},
"RangeKeyCondition": {"AttributeValueList":[{"N":"AttributeValue2"}],"Compar
isonOperator":"GT"}
"ScanIndexForward":true,
"ExclusiveStartKey":{
"HashKeyElement":{"S":"AttributeName1"},
"RangeKeyElement":{"N":"AttributeName2"}
},
"AttributesToGet":["AttributeName1", "AttributeName2", "AttributeName3"]},
}
Name
Description
Required
TableName
Yes
Name
Description
Required
AttributesToGet
Limit
ConsistentRead
Count
HashKeyValue
RangeKeyCondition
No
Yes
Name
Description
Required
Note
String value comparisons for greater than, equals,
or less than are based on ASCII character code
values. For example, a is greater than A, and aa is
greater than B. For a list of code values, see http://
en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
Type: String or Binary
EQ : Equal.
For EQ, AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type
than the one specified in the request, the value does not
match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6",
"2", "1"]}.
LE : Less than or equal.
For LE, AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type
than the one specified in the request, the value does not
match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare to
{"NS":["6", "2", "1"]}.
LT : Less than.
For LT, AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type
than the one specified in the request, the value does not
match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare to
{"NS":["6", "2", "1"]}.
GE : Greater than or equal.
For GE, AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type
than the one specified in the request, the value does not
match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare to
{"NS":["6", "2", "1"]}.
Name
Description
Required
GT : Greater than.
For GT, AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type
than the one specified in the request, the value does not
match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare to
{"NS":["6", "2", "1"]}.
BEGINS_WITH : checks for a prefix.
For BEGINS_WITH, AttributeValueList can contain only
one AttributeValue of type String or Binary (not a Number
or a set). The target attribute of the comparison must be a
String or Binary (not a Number or a set).
BETWEEN : Greater than, or equal to, the first value and less
than, or equal to, the second value.
For BETWEEN, AttributeValueList must contain two
AttributeValue elements of the same type, either String,
Number, or Binary (not a set). A target attribute matches if
the target value is greater than, or equal to, the first element
and less than, or equal to, the second element. If an item
contains an AttributeValue of a different type than the
one specified in the request, the value does not match. For
example, {"S":"6"} does not compare to {"N":"6"}.
Also, {"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
ScanIndexForward
ExclusiveStartKey
Responses
Syntax
HTTP/1.1 200
x-amzn-RequestId: 8966d095-71e9-11e0-a498-71d736f27375
content-type: application/x-amz-json-1.0
content-length: 308
{"Count":2,"Items":[{
"AttributeName1":{"S":"AttributeValue1"},
"AttributeName2":{"N":"AttributeValue2"},
"AttributeName3":{"S":"AttributeValue3"}
},{
"AttributeName1":{"S":"AttributeValue3"},
"AttributeName2":{"N":"AttributeValue4"},
"AttributeName3":{"S":"AttributeValue3"},
"AttributeName5":{"B":"dmFsdWU="}
}],
"LastEvaluatedKey":{"HashKeyElement":{"AttributeValue3":"S"},
"RangeKeyElement":{"AttributeValue4":"N"}
},
"ConsumedCapacityUnits":1
}
Name
Description
Items
Count
Number of items in the response. For more information, see Count and ScannedCount (p. 196).
Type: Number
LastEvaluatedKey
ConsumedCapacityUnits
Special Errors
Error
Description
ResourceNotFoundException
Examples
For examples using the AWS SDK, see Query and Scan Operations in DynamoDB (p. 193).
Sample Request
// This header is abbreviated. For a sample of a complete header, see Sample
DynamoDB JSON Request and Response (p. 517).
POST / HTTP/1.1
x-amz-target: DynamoDB_20111205.Query
content-type: application/x-amz-json-1.0
{"TableName":"1-hash-rangetable",
"Limit":2,
"HashKeyValue":{"S":"John"},
"ScanIndexForward":false,
"ExclusiveStartKey":{
"HashKeyElement":{"S":"John"},
"RangeKeyElement":{"S":"The Matrix"}
}
}
Sample Response
HTTP/1.1 200
x-amzn-RequestId: 3647e778-71eb-11e0-a498-71d736f27375
content-type: application/x-amz-json-1.0
content-length: 308
{"Count":2,"Items":[{
"fans":{"SS":["Jody","Jake"]},
"name":{"S":"John"},
"rating":{"S":"***"},
"title":{"S":"The End"}
},{
"fans":{"SS":["Jody","Jake"]},
"name":{"S":"John"},
"rating":{"S":"***"},
"title":{"S":"The Beatles"}
}],
"LastEvaluatedKey":{"HashKeyElement":{"S":"John"},"RangeKeyElement":{"S":"The
Beatles"}},
"ConsumedCapacityUnits":1
}
Sample Request
// This header is abbreviated. For a sample of a complete header, see Sample
DynamoDB JSON Request and Response (p. 517).
POST / HTTP/1.1
x-amz-target: DynamoDB_20111205.Query
content-type: application/x-amz-json-1.0
{"TableName":"1-hash-rangetable",
"Limit":2,
"HashKeyValue":{"S":"Airplane"},
"RangeKeyCondition":{"AttributeValueList":[{"N":"1980"}],"ComparisonOperat
or":"EQ"},
"ScanIndexForward":false}
Sample Response
HTTP/1.1 200
x-amzn-RequestId: 8b9ee1ad-774c-11e0-9172-d954e38f553a
content-type: application/x-amz-json-1.0
content-length: 119
{"Count":1,"Items":[{
"fans":{"SS":["Dave","Aaron"]},
"name":{"S":"Airplane"},
"rating":{"S":"***"},
"year":{"N":"1980"}
}],
"ConsumedCapacityUnits":1
}
Related Actions
Scan (p. 777)
Scan
Important
This section refers to the previous API version (2011-12-05). For the most recent API version,
go to the Amazon DynamoDB API Reference.
Description
The Scan operation returns one or more items and its attributes by performing a full scan of a table.
Provide a ScanFilter to get more specific results.
Note
If the total number of scanned items exceeds the 1MB limit, the scan stops and results are
returned to the user with a LastEvaluatedKey to continue the scan in a subsequent operation.
The results also include the number of items exceeding the limit. A scan can result in no table
data meeting the filter criteria.
The result set is eventually consistent.
Requests
Syntax
// This header is abbreviated.
// For a sample of a complete header, see Sample DynamoDB JSON Request and Re
Name
Description
TableName
AttributesToGet
Limit
Count
Required
No
Name
Description
Required
ScanFilter
ScanFilter:AttributeValueList
ScanFilter: Comparison- The criteria for evaluating the provided attributes, such No
as equals, greater-than, etc. The following are valid
Operator
comparison operators for a scan operation.
Note
String value comparisons for greater than,
equals, or less than are based on ASCII
character code values. For example, a is
greater than A, and aa is greater than B. For
a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the
binary data as unsigned when it compares
binary values, for example when evaluating
query expressions.
Type: String or Binary
EQ : Equal.
For EQ, AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary
(not a set). If an item contains an AttributeValue of
a different type than the one specified in the request,
the value does not match. For example, {"S":"6"}
does not equal {"N":"6"}. Also, {"N":"6"} does
not equal {"NS":["6", "2", "1"]}.
NE : Not Equal.
For NE, AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary
(not a set). If an item contains an AttributeValue of
a different type than the one specified in the request,
the value does not match. For example, {"S":"6"}
does not equal {"N":"6"}. Also, {"N":"6"} does
not equal {"NS":["6", "2", "1"]}.
LE : Less than or equal.
For LE, AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary
(not a set). If an item contains an AttributeValue of
a different type than the one specified in the request,
the value does not match. For example, {"S":"6"}
does not equal {"N":"6"}. Also, {"N":"6"} does
not compare to {"NS":["6", "2", "1"]}.
Name
Description
LT : Less than.
For LT, AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary
(not a set). If an item contains an AttributeValue of
a different type than the one specified in the request,
the value does not match. For example, {"S":"6"}
does not equal {"N":"6"}. Also, {"N":"6"} does
not compare to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
For GE, AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary
(not a set). If an item contains an AttributeValue of
a different type than the one specified in the request,
the value does not match. For example, {"S":"6"}
does not equal {"N":"6"}. Also, {"N":"6"} does
not compare to {"NS":["6", "2", "1"]}.
GT : Greater than.
For GT, AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary
(not a set). If an item contains an AttributeValue of
a different type than the one specified in the request,
the value does not match. For example, {"S":"6"}
does not equal {"N":"6"}. Also, {"N":"6"} does
not compare to {"NS":["6", "2", "1"]}.
NOT_NULL : Attribute exists.
NULL : Attribute does not exist.
CONTAINS : checks for a subsequence, or value in a
set.
For CONTAINS, AttributeValueList can contain
only one AttributeValue of type String, Number, or
Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison
is Binary, then the operation looks for a subsequence
of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"),
then the operation checks for a member of the set (not
as a substring).
Required
Name
Description
Required
Responses
Syntax
HTTP/1.1 200
x-amzn-RequestId: 8966d095-71e9-11e0-a498-71d736f27375
content-type: application/x-amz-json-1.0
content-length: 229
{"Count":2,"Items":[{
"AttributeName1":{"S":"AttributeValue1"},
"AttributeName2":{"S":"AttributeValue2"},
"AttributeName3":{"S":"AttributeValue3"}
},{
"AttributeName1":{"S":"AttributeValue4"},
"AttributeName2":{"S":"AttributeValue5"},
"AttributeName3":{"S":"AttributeValue6"},
"AttributeName5":{"B":"dmFsdWU="}
}],
"LastEvaluatedKey":
{"HashKeyElement":{"S":"AttributeName1"},
"RangeKeyElement":{"N":"AttributeName2"},
"ConsumedCapacityUnits":1,
"ScannedCount":2}
}
Name
Description
Items
Count
Number of items in the response. For more information, see Count and ScannedCount (p. 196).
Type: Number
ScannedCount
LastEvaluatedKey
Name
Description
ConsumedCapacityUnits
Special Errors
Error
Description
ResourceNotFoundException
Examples
For examples using the AWS SDK, see Query and Scan Operations in DynamoDB (p. 193).
Sample Request
// This header is abbreviated. For a sample of a complete header, see Sample
DynamoDB JSON Request and Response (p. 517).
POST / HTTP/1.1
x-amz-target: DynamoDB_20111205.Scan
content-type: application/x-amz-json-1.0
{"TableName":"1-hash-rangetable","ScanFilter":{}}
Sample Response
HTTP/1.1 200
x-amzn-RequestId: 4e8a5fa9-71e7-11e0-a498-71d736f27375
content-type: application/x-amz-json-1.0
content-length: 465
{"Count":4,"Items":[{
"date":{"S":"1980"},
"fans":{"SS":["Dave","Aaron"]},
"name":{"S":"Airplane"},
"rating":{"S":"***"}
},{
"date":{"S":"1999"},
"fans":{"SS":["Ziggy","Laura","Dean"]},
"name":{"S":"Matrix"},
"rating":{"S":"*****"}
},{
"date":{"S":"1976"},
"fans":{"SS":["Riley"]},"
name":{"S":"The Shaggy D.A."},
"rating":{"S":"**"}
},{
"date":{"S":"1985"},
"fans":{"SS":["Fox","Lloyd"]},
"name":{"S":"Back To The Future"},
"rating":{"S":"****"}
}],
"ConsumedCapacityUnits":0.5
"ScannedCount":4}
Sample Request
// This header is abbreviated. For a sample of a complete header, see Sample
DynamoDB JSON Request and Response (p. 517).
POST / HTTP/1.1
x-amz-target: DynamoDB_20111205.Scan
content-type: application/x-amz-json-1.0
content-length: 125
{"TableName":"comp5",
"ScanFilter":
{"time":
{"AttributeValueList":[{"N":"400"}],
"ComparisonOperator":"GT"}
}
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: PD1CQK9QCTERLTJP20VALJ60TRVV4KQNSO5AEMVJF66Q9ASUAAJG
content-type: application/x-amz-json-1.0
content-length: 262
Date: Mon, 15 Aug 2011 16:52:02 GMT
{"Count":2,
"Items":[
{"friends":{"SS":["Dave","Ziggy","Barrie"]},
"status":{"S":"chatting"},
"time":{"N":"2000"},
"user":{"S":"Casey"}},
{"friends":{"SS":["Dave","Ziggy","Barrie"]},
"status":{"S":"chatting"},
"time":{"N":"2000"},
"user":{"S":"Fredy"}
}],
"ConsumedCapacityUnits":0.5
"ScannedCount":4
}
Sample Request
// This header is abbreviated. For a sample of a complete header, see Sample
DynamoDB JSON Request and Response (p. 517).
POST / HTTP/1.1
x-amz-target: DynamoDB_20111205.Scan
content-type: application/x-amz-json-1.0
{"TableName":"comp5",
"Limit":2,
"ScanFilter":
{"time":
{"AttributeValueList":[{"N":"400"}],
"ComparisonOperator":"GT"}
},
"ExclusiveStartKey":
{"HashKeyElement":{"S":"Fredy"},"RangeKeyElement":{"N":"2000"}}
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: PD1CQK9QCTERLTJP20VALJ60TRVV4KQNSO5AEMVJF66Q9ASUAAJG
content-type: application/x-amz-json-1.0
content-length: 232
Date: Mon, 15 Aug 2011 16:52:02 GMT
{"Count":1,
"Items":[
{"friends":{"SS":["Jane","James","John"]},
"status":{"S":"exercising"},
"time":{"N":"2200"},
"user":{"S":"Roger"}}
],
"LastEvaluatedKey":{"HashKeyElement":{"S":"Riley"},"RangeKeyEle
ment":{"N":"250"}},
"ConsumedCapacityUnits":0.5
"ScannedCount":2
}
Related Actions
Query (p. 771)
BatchGetItem (p. 737)
UpdateItem
Important
This section refers to the previous API version (2011-12-05). For the most recent API version,
go to the Amazon DynamoDB API Reference.
Description
Edits an existing item's attributes.You can perform a conditional update (insert a new attribute name-value
pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values).
Note
You cannot update the primary key attributes using UpdateItem. Instead, delete the item and
use PutItem to create a new item with new attributes.
The UpdateItem operation includes an Action parameter, which defines how to perform the update.You
can put, delete, or add attribute values.
Attribute values may not be null; string and binary type attributes must have lengths greater than zero;
and set type attributes must not be empty. Requests with empty values will be rejected with a
ValidationException.
If an existing item has the specified primary key:
PUT Adds the specified attribute. If the attribute exists, it is replaced by the new value.
DELETE If no value is specified, this removes the attribute and its value. If a set of values is specified,
then the values in the specified set are removed from the old set. So if the attribute value contains
[a,b,c] and the delete action contains [a,c], then the final attribute value is [b]. The type of the specified
value must match the existing value type. Specifying an empty set is not valid.
ADD Only use the add action for numbers or if the target attribute is a set (including string sets).
ADD does not work if the target attribute is a single string value or a scalar binary value. The specified
value is added to a numeric value (incrementing or decrementing the existing numeric value) or added
as an additional value in a string set. If a set of values is specified, the values are added to the existing
set. For example if the original set is [1,2] and supplied value is [3], then after the add operation the
set is [1,2,3], not [4,5]. An error occurs if an Add action is specified for a set attribute and the attribute
type specified does not match the existing set type.
If you use ADD for an attribute that does not exist, the attribute and its values are added to the item.
If no item matches the specified primary key:
PUT Creates a new item with specified primary key. Then adds the specified attribute.
DELETE Nothing happens.
ADD Creates an item with supplied primary key and number (or set of numbers) for the attribute
value. Not valid for a string or a binary type.
Note
If you use ADD to increment or decrement a number value for an item that doesn't exist before
the update, DynamoDB uses 0 as the initial value. Also, if you update an item using ADD to
increment or decrement a number value for an attribute that doesn't exist before the update (but
the item does) DynamoDB uses 0 as the initial value. For example, you use ADD to add +3 to
an attribute that did not exist before the update. DynamoDB uses 0 for the initial value, and the
value after the update is 3.
For more information about using this API, see Working with Items in DynamoDB (p. 92).
Requests
Syntax
// This header is abbreviated.
// For a sample of a complete header, see Sample DynamoDB JSON Request and Re
sponse (p. 517).
POST / HTTP/1.1
x-amz-target: DynamoDB_20111205.UpdateItem
content-type: application/x-amz-json-1.0
{"TableName":"Table1",
"Key":
{"HashKeyElement":{"S":"AttributeValue1"},
"RangeKeyElement":{"N":"AttributeValue2"}},
"AttributeUpdates":{"AttributeName3":{"Value":{"S":"AttributeValue3_New"},"Ac
tion":"PUT"}},
"Expected":{"AttributeName3":{"Value":{"S":"AttributeValue3_Current"}}},
"ReturnValues":"ReturnValuesConstant"
}
Name
Description
Required
TableName
Yes
Key
Yes
AttributeUpdates
AttributeUpdates:Action
Expected
Expected:AttributeName
No
Name
Description
Required
Expected:AttributeName:
ExpectedAttributeValue
No
"Expected" :
{"Color":{"Exists":false}}
Note
If you specify {"Exists":true} without
an attribute value to check, DynamoDB
returns an error.
ReturnValues
Responses
Syntax
The following syntax example assumes the request specified a ReturnValues parameter of ALL_OLD;
otherwise, the response has only the ConsumedCapacityUnits element.
HTTP/1.1 200
x-amzn-RequestId: 8966d095-71e9-11e0-a498-71d736f27375
content-type: application/x-amz-json-1.0
content-length: 140
{"Attributes":{
"AttributeName1":{"S":"AttributeValue1"},
"AttributeName2":{"S":"AttributeValue2"},
"AttributeName3":{"S":"AttributeValue3"},
"AttributeName5":{"B":"dmFsdWU="}
},
"ConsumedCapacityUnits":1
}
Name
Description
Attributes
ConsumedCapacityUnits
Special Errors
Error
Description
ConditionalCheckFailedException Conditional check failed. Attribute ("+ name +") value is ("+
value +") but was expected ("+ expValue +")
ResourceNotFoundExceptions
Examples
For examples using the AWS SDK, see Working with Items in DynamoDB (p. 92).
Sample Request
// This header is abbreviated. For a sample of a complete header, see Sample
DynamoDB JSON Request and Response (p. 517).
POST / HTTP/1.1
x-amz-target: DynamoDB_20111205.UpdateItem
content-type: application/x-amz-json-1.0
{"TableName":"comp5",
"Key":
{"HashKeyElement":{"S":"Julie"},"RangeKeyElement":{"N":"1307654350"}},
"AttributeUpdates":
{"status":{"Value":{"S":"online"},
"Action":"PUT"}},
"Expected":{"status":{"Value":{"S":"offline"}}},
"ReturnValues":"ALL_NEW"
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: 5IMHO7F01Q9P7Q6QMKMMI3R3QRVV4KQNSO5AEMVJF66Q9ASUAAJG
content-type: application/x-amz-json-1.0
content-length: 121
Date: Fri, 26 Aug 2011 21:05:00 GMT
{"Attributes":
{"friends":{"SS":["Lynda, Aaron"]},
"status":{"S":"online"},
"time":{"N":"1307654350"},
"user":{"S":"Julie"}},
"ConsumedCapacityUnits":1
}
Related Actions
PutItem (p. 766)
DeleteItem (p. 752)
UpdateTable
Important
This section refers to the previous API version (2011-12-05). For the most recent API version,
go to the Amazon DynamoDB API Reference.
Description
Updates the provisioned throughput for the given table. Setting the throughput for a table helps you
manage performance and is part of the provisioned throughput feature of DynamoDB. For more information,
see Specifying Read and Write Requirements for Tables (p. 62).
The provisioned throughput values can be upgraded or downgraded based on the maximums and
minimums listed in Limits in DynamoDB (p. 664).
The table must be in the ACTIVE state for this operation to succeed. UpdateTable is an asynchronous
operation; while executing the operation, the table is in the UPDATING state. While the table is in the
UPDATING state, the table still has the provisioned throughput from before the call. The new provisioned
throughput setting is in effect only when the table returns to the ACTIVE state after the UpdateTable
operation.
Requests
Syntax
// This header is abbreviated.
// For a sample of a complete header, see Sample DynamoDB JSON Request and Re
sponse (p. 517).
POST / HTTP/1.1
x-amz-target: DynamoDB_20111205.UpdateTable
content-type: application/x-amz-json-1.0
{"TableName":"Table1",
"ProvisionedThroughput":{"ReadCapacityUnits":5,"WriteCapacityUnits":15}
}
Name
Description
Required
TableName
Yes
ProvisionedThroughput
Yes
Responses
Syntax
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-Type: application/json
Content-Length: 311
Date: Tue, 12 Jul 2011 21:31:03 GMT
{"TableDescription":
{"CreationDateTime":1.321657838135E9,
"KeySchema":
{"HashKeyElement":{"AttributeName":"AttributeValue1","Attribute
Type":"S"},
"RangeKeyElement":{"AttributeName":"AttributeValue2","Attribute
Type":"N"}},
"ProvisionedThroughput":
{"LastDecreaseDateTime":1.321661704489E9,
"LastIncreaseDateTime":1.321663607695E9,
"ReadCapacityUnits":5,
"WriteCapacityUnits":10},
"TableName":"Table1",
"TableStatus":"UPDATING"}}
Name
Description
CreationDateTime
KeySchema
ProvisionedThroughput
Current throughput settings for the specified table, including values for LastIncreaseDateTime (if applicable), LastDecreaseDateTime (if applicable),
Type: Array
TableName
Name
Description
TableStatus
Special Errors
Error
Description
ResourceNotFoundException
ResourceInUseException
Examples
Sample Request
// This header is abbreviated.
// For a sample of a complete header, see Sample DynamoDB JSON Request and Re
sponse (p. 517).
POST / HTTP/1.1
x-amz-target: DynamoDB_20111205.UpdateTable
content-type: application/x-amz-json-1.0
{"TableName":"comp1",
"ProvisionedThroughput":{"ReadCapacityUnits":5,"WriteCapacityUnits":15}
}
Sample Response
HTTP/1.1 200 OK
content-type: application/x-amz-json-1.0
content-length: 390
Date: Sat, 19 Nov 2011 00:46:47 GMT
{"TableDescription":
{"CreationDateTime":1.321657838135E9,
"KeySchema":
{"HashKeyElement":{"AttributeName":"user","AttributeType":"S"},
"RangeKeyElement":{"AttributeName":"time","AttributeType":"N"}},
"ProvisionedThroughput":
{"LastDecreaseDateTime":1.321661704489E9,
"LastIncreaseDateTime":1.321663607695E9,
"ReadCapacityUnits":5,
"WriteCapacityUnits":10},
"TableName":"comp1",
"TableStatus":"UPDATING"}
}
Related Actions
CreateTable (p. 748)
DescribeTables (p. 759)
DeleteTable (p. 756)
AWS Glossary
For the latest AWS terminology, see the AWS Glossary in the AWS General Reference.