Amazon DynamoDB - Developer Guide - AWS Documentation

1 Amazon DynamoDBDeveloper GuideAPI Version 2012-08-10 Amazon DynamoDB Developer GuideAmazon DynamoDB : Developer GuideCopyright 2018 Amazon Web Services, Inc. and/or its affiliates. All rights 's trademarks and trade dress may not be used in connection with any product or service that is not Amazon 's, in any mannerthat is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon . All other trademarks notowned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored DynamoDB Developer GuideTable of ContentsWhat Is Amazon DynamoDB ? .. 1 How It Works .. 2 Core Components .. 2 The DynamoDB API.. 9 Naming Rules and Data Types .. 11 Read Consistency .. 15 Throughput Capacity .. 15 Partitions and Data Distribution .. 18 From SQL to NoSQL .. 20 SQL or NoSQL? .. 21 Accessing the Database .. 22 Creating a Table.

2 24 Getting Information About a Table .. 26 Writing Data To a Table .. 27 Reading Data From a Table .. 29 Managing Indexes .. 34 Modifying Data in a Table .. 37 Deleting Data from a Table .. 38 Removing a Table .. 39 Setting Up DynamoDB .. 41 Setting Up DynamoDB Local (Downloadable Version) .. 41 DynamoDB (Downloadable Version) on Your Computer .. 41 DynamoDB (Downloadable Version) and Apache Maven .. 43 DynamoDB (Downloadable Version) and Docker .. 43 Usage Notes.. 44 Setting Up DynamoDB (Web Service) .. 46 Signing Up for AWS .. 46 Getting an AWS Access Key .. 47 Configuring Your Credentials .. 47 Accessing DynamoDB .. 49 Using the Console.. 49 Working with User Preferences .. 50 Using the CLI.. 51 Downloading and Configuring the AWS CLI .. 51 Using the AWS CLI with DynamoDB .. 51 Using the AWS CLI with Downloadable DynamoDB .. 52 Using the API.

3 53 Getting Started with DynamoDB .. 54 Java and DynamoDB .. 54 Tutorial Prerequisites .. 54 Step 1: Create a Table .. 55 Step 2: Load Sample Data.. 56 Step 3: Create, Read, Update, and Delete an Item.. 58 Step 4: Query and Scan the Data .. 66 Step 5: (Optional) Delete the Table .. 70 Summary .. 70 JavaScript and DynamoDB .. 71 Tutorial Prerequisites .. 71 Step 1: Create a Table .. 72 Step 2: Load Sample Data.. 74 Step 3: Create, Read, Update, and Delete an Item.. 76 Step 4: Query and Scan the Data .. 85 Step 5: (Optional): Delete the Table .. 89 Summary .. 90 API Version 2012-08-10iiiAmazon DynamoDB Developer and DynamoDB .. 91 Tutorial Prerequisites .. 91 Step 1: Create a Table .. 91 Step 2: Load Sample Data.. 92 Step 3: Create, Read, Update, and Delete an Item.. 94 Step 4: Query and Scan the Data .. 101 Step 5: (Optional): Delete the Table.

4 104 Summary .. and DynamoDB .. 105 Tutorial Prerequisites .. 106 Step 1: Create a Table .. 106 Step 2: Load Sample Data.. 108 Step 3: Create, Read, Update, and Delete an Item.. 111 Step 4: Query and Scan the Data .. 124 Step 5: (Optional) Delete the Table .. 132 Summary .. 133 PHP and DynamoDB .. 134 Tutorial Prerequisites .. 134 Step 1: Create a Table .. 134 Step 2: Load Sample Data.. 136 Step 3: Create, Read, Update, and Delete an Item.. 138 Step 4: Query and Scan the Data .. 146 Step 5: (Optional) Delete the Table .. 150 Summary .. 151 Python and DynamoDB .. 151 Tutorial Prerequisites .. 152 Step 1: Create a Table .. 152 Step 2: Load Sample Data.. 153 Step 3: Create, Read, Update, and Delete an Item.. 155 Step 4: Query and Scan the Data .. 162 Step 5: (Optional) Delete the Table .. 165 Summary .. 166 Ruby and DynamoDB .. 166 Tutorial Prerequisites.

5 166 Step 1: Create a Table .. 167 Step 2: Load Sample Data.. 168 Step 3: Create, Read, Update, and Delete an Item.. 170 Step 4: Query and Scan the Data .. 177 Step 5: (Optional) Delete the Table .. 180 Summary .. 181 Programming with DynamoDB .. 182 Overview of AWS SDK Support for DynamoDB .. 182 Programmatic Interfaces .. 184 Low-Level Interfaces .. 184 Document Interfaces .. 185 Object Persistence Interface .. 186 DynamoDB Low-Level API .. 187 Request Format .. 189 Response Format .. 189 Data Type Descriptors .. 190 Numeric Data.. 191 Binary Data .. 191 Error Handling .. 191 Error Components .. 191 Error Messages and Codes .. 192 Error Handling in Your Application .. 194 Error Retries and Exponential Backoff.. 195 API Version 2012-08-10ivAmazon DynamoDB Developer GuideBatch Operations and Error Handling .. 196 Higher-Level Programming Interfaces for DynamoDB .

6 196 Java: DynamoDBMapper .. : Document Model .. : Object Persistence Model .. 255 Running the Code Samples.. 282 Load Sample Data.. 283 Java Code Samples .. Code Samples.. 290 Working with DynamoDB .. 293 Working with Tables .. 293 Basic Operations for Tables .. 293 Throughput Settings for Reads and Writes .. 296 Item Sizes and Capacity Unit Consumption .. 299 Managing Throughput Capacity with Auto Scaling .. 301 Tagging for DynamoDB .. 315 Working with Tables: Java .. 317 Working with Tables: .NET .. 322 Working with Items .. 328 Reading an Item.. 329 Writing an Item.. 330 Return Values .. 331 Batch Operations.. 332 Atomic Counters.. 334 Conditional Writes .. 335 Using Expressions in DynamoDB .. 339 Time To Live .. 362 Working with Items: Java .. 368 Working with Items: .NET .. 387 Working with Queries .. 410 Key Condition Expression.

7 410 Filter Expressions for Query.. 412 Limiting the Number of Items in the Result Set .. 413 Paginating the Results .. 413 Counting the Items in the Results .. 414 Capacity Units Consumed by Query.. 414 Read Consistency for Query.. 415 Querying: Java .. 415 Querying: .NET .. 420 Working with Scans .. 427 Filter Expressions for Scan.. 427 Limiting the Number of Items in the Result Set .. 428 Paginating the Results .. 428 Counting the Items in the Results .. 429 Capacity Units Consumed by Scan.. 429 Read Consistency for Scan.. 430 Parallel Scan .. 430 Scanning: Java .. 431 Scanning: .NET.. 438 Working with Indexes .. 446 Global Secondary Indexes .. 448 Local Secondary Indexes .. 484 Working with Streams .. 519 Endpoints for DynamoDB Streams .. 520 Enabling a Stream.. 520 Reading and Processing a Stream.. 521 DynamoDB Streams and Time To Live.

8 523 API Version 2012-08-10vAmazon DynamoDB Developer GuideUsing the DynamoDB Streams Kinesis Adapter to Process Stream Records .. 524 DynamoDB Streams Low-Level API: Java Example .. 535 Cross-Region Replication .. 539 DynamoDB Streams and AWS Lambda Triggers .. 539On-Demand Backup and Restore .. 548 How It Works .. 548 Backups.. 548 Restores .. 549 Backing Up a Table .. 550 Creating a Table Backup (Console) .. 550 Creating a Table Backup (AWS CLI) .. 551 Restoring a Table from a Backup .. 552 Restoring a Table from a Backup (Console) .. 552 Restoring a Table from a Backup (AWS CLI) .. 553 Deleting a Table Backup .. 554 Deleting a Table Backup (Console) .. 554 Deleting a Table Backup (AWS CLI) .. 555 Using IAM.. 556 Example 1: Allow the CreateBackup and RestoreTableFromBackup Actions .. 556 Example 2: Allow CreateBackup and Deny RestoreTableFromBackup .. 556 Example 3: Allow ListBackups and Deny CreateBackup and RestoreTableFromBackup.

9 557 Example 4: Allow ListBackups and Deny DeleteBackup .. 557 Example 5: Allow RestoreTableFromBackup and DescribeBackup for All Resources and DenyDeleteBackup for a Specific Backup.. 558 Example 6: Allow CreateBackup for a Specific Table .. 558 Example 7: Allow ListBackups .. 559 Point-in-Time Recovery .. 560 How It Works .. 560 Before You Begin .. 561 Restoring a Table To a Point in Time .. 561 Restoring a Table to a Point in Time (Console) .. 562 Restoring a Table to a Point in Time (AWS CLI) .. 562 Global Tables .. 564 How It Works .. 564 Global Table Concepts .. 564 Consistency and Conflict Resolution .. 565 Availability and Durability .. 566 Requirements and Best Practices .. 566 Requirements for Adding a New Replica Table .. 566 Best Practices and Requirements for Managing Capacity .. 567 Creating a Global Table .. 567 Creating a Global Table (Console).

10 568 Creating a Global Table (AWS CLI) .. 568 Monitoring Global Tables .. 570 Using IAM with Global Tables .. 571.. 571 Example: Allow the CreateGlobalTable Action .. 571 Example: Allow the UpdateGlobalTable, DescribeLimits, application-autoscaling:DeleteScalingPol icy and application-autoscaling:DeregisterScalab leTarget Actions .. 572 Encryption at Rest .. 573 How It Works .. 573 Before You Begin .. 574 Enabling Encryption at Rest .. 575 Enabling Encryption at Rest (Console) .. 575 Enabling Encryption at Rest (AWS CLI) .. 575In-Memory Acceleration with DAX .. 577 API Version 2012-08-10viAmazon DynamoDB Developer GuideUse Cases for DAX .. 577 Usage Notes.. 578 Concepts .. 579 How DAX Processes Requests .. 579 Item Cache.. 580 Query Cache .. 581 DAX Cluster Components .. 581 Nodes.. 582 Clusters.. 582 Regions and Availability Zones .. 583 Parameter Groups.