@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonDynamoDBClient extends AmazonWebServiceClient implements AmazonDynamoDB
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AmazonDynamoDBClient()
Deprecated.
|
AmazonDynamoDBClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonDynamoDBClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AmazonDynamoDBClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AmazonDynamoDBClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonDynamoDBClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonDynamoDBClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AmazonDynamoDBClient(ClientConfiguration clientConfiguration)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
BatchGetItemResult |
batchGetItem(BatchGetItemRequest request)
The
BatchGetItem operation returns the attributes of one or more items from one or more tables. |
BatchGetItemResult |
batchGetItem(Map<String,KeysAndAttributes> requestItems)
Simplified method form for invoking the BatchGetItem operation.
|
BatchGetItemResult |
batchGetItem(Map<String,KeysAndAttributes> requestItems,
String returnConsumedCapacity)
Simplified method form for invoking the BatchGetItem operation.
|
BatchWriteItemResult |
batchWriteItem(BatchWriteItemRequest request)
The
BatchWriteItem operation puts or deletes multiple items in one or more tables. |
BatchWriteItemResult |
batchWriteItem(Map<String,List<WriteRequest>> requestItems)
Simplified method form for invoking the BatchWriteItem operation.
|
static AmazonDynamoDBClientBuilder |
builder() |
CreateTableResult |
createTable(CreateTableRequest request)
The
CreateTable operation adds a new table to your account. |
CreateTableResult |
createTable(List<AttributeDefinition> attributeDefinitions,
String tableName,
List<KeySchemaElement> keySchema,
ProvisionedThroughput provisionedThroughput)
Simplified method form for invoking the CreateTable operation.
|
DeleteItemResult |
deleteItem(DeleteItemRequest request)
Deletes a single item in a table by primary key.
|
DeleteItemResult |
deleteItem(String tableName,
Map<String,AttributeValue> key)
Simplified method form for invoking the DeleteItem operation.
|
DeleteItemResult |
deleteItem(String tableName,
Map<String,AttributeValue> key,
String returnValues)
Simplified method form for invoking the DeleteItem operation.
|
DeleteTableResult |
deleteTable(DeleteTableRequest request)
The
DeleteTable operation deletes a table and all of its items. |
DeleteTableResult |
deleteTable(String tableName)
Simplified method form for invoking the DeleteTable operation.
|
DescribeLimitsResult |
describeLimits(DescribeLimitsRequest request)
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.
|
DescribeTableResult |
describeTable(DescribeTableRequest request)
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.
|
DescribeTableResult |
describeTable(String tableName)
Simplified method form for invoking the DescribeTable operation.
|
DescribeTimeToLiveResult |
describeTimeToLive(DescribeTimeToLiveRequest request)
Gives a description of the Time to Live (TTL) status on the specified table.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetItemResult |
getItem(GetItemRequest request)
The
GetItem operation returns a set of attributes for the item with the given primary key. |
GetItemResult |
getItem(String tableName,
Map<String,AttributeValue> key)
Simplified method form for invoking the GetItem operation.
|
GetItemResult |
getItem(String tableName,
Map<String,AttributeValue> key,
Boolean consistentRead)
Simplified method form for invoking the GetItem operation.
|
ListTablesResult |
listTables()
Simplified method form for invoking the ListTables operation.
|
ListTablesResult |
listTables(Integer limit)
Simplified method form for invoking the ListTables operation.
|
ListTablesResult |
listTables(ListTablesRequest request)
Returns an array of table names associated with the current account and endpoint.
|
ListTablesResult |
listTables(String exclusiveStartTableName)
Simplified method form for invoking the ListTables operation.
|
ListTablesResult |
listTables(String exclusiveStartTableName,
Integer limit)
Simplified method form for invoking the ListTables operation.
|
ListTagsOfResourceResult |
listTagsOfResource(ListTagsOfResourceRequest request)
List all tags on an Amazon DynamoDB resource.
|
PutItemResult |
putItem(PutItemRequest request)
Creates a new item, or replaces an old item with a new item.
|
PutItemResult |
putItem(String tableName,
Map<String,AttributeValue> item)
Simplified method form for invoking the PutItem operation.
|
PutItemResult |
putItem(String tableName,
Map<String,AttributeValue> item,
String returnValues)
Simplified method form for invoking the PutItem operation.
|
QueryResult |
query(QueryRequest request)
The
Query operation finds items based on primary key values. |
ScanResult |
scan(ScanRequest request)
The
Scan operation returns one or more items and item attributes by accessing every item in a table
or a secondary index. |
ScanResult |
scan(String tableName,
List<String> attributesToGet)
Simplified method form for invoking the Scan operation.
|
ScanResult |
scan(String tableName,
List<String> attributesToGet,
Map<String,Condition> scanFilter)
Simplified method form for invoking the Scan operation.
|
ScanResult |
scan(String tableName,
Map<String,Condition> scanFilter)
Simplified method form for invoking the Scan operation.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Associate a set of tags with an Amazon DynamoDB resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes the association of tags from an Amazon DynamoDB resource.
|
UpdateItemResult |
updateItem(String tableName,
Map<String,AttributeValue> key,
Map<String,AttributeValueUpdate> attributeUpdates)
Simplified method form for invoking the UpdateItem operation.
|
UpdateItemResult |
updateItem(String tableName,
Map<String,AttributeValue> key,
Map<String,AttributeValueUpdate> attributeUpdates,
String returnValues)
Simplified method form for invoking the UpdateItem operation.
|
UpdateItemResult |
updateItem(UpdateItemRequest request)
Edits an existing item's attributes, or adds a new item to the table if it does not already exist.
|
UpdateTableResult |
updateTable(String tableName,
ProvisionedThroughput provisionedThroughput)
Simplified method form for invoking the UpdateTable operation.
|
UpdateTableResult |
updateTable(UpdateTableRequest request)
Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given
table.
|
UpdateTimeToLiveResult |
updateTimeToLive(UpdateTimeToLiveRequest request)
The UpdateTimeToLive method will enable or disable TTL for the specified table.
|
AmazonDynamoDBWaiters |
waiters() |
addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion@Deprecated public AmazonDynamoDBClient()
AmazonDynamoDBClientBuilder.defaultClient()All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AmazonDynamoDBClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client connects to DynamoDB (ex: proxy settings,
retry counts, etc.).DefaultAWSCredentialsProviderChain@Deprecated public AmazonDynamoDBClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonDynamoDBClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AmazonDynamoDBClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - The client configuration options controlling how this client connects to DynamoDB (ex: proxy settings,
retry counts, etc.).@Deprecated public AmazonDynamoDBClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AmazonDynamoDBClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to DynamoDB (ex: proxy settings,
retry counts, etc.).@Deprecated public AmazonDynamoDBClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to DynamoDB (ex: proxy settings,
retry counts, etc.).requestMetricCollector - optional request metric collectorpublic static AmazonDynamoDBClientBuilder builder()
public BatchGetItemResult batchGetItem(BatchGetItemRequest request)
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.
If you request more than 100 items BatchGetItem will return a ValidationException with
the message "Too many items requested for the BatchGetItem call".
For example, if you ask to retrieve 100 items, but each 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.
If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.
For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.
By default, BatchGetItem performs eventually consistent 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.
batchGetItem in interface AmazonDynamoDBbatchGetItemRequest - Represents the input of a BatchGetItem operation.ProvisionedThroughputExceededException - Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this
exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce
the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.ResourceNotFoundException - The operation tried to access a nonexistent table or index. The resource might not be specified
correctly, or its status might not be ACTIVE.InternalServerErrorException - An error occurred on the server side.public BatchGetItemResult batchGetItem(Map<String,KeysAndAttributes> requestItems, String returnConsumedCapacity)
AmazonDynamoDBbatchGetItem in interface AmazonDynamoDBAmazonDynamoDB.batchGetItem(BatchGetItemRequest)public BatchGetItemResult batchGetItem(Map<String,KeysAndAttributes> requestItems)
AmazonDynamoDBbatchGetItem in interface AmazonDynamoDBAmazonDynamoDB.batchGetItem(BatchGetItemRequest)public BatchWriteItemResult batchWriteItem(BatchWriteItemRequest request)
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 cannot update items. To update items, use the UpdateItem action.
The individual PutItem and DeleteItem operations specified in
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.
If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.
For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.
With BatchWriteItem, you can efficiently write or delete 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.
batchWriteItem in interface AmazonDynamoDBbatchWriteItemRequest - Represents the input of a BatchWriteItem operation.ProvisionedThroughputExceededException - Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this
exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce
the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.ResourceNotFoundException - The operation tried to access a nonexistent table or index. The resource might not be specified
correctly, or its status might not be ACTIVE.ItemCollectionSizeLimitExceededException - An item collection is too large. This exception is only returned for tables that have one or more local
secondary indexes.InternalServerErrorException - An error occurred on the server side.public BatchWriteItemResult batchWriteItem(Map<String,List<WriteRequest>> requestItems)
AmazonDynamoDBbatchWriteItem in interface AmazonDynamoDBAmazonDynamoDB.batchWriteItem(BatchWriteItemRequest)public CreateTableResult createTable(CreateTableRequest request)
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.
createTable in interface AmazonDynamoDBcreateTableRequest - Represents the input of a CreateTable operation.ResourceInUseException - The operation conflicts with the resource's availability. For example, you attempted to recreate an
existing table, or tried to delete a table currently in the CREATING state.LimitExceededException - The number of concurrent table requests (cumulative number of tables in the CREATING,
DELETING or UPDATING state) exceeds the maximum allowed of 10.
Also, for tables with secondary indexes, only one of those tables can be in the CREATING
state at any point in time. Do not attempt to create more than one such table simultaneously.
The total limit of tables in the ACTIVE state is 250.
InternalServerErrorException - An error occurred on the server side.public CreateTableResult createTable(List<AttributeDefinition> attributeDefinitions, String tableName, List<KeySchemaElement> keySchema, ProvisionedThroughput provisionedThroughput)
AmazonDynamoDBcreateTable in interface AmazonDynamoDBAmazonDynamoDB.createTable(CreateTableRequest)public DeleteItemResult deleteItem(DeleteItemRequest request)
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.
deleteItem in interface AmazonDynamoDBdeleteItemRequest - Represents the input of a DeleteItem operation.ConditionalCheckFailedException - A condition specified in the operation could not be evaluated.ProvisionedThroughputExceededException - Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this
exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce
the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.ResourceNotFoundException - The operation tried to access a nonexistent table or index. The resource might not be specified
correctly, or its status might not be ACTIVE.ItemCollectionSizeLimitExceededException - An item collection is too large. This exception is only returned for tables that have one or more local
secondary indexes.InternalServerErrorException - An error occurred on the server side.public DeleteItemResult deleteItem(String tableName, Map<String,AttributeValue> key)
AmazonDynamoDBdeleteItem in interface AmazonDynamoDBAmazonDynamoDB.deleteItem(DeleteItemRequest)public DeleteItemResult deleteItem(String tableName, Map<String,AttributeValue> key, String returnValues)
AmazonDynamoDBdeleteItem in interface AmazonDynamoDBAmazonDynamoDB.deleteItem(DeleteItemRequest)public DeleteTableResult deleteTable(DeleteTableRequest request)
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.
DynamoDB might continue to accept data read and write operations, such as GetItem and
PutItem, on a table in the DELETING state until the table deletion is complete.
When you delete a table, any indexes on that table are also 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.
deleteTable in interface AmazonDynamoDBdeleteTableRequest - Represents the input of a DeleteTable operation.ResourceInUseException - The operation conflicts with the resource's availability. For example, you attempted to recreate an
existing table, or tried to delete a table currently in the CREATING state.ResourceNotFoundException - The operation tried to access a nonexistent table or index. The resource might not be specified
correctly, or its status might not be ACTIVE.LimitExceededException - The number of concurrent table requests (cumulative number of tables in the CREATING,
DELETING or UPDATING state) exceeds the maximum allowed of 10.
Also, for tables with secondary indexes, only one of those tables can be in the CREATING
state at any point in time. Do not attempt to create more than one such table simultaneously.
The total limit of tables in the ACTIVE state is 250.
InternalServerErrorException - An error occurred on the server side.public DeleteTableResult deleteTable(String tableName)
AmazonDynamoDBdeleteTable in interface AmazonDynamoDBAmazonDynamoDB.deleteTable(DeleteTableRequest)public DescribeLimitsResult describeLimits(DescribeLimitsRequest request)
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.
This will let you see whether you are getting close to your account-level limits.
The per-table limits apply only when you are creating a new table. They restrict the sum of the provisioned capacity of the new table itself and all its global secondary indexes.
For existing tables and their GSIs, DynamoDB will not let you increase provisioned capacity extremely rapidly, but the only upper limit that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account limits.
DescribeLimits should only be called periodically. You can expect throttling errors if you call it
more than once in a minute.
The DescribeLimits Request element has no content.
describeLimits in interface AmazonDynamoDBdescribeLimitsRequest - Represents the input of a DescribeLimits operation. Has no content.InternalServerErrorException - An error occurred on the server side.public DescribeTableResult describeTable(DescribeTableRequest request)
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.
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.
describeTable in interface AmazonDynamoDBdescribeTableRequest - Represents the input of a DescribeTable operation.ResourceNotFoundException - The operation tried to access a nonexistent table or index. The resource might not be specified
correctly, or its status might not be ACTIVE.InternalServerErrorException - An error occurred on the server side.public DescribeTableResult describeTable(String tableName)
AmazonDynamoDBdescribeTable in interface AmazonDynamoDBAmazonDynamoDB.describeTable(DescribeTableRequest)public DescribeTimeToLiveResult describeTimeToLive(DescribeTimeToLiveRequest request)
Gives a description of the Time to Live (TTL) status on the specified table.
describeTimeToLive in interface AmazonDynamoDBdescribeTimeToLiveRequest - ResourceNotFoundException - The operation tried to access a nonexistent table or index. The resource might not be specified
correctly, or its status might not be ACTIVE.InternalServerErrorException - An error occurred on the server side.public GetItemResult getItem(GetItemRequest request)
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.
getItem in interface AmazonDynamoDBgetItemRequest - Represents the input of a GetItem operation.ProvisionedThroughputExceededException - Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this
exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce
the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.ResourceNotFoundException - The operation tried to access a nonexistent table or index. The resource might not be specified
correctly, or its status might not be ACTIVE.InternalServerErrorException - An error occurred on the server side.public GetItemResult getItem(String tableName, Map<String,AttributeValue> key)
AmazonDynamoDBgetItem in interface AmazonDynamoDBAmazonDynamoDB.getItem(GetItemRequest)public GetItemResult getItem(String tableName, Map<String,AttributeValue> key, Boolean consistentRead)
AmazonDynamoDBgetItem in interface AmazonDynamoDBAmazonDynamoDB.getItem(GetItemRequest)public ListTablesResult listTables(ListTablesRequest request)
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.
listTables in interface AmazonDynamoDBlistTablesRequest - Represents the input of a ListTables operation.InternalServerErrorException - An error occurred on the server side.public ListTablesResult listTables()
AmazonDynamoDBlistTables in interface AmazonDynamoDBAmazonDynamoDB.listTables(ListTablesRequest)public ListTablesResult listTables(String exclusiveStartTableName)
AmazonDynamoDBlistTables in interface AmazonDynamoDBAmazonDynamoDB.listTables(ListTablesRequest)public ListTablesResult listTables(String exclusiveStartTableName, Integer limit)
AmazonDynamoDBlistTables in interface AmazonDynamoDBAmazonDynamoDB.listTables(ListTablesRequest)public ListTablesResult listTables(Integer limit)
AmazonDynamoDBlistTables in interface AmazonDynamoDBAmazonDynamoDB.listTables(ListTablesRequest)public ListTagsOfResourceResult listTagsOfResource(ListTagsOfResourceRequest request)
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.
listTagsOfResource in interface AmazonDynamoDBlistTagsOfResourceRequest - ResourceNotFoundException - The operation tried to access a nonexistent table or index. The resource might not be specified
correctly, or its status might not be ACTIVE.InternalServerErrorException - An error occurred on the server side.public PutItemResult putItem(PutItemRequest request)
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. You can return the item's attribute values in the same
operation, using the ReturnValues parameter.
This topic provides general information about the PutItem API.
For information on how to call the PutItem API using the AWS SDK in specific languages, see the
following:
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.
To prevent a new item from replacing an existing item, use a conditional expression that contains the
attribute_not_exists function with the name of the attribute being used as the partition key for the
table. Since every record must contain that attribute, the attribute_not_exists function will only
succeed if no matching item exists.
For more information about PutItem, see Working with
Items in the Amazon DynamoDB Developer Guide.
putItem in interface AmazonDynamoDBputItemRequest - Represents the input of a PutItem operation.ConditionalCheckFailedException - A condition specified in the operation could not be evaluated.ProvisionedThroughputExceededException - Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this
exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce
the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.ResourceNotFoundException - The operation tried to access a nonexistent table or index. The resource might not be specified
correctly, or its status might not be ACTIVE.ItemCollectionSizeLimitExceededException - An item collection is too large. This exception is only returned for tables that have one or more local
secondary indexes.InternalServerErrorException - An error occurred on the server side.public PutItemResult putItem(String tableName, Map<String,AttributeValue> item)
AmazonDynamoDBputItem in interface AmazonDynamoDBAmazonDynamoDB.putItem(PutItemRequest)public PutItemResult putItem(String tableName, Map<String,AttributeValue> item, String returnValues)
AmazonDynamoDBputItem in interface AmazonDynamoDBAmazonDynamoDB.putItem(PutItemRequest)public QueryResult query(QueryRequest request)
The Query operation finds items based on primary key values. You can query any table or secondary
index that has a composite primary key (a partition key and a sort key).
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. To further refine the Query results, you
can optionally provide a FilterExpression. A FilterExpression determines which items
within the results should be returned to you. All of the other results are discarded.
A Query operation always returns a result set. If no matching items are found, the result set will
be empty. Queries that do not return results consume the minimum number of read capacity units for that type of
read operation.
DynamoDB calculates the number of read capacity units consumed based on item size, not on the amount of data that
is returned to an application. 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 a projection expression). The number will also
be the same whether or not you use a FilterExpression.
Query results are always sorted by the sort key value. If the data type of the sort key is Number,
the results are returned in numeric order; otherwise, the results are returned in order of UTF-8 bytes. By
default, the sort order is ascending. To reverse the order, set the ScanIndexForward parameter to
false.
A single Query operation will read up to the maximum number of items set (if using the
Limit parameter) or a maximum of 1 MB of data and then apply any filtering to the results using
FilterExpression. If LastEvaluatedKey is present in the response, you will need to
paginate the result set. For more information, see Paginating the
Results in the Amazon DynamoDB Developer Guide.
FilterExpression is applied after a Query finishes, but before the results are
returned. A FilterExpression cannot contain partition key or sort key attributes. You need to
specify those attributes in the KeyConditionExpression.
A Query operation can return an empty result set and a LastEvaluatedKey if all the
items read for the page of results are filtered out.
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.
query in interface AmazonDynamoDBqueryRequest - Represents the input of a Query operation.ProvisionedThroughputExceededException - Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this
exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce
the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.ResourceNotFoundException - The operation tried to access a nonexistent table or index. The resource might not be specified
correctly, or its status might not be ACTIVE.InternalServerErrorException - An error occurred on the server side.public ScanResult scan(ScanRequest request)
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.
A single Scan operation will read up to the maximum number of items set (if using the
Limit parameter) or a maximum of 1 MB of data and then apply any filtering to the results using
FilterExpression. If LastEvaluatedKey is present in the response, you will need to
paginate the result set. For more information, see Paginating the
Results in the Amazon DynamoDB Developer Guide.
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.
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.
scan in interface AmazonDynamoDBscanRequest - Represents the input of a Scan operation.ProvisionedThroughputExceededException - Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this
exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce
the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.ResourceNotFoundException - The operation tried to access a nonexistent table or index. The resource might not be specified
correctly, or its status might not be ACTIVE.InternalServerErrorException - An error occurred on the server side.public ScanResult scan(String tableName, List<String> attributesToGet)
AmazonDynamoDBscan in interface AmazonDynamoDBAmazonDynamoDB.scan(ScanRequest)public ScanResult scan(String tableName, Map<String,Condition> scanFilter)
AmazonDynamoDBscan in interface AmazonDynamoDBAmazonDynamoDB.scan(ScanRequest)public ScanResult scan(String tableName, List<String> attributesToGet, Map<String,Condition> scanFilter)
AmazonDynamoDBscan in interface AmazonDynamoDBAmazonDynamoDB.scan(ScanRequest)public TagResourceResult tagResource(TagResourceRequest request)
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.
tagResource in interface AmazonDynamoDBtagResourceRequest - LimitExceededException - The number of concurrent table requests (cumulative number of tables in the CREATING,
DELETING or UPDATING state) exceeds the maximum allowed of 10.
Also, for tables with secondary indexes, only one of those tables can be in the CREATING
state at any point in time. Do not attempt to create more than one such table simultaneously.
The total limit of tables in the ACTIVE state is 250.
ResourceNotFoundException - The operation tried to access a nonexistent table or index. The resource might not be specified
correctly, or its status might not be ACTIVE.InternalServerErrorException - An error occurred on the server side.ResourceInUseException - The operation conflicts with the resource's availability. For example, you attempted to recreate an
existing table, or tried to delete a table currently in the CREATING state.public UntagResourceResult untagResource(UntagResourceRequest request)
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.
untagResource in interface AmazonDynamoDBuntagResourceRequest - LimitExceededException - The number of concurrent table requests (cumulative number of tables in the CREATING,
DELETING or UPDATING state) exceeds the maximum allowed of 10.
Also, for tables with secondary indexes, only one of those tables can be in the CREATING
state at any point in time. Do not attempt to create more than one such table simultaneously.
The total limit of tables in the ACTIVE state is 250.
ResourceNotFoundException - The operation tried to access a nonexistent table or index. The resource might not be specified
correctly, or its status might not be ACTIVE.InternalServerErrorException - An error occurred on the server side.ResourceInUseException - The operation conflicts with the resource's availability. For example, you attempted to recreate an
existing table, or tried to delete a table currently in the CREATING state.public UpdateItemResult updateItem(UpdateItemRequest request)
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.
updateItem in interface AmazonDynamoDBupdateItemRequest - Represents the input of an UpdateItem operation.ConditionalCheckFailedException - A condition specified in the operation could not be evaluated.ProvisionedThroughputExceededException - Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this
exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce
the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.ResourceNotFoundException - The operation tried to access a nonexistent table or index. The resource might not be specified
correctly, or its status might not be ACTIVE.ItemCollectionSizeLimitExceededException - An item collection is too large. This exception is only returned for tables that have one or more local
secondary indexes.InternalServerErrorException - An error occurred on the server side.public UpdateItemResult updateItem(String tableName, Map<String,AttributeValue> key, Map<String,AttributeValueUpdate> attributeUpdates)
AmazonDynamoDBupdateItem in interface AmazonDynamoDBAmazonDynamoDB.updateItem(UpdateItemRequest)public UpdateItemResult updateItem(String tableName, Map<String,AttributeValue> key, Map<String,AttributeValueUpdate> attributeUpdates, String returnValues)
AmazonDynamoDBupdateItem in interface AmazonDynamoDBAmazonDynamoDB.updateItem(UpdateItemRequest)public UpdateTableResult updateTable(UpdateTableRequest request)
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.
UpdateTable is an asynchronous operation; while it is executing, the table status changes from
ACTIVE to UPDATING. While it is UPDATING, you cannot issue another
UpdateTable request. When the table returns to the ACTIVE state, the
UpdateTable operation is complete.
updateTable in interface AmazonDynamoDBupdateTableRequest - Represents the input of an UpdateTable operation.ResourceInUseException - The operation conflicts with the resource's availability. For example, you attempted to recreate an
existing table, or tried to delete a table currently in the CREATING state.ResourceNotFoundException - The operation tried to access a nonexistent table or index. The resource might not be specified
correctly, or its status might not be ACTIVE.LimitExceededException - The number of concurrent table requests (cumulative number of tables in the CREATING,
DELETING or UPDATING state) exceeds the maximum allowed of 10.
Also, for tables with secondary indexes, only one of those tables can be in the CREATING
state at any point in time. Do not attempt to create more than one such table simultaneously.
The total limit of tables in the ACTIVE state is 250.
InternalServerErrorException - An error occurred on the server side.public UpdateTableResult updateTable(String tableName, ProvisionedThroughput provisionedThroughput)
AmazonDynamoDBupdateTable in interface AmazonDynamoDBAmazonDynamoDB.updateTable(UpdateTableRequest)public UpdateTimeToLiveResult updateTimeToLive(UpdateTimeToLiveRequest request)
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. Any additional UpdateTimeToLive calls for the same table
during this one hour duration result in a ValidationException.
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.
The epoch time format is the number of seconds elapsed since 12:00:00 AM January 1st, 1970 UTC.
DynamoDB deletes expired items on a best-effort basis to ensure availability of throughput for other data operations.
DynamoDB typically deletes expired items within two days of expiration. The exact duration within which an item gets deleted after expiration is specific to the nature of the workload. Items that have expired and not been deleted will still show up in reads, queries, and scans.
As items are deleted, they are removed from any Local 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.
updateTimeToLive in interface AmazonDynamoDBupdateTimeToLiveRequest - Represents the input of an UpdateTimeToLive operation.ResourceInUseException - The operation conflicts with the resource's availability. For example, you attempted to recreate an
existing table, or tried to delete a table currently in the CREATING state.ResourceNotFoundException - The operation tried to access a nonexistent table or index. The resource might not be specified
correctly, or its status might not be ACTIVE.LimitExceededException - The number of concurrent table requests (cumulative number of tables in the CREATING,
DELETING or UPDATING state) exceeds the maximum allowed of 10.
Also, for tables with secondary indexes, only one of those tables can be in the CREATING
state at any point in time. Do not attempt to create more than one such table simultaneously.
The total limit of tables in the ACTIVE state is 250.
InternalServerErrorException - An error occurred on the server side.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata in interface AmazonDynamoDBrequest - The originally executed requestpublic AmazonDynamoDBWaiters waiters()
waiters in interface AmazonDynamoDBpublic void shutdown()
AmazonWebServiceClientshutdown in interface AmazonDynamoDBshutdown in class AmazonWebServiceClientCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.