aws-elixir v0.4.0 AWS.DynamoDB
Amazon DynamoDB
Amazon DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability. DynamoDB lets you offload the administrative burdens of operating and scaling a distributed database, so that you don’t have to worry about hardware provisioning, setup and configuration, replication, software patching, or cluster scaling.
With DynamoDB, you can create database tables that can store and retrieve any amount of data, and serve any level of request traffic. You can scale up or scale down your tables’ throughput capacity without downtime or performance degradation, and use the AWS Management Console to monitor resource utilization and performance metrics.
DynamoDB automatically spreads the data and traffic for your tables over a sufficient number of servers to handle your throughput and storage requirements, while maintaining consistent and fast performance. All of your data is stored on solid state disks (SSDs) and automatically replicated across multiple Availability Zones in an AWS region, providing built-in high availability and data durability.
Summary
Functions
The BatchGetItem
operation returns the attributes of one or more items
from one or more tables. You identify requested items by primary key
The BatchWriteItem
operation puts or deletes multiple items in one or
more tables. A single call to BatchWriteItem
can write up to 16 MB of
data, which can comprise as many as 25 put or delete requests. Individual
items to be written can be as large as 400 KB
The CreateTable
operation adds a new table to your account. In an AWS
account, table names must be unique within each region. That is, you can
have two tables with same name if you create the tables in different
regions
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
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
. If the specified table does
not exist, DynamoDB returns a ResourceNotFoundException
. If table is
already in the DELETING
state, no error is returned
Returns the current provisioned-capacity limits for your AWS account in a region, both for the region as a whole and for any one DynamoDB table that you create there
Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table
Gives a description of the Time to Live (TTL) status on the specified table
The GetItem
operation returns a set of attributes for the item with the
given primary key. If there is no matching item, GetItem
does not return
any data and there will be no Item
element in the response
Returns an array of table names associated with the current account and
endpoint. The output from ListTables
is paginated, with each page
returning a maximum of 100 table names
List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10 times per second, per account
Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn’t exist), or replace an existing item if it has certain attribute values
A Query
operation uses the primary key of a table or a secondary index to
directly access items from that table or index
The Scan
operation returns one or more items and item attributes by
accessing every item in a table or a secondary index. To have DynamoDB
return fewer items, you can provide a FilterExpression
operation
Associate a set of tags with an Amazon DynamoDB resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. You can call TagResource up to 5 times per second, per account
Removes the association of tags from an Amazon DynamoDB resource. You can call UntagResource up to 5 times per second, per account
Edits an existing item’s attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (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)
Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table
Specify the lifetime of individual table items. The database automatically
removes the item at the expiration of the item. The UpdateTimeToLive method
will enable or disable TTL for the specified table. A successful
UpdateTimeToLive
call returns the current TimeToLiveSpecification
; it
may take up to one hour for the change to fully process
Functions
The BatchGetItem
operation returns the attributes of one or more items
from one or more tables. You identify requested items by primary key.
A single operation can retrieve up to 16 MB of data, which can contain as
many as 100 items. BatchGetItem
will return a partial result if the
response size limit is exceeded, the table’s provisioned throughput is
exceeded, or an internal processing failure occurs. If a partial result is
returned, the operation returns a value for UnprocessedKeys
. You can use
this value to retry the operation starting with the next item to get.
individual item is 300 KB in size, the system returns 52 items (so as not
to exceed the 16 MB limit). It also returns 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 data set.
If none of the items can be processed due to insufficient provisioned
throughput on all of the tables in the request, then BatchGetItem
will
return a ProvisionedThroughputExceededException
. If at least one of the
items is successfully processed, then BatchGetItem
completes
successfully, while returning the keys of the unread items in
UnprocessedKeys
.
reads on every table in the request. If you want strongly consistent reads
instead, you can set ConsistentRead
to true
for any or all tables.
In order to minimize response latency, BatchGetItem
retrieves items in
parallel.
When designing your application, keep in mind that DynamoDB does not return
items in any particular order. To help parse the response by item, include
the primary key values for the items in your request in the
ProjectionExpression
parameter.
If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see Capacity Units Calculations in the Amazon DynamoDB Developer Guide.
The BatchWriteItem
operation puts or deletes multiple items in one or
more tables. A single call to BatchWriteItem
can write up to 16 MB of
data, which can comprise as many as 25 put or delete requests. Individual
items to be written can be as large as 400 KB.
BatchWriteItem
are atomic; however BatchWriteItem
as a whole is not. If
any requested operations fail because the table’s provisioned throughput is
exceeded or an internal processing failure occurs, the failed operations
are returned in the UnprocessedItems
response parameter. You can
investigate and optionally resend the requests. Typically, you would call
BatchWriteItem
in a loop. Each iteration would check for unprocessed
items and submit a new BatchWriteItem
request with those unprocessed
items until all items have been processed.
Note that if none of the items can be processed due to insufficient
provisioned throughput on all of the tables in the request, then
BatchWriteItem
will return a ProvisionedThroughputExceededException
.
large amounts of data, such as from Amazon Elastic MapReduce (EMR), or copy
data from another database into DynamoDB. In order to improve performance
with these large-scale operations, BatchWriteItem
does not behave in the
same way as individual PutItem
and DeleteItem
calls would. For example,
you cannot specify conditions on individual put and delete requests, and
BatchWriteItem
does not return deleted items in the response.
If you use a programming language that supports concurrency, you can use
threads to write items in parallel. Your application must include the
necessary logic to manage the threads. With languages that don’t support
threading, you must update or delete the specified items one at a time. In
both situations, BatchWriteItem
performs the specified put and delete
operations in parallel, giving you the power of the thread pool approach
without having to introduce complexity into your application.
Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.
If one or more of the following is true, DynamoDB rejects the entire batch write operation:
- One or more tables specified in the `BatchWriteItem` request does not exist.
- Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema.
- 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.
- There are more than 25 requests in the batch.
- Any individual item in a batch exceeds 400 KB.
- The total request size exceeds 16 MB.
The CreateTable
operation adds a new table to your account. In an AWS
account, table names must be unique within each region. That is, you can
have two tables with same name if you create the tables in different
regions.
CreateTable
is an asynchronous operation. Upon receiving a CreateTable
request, DynamoDB immediately returns a response with a TableStatus
of
CREATING
. After the table is created, DynamoDB sets the TableStatus
to
ACTIVE
. You can perform read and write operations only on an ACTIVE
table.
You can optionally define secondary indexes on the new table, as part of
the CreateTable
operation. If you want to create multiple tables with
secondary indexes on them, you must create the tables sequentially. Only
one table with secondary indexes can be in the CREATING
state at any
given time.
You can use the DescribeTable
action to check the table status.
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.
In addition to deleting an item, you can also return the item’s attribute
values in the same operation, using the ReturnValues
parameter.
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 deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.
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
. If the specified table does
not exist, DynamoDB returns a ResourceNotFoundException
. If table is
already in the DELETING
state, no error is returned.
deleted.
If you have DynamoDB Streams enabled on the table, then the corresponding
stream on that table goes into the DISABLED
state, and the stream is
automatically deleted after 24 hours.
Use the DescribeTable
action to check the status of the table.
Returns the current provisioned-capacity limits for your AWS account in a region, both for the region as a whole and for any one DynamoDB table that you create there.
When you establish an AWS account, the account has initial limits on the maximum read capacity units and write capacity units that you can provision across all of your DynamoDB tables in a given region. Also, there are per-table limits that apply when you create a table there. For more information, see Limits page in the Amazon DynamoDB Developer Guide.
Although you can increase these limits by filing a case at AWS Support
Center, obtaining the
increase is not instantaneous. The DescribeLimits
action lets you write
code to compare the capacity you are currently using to those limits
imposed by your account so that you have enough time to apply for an
increase before you hit a limit.
For example, you could use one of the AWS SDKs to do the following:
- Call `DescribeLimits` for a particular region to obtain your current account limits on provisioned capacity there.
- Create a variable to hold the aggregate read capacity units provisioned for all your tables in that region, and one to hold the aggregate write capacity units. Zero them both.
- Call `ListTables` to obtain a list of all your DynamoDB tables.
- For each table name listed by `ListTables`, do the following:
- Call `DescribeTable` with the table name.
- Use the data returned by `DescribeTable` to add the read capacity units and write capacity units provisioned for the table itself to your variables.
- If the table has one or more global secondary indexes (GSIs), loop over these GSIs and add their provisioned capacity values to your variables as well.
- Report the account limits for that region returned by `DescribeLimits`, along with the total current provisioned capacity levels you have calculated.
Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.
Gives a description of the Time to Live (TTL) status on the specified table.
The GetItem
operation returns a set of attributes for the item with the
given primary key. If there is no matching item, GetItem
does not return
any data and there will be no Item
element in the response.
GetItem
provides an eventually consistent read by default. If your
application requires a strongly consistent read, set ConsistentRead
to
true
. Although a strongly consistent read might take more time than an
eventually consistent read, it always returns the last updated value.
Returns an array of table names associated with the current account and
endpoint. The output from ListTables
is paginated, with each page
returning a maximum of 100 table names.
List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10 times per second, per account.
For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.
Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn’t exist), or replace an existing item if it has certain attribute values.
In addition to putting an item, you can also return the item’s attribute
values in the same operation, using the ReturnValues
parameter.
When you add an item, the primary key attribute(s) are the only required
attributes. Attribute values cannot be null. String and Binary type
attributes must have lengths greater than zero. Set type attributes cannot
be empty. Requests with empty values will be rejected with a
ValidationException
exception.
Items](http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html) in the Amazon DynamoDB Developer Guide.
A Query
operation uses the primary key of a table or a secondary index to
directly access items from that table or index.
Use the KeyConditionExpression
parameter to provide a specific value for
the partition key. The Query
operation will return all of the items from
the table or index with that partition key value. You can optionally narrow
the scope of the Query
operation by specifying a sort key value and a
comparison operator in KeyConditionExpression
. You can use the
ScanIndexForward
parameter to get results in forward or reverse order, by
sort key.
Queries that do not return results consume the minimum number of read capacity units for that type of read operation.
If the total number of items meeting the query criteria exceeds the result
set size limit of 1 MB, the query stops and results are returned to the
user with the LastEvaluatedKey
element to continue the query in a
subsequent operation. Unlike a Scan
operation, a Query
operation never
returns both an empty result set and a LastEvaluatedKey
value.
LastEvaluatedKey
is only provided if you have used the Limit
parameter,
or if the result set exceeds 1 MB (prior to applying a filter).
You can query a table, a local secondary index, or a global secondary
index. For a query on a table or on a local secondary index, you can set
the ConsistentRead
parameter to true
and obtain a strongly consistent
result. Global secondary indexes support eventually consistent reads only,
so do not specify ConsistentRead
when querying a global secondary index.
The Scan
operation returns one or more items and item attributes by
accessing every item in a table or a secondary index. To have DynamoDB
return fewer items, you can provide a FilterExpression
operation.
If the total number of scanned items exceeds the maximum data set size
limit of 1 MB, the scan stops and results are returned to the user as a
LastEvaluatedKey
value 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.
By default, Scan
operations proceed sequentially; however, for faster
performance on a large table or secondary index, applications can request a
parallel Scan
operation by providing the Segment
and TotalSegments
parameters. For more information, see Parallel
Scan
in the Amazon DynamoDB Developer Guide.
By default, Scan
uses eventually consistent reads when accessing the data
in a table; therefore, the result set might not include the changes to data
in the table immediately before the operation began. If you need a
consistent copy of the data, as of the time that the Scan begins, you can
set the ConsistentRead
parameter to true
.
Associate a set of tags with an Amazon DynamoDB resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. You can call TagResource up to 5 times per second, per account.
For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.
Removes the association of tags from an Amazon DynamoDB resource. You can call UntagResource up to 5 times per second, per account.
For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.
Edits an existing item’s attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (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).
You can also return the item’s attribute values in the same UpdateItem
operation using the ReturnValues
parameter.
Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.
You can only perform one of the following operations at once:
- Modify the provisioned throughput settings of the table.
- Enable or disable Streams on the table.
- Remove a global secondary index from the table.
- Create a new global secondary index on the table. Once the index begins backfilling, you can use `UpdateTable` to perform other operations.
Specify the lifetime of individual table items. The database automatically
removes the item at the expiration of the item. The UpdateTimeToLive method
will enable or disable TTL for the specified table. A successful
UpdateTimeToLive
call returns the current TimeToLiveSpecification
; it
may take up to one hour for the change to fully process.
TTL compares the current time in epoch time format to the time stored in the TTL attribute of an item. If the epoch time value stored in the attribute is less than the current time, the item is marked as expired and subsequently deleted.
availability of throughput for other data operations.
Secondary Index and Global Secondary Index immediately in the same eventually consistent way as a standard delete operation.
For more information, see Time To Live in the Amazon DynamoDB Developer Guide.