Did this page help you?

   Yes   No   Tell us about it...

com.amazonaws.services.dynamodbv2
Class AmazonDynamoDBClient

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceClient
      extended by com.amazonaws.services.dynamodbv2.AmazonDynamoDBClient
All Implemented Interfaces:
AmazonDynamoDB
Direct Known Subclasses:
AmazonDynamoDBAsyncClient

public class AmazonDynamoDBClient
extends AmazonWebServiceClient
implements AmazonDynamoDB

Client for accessing AmazonDynamoDBv2. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon DynamoDB Overview

This is the Amazon DynamoDB API Reference. This guide provides descriptions and samples of the Amazon DynamoDB API.


Constructor Summary
AmazonDynamoDBClient()
          Constructs a new client to invoke service methods on AmazonDynamoDBv2.
AmazonDynamoDBClient(AWSCredentials awsCredentials)
          Constructs a new client to invoke service methods on AmazonDynamoDBv2 using the specified AWS account credentials.
AmazonDynamoDBClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
          Constructs a new client to invoke service methods on AmazonDynamoDBv2 using the specified AWS account credentials and client configuration options.
AmazonDynamoDBClient(AWSCredentialsProvider awsCredentialsProvider)
          Constructs a new client to invoke service methods on AmazonDynamoDBv2 using the specified AWS account credentials provider.
AmazonDynamoDBClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
          Constructs a new client to invoke service methods on AmazonDynamoDBv2 using the specified AWS account credentials provider and client configuration options.
AmazonDynamoDBClient(ClientConfiguration clientConfiguration)
          Constructs a new client to invoke service methods on AmazonDynamoDBv2.
 
Method Summary
 BatchGetItemResult batchGetItem(BatchGetItemRequest batchGetItemRequest)
           The BatchGetItem operation returns the attributes of one or more items from one or more tables.
 BatchWriteItemResult batchWriteItem(BatchWriteItemRequest batchWriteItemRequest)
           The BatchWriteItem operation puts or deletes multiple items in one or more tables.
 CreateTableResult createTable(CreateTableRequest createTableRequest)
           The CreateTable operation adds a new table to your account.
 DeleteItemResult deleteItem(DeleteItemRequest deleteItemRequest)
           Deletes a single item in a table by primary key.
 DeleteTableResult deleteTable(DeleteTableRequest deleteTableRequest)
           The DeleteTable operation deletes a table and all of its items.
 DescribeTableResult describeTable(DescribeTableRequest describeTableRequest)
           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.
 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 getItemRequest)
           The GetItem operation returns a set of attributes for the item with the given primary key.
 ListTablesResult listTables()
           Returns an array of all the tables associated with the current account and endpoint.
 ListTablesResult listTables(ListTablesRequest listTablesRequest)
           Returns an array of all the tables associated with the current account and endpoint.
 PutItemResult putItem(PutItemRequest putItemRequest)
           Creates a new item, or replaces an old item with a new item.
 QueryResult query(QueryRequest queryRequest)
           A Query operation directly accesses items from a table using the table primary key, or from an index using the index key.
 ScanResult scan(ScanRequest scanRequest)
           The Scan operation returns one or more items and item attributes by accessing every item in the table.
 void setEndpoint(String endpoint, String serviceName, String regionId)
          Overrides the default endpoint for this client ("http://dynamodb.us-east-1.amazonaws.com/") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests.
 UpdateItemResult updateItem(UpdateItemRequest updateItemRequest)
           Edits an existing item's attributes, or inserts a new item if it does not already exist.
 UpdateTableResult updateTable(UpdateTableRequest updateTableRequest)
           Updates the provisioned throughput for the given table.
 
Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, getTimeOffset, removeRequestHandler, setConfiguration, setEndpoint, setRegion, setTimeOffset, shutdown, withTimeOffset
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.amazonaws.services.dynamodbv2.AmazonDynamoDB
setEndpoint, setRegion, shutdown
 

Constructor Detail

AmazonDynamoDBClient

public AmazonDynamoDBClient()
Constructs a new client to invoke service methods on AmazonDynamoDBv2. A credentials provider chain will be used that searches for credentials in this order:

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:
DefaultAWSCredentialsProvider

AmazonDynamoDBClient

public AmazonDynamoDBClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonDynamoDBv2. A credentials provider chain will be used that searches for credentials in this order:

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
clientConfiguration - The client configuration options controlling how this client connects to AmazonDynamoDBv2 (ex: proxy settings, retry counts, etc.).
See Also:
DefaultAWSCredentialsProvider

AmazonDynamoDBClient

public AmazonDynamoDBClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on AmazonDynamoDBv2 using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonDynamoDBClient

public AmazonDynamoDBClient(AWSCredentials awsCredentials,
                            ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonDynamoDBv2 using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
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 AmazonDynamoDBv2 (ex: proxy settings, retry counts, etc.).

AmazonDynamoDBClient

public AmazonDynamoDBClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on AmazonDynamoDBv2 using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonDynamoDBClient

public AmazonDynamoDBClient(AWSCredentialsProvider awsCredentialsProvider,
                            ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonDynamoDBv2 using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
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 AmazonDynamoDBv2 (ex: proxy settings, retry counts, etc.).
Method Detail

scan

public ScanResult scan(ScanRequest scanRequest)
                throws AmazonServiceException,
                       AmazonClientException

The Scan operation returns one or more items and item attributes by accessing every item in the table. To have Amazon DynamoDB return fewer items, you can provide a ScanFilter .

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 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.

By default, Scan operations proceed sequentially; however, for faster performance on large tables, applications can request a parallel Scan by specifying the Segment and TotalSegments parameters. For more information, see Parallel Scan in the Amazon DynamoDB Developer Guide .

Specified by:
scan in interface AmazonDynamoDB
Parameters:
scanRequest - Container for the necessary parameters to execute the Scan service method on AmazonDynamoDBv2.
Returns:
The response from the Scan service method, as returned by AmazonDynamoDBv2.
Throws:
ResourceNotFoundException
ProvisionedThroughputExceededException
InternalServerErrorException
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonDynamoDBv2 indicating either a problem with the data in the request, or a server side issue.

updateTable

public UpdateTableResult updateTable(UpdateTableRequest updateTableRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

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 Amazon DynamoDB.

The provisioned throughput values can be upgraded or downgraded based on the maximums and minimums listed in the Limits section in the Amazon DynamoDB Developer Guide .

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.

You cannot add, modify or delete local secondary indexes using UpdateTable . Local secondary indexes can only be defined at table creation time.

Specified by:
updateTable in interface AmazonDynamoDB
Parameters:
updateTableRequest - Container for the necessary parameters to execute the UpdateTable service method on AmazonDynamoDBv2.
Returns:
The response from the UpdateTable service method, as returned by AmazonDynamoDBv2.
Throws:
ResourceInUseException
ResourceNotFoundException
LimitExceededException
InternalServerErrorException
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonDynamoDBv2 indicating either a problem with the data in the request, or a server side issue.

deleteTable

public DeleteTableResult deleteTable(DeleteTableRequest deleteTableRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until Amazon 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 Amazon DynamoDB returns a ResourceInUseException . If the specified table does not exist, Amazon DynamoDB returns a ResourceNotFoundException . If table is already in the DELETING state, no error is returned.

NOTE: Amazon 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.

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-east-1.amazonaws.com). Each Amazon DynamoDB endpoint is entirely independent. For example, if you have two tables called "MyTable," one in dynamodb.us-east-1.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.

When you delete a table, any local secondary indexes on that table are also deleted.

Use the DescribeTable API to check the status of the table.

Specified by:
deleteTable in interface AmazonDynamoDB
Parameters:
deleteTableRequest - Container for the necessary parameters to execute the DeleteTable service method on AmazonDynamoDBv2.
Returns:
The response from the DeleteTable service method, as returned by AmazonDynamoDBv2.
Throws:
ResourceInUseException
ResourceNotFoundException
LimitExceededException
InternalServerErrorException
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonDynamoDBv2 indicating either a problem with the data in the request, or a server side issue.

batchWriteItem

public BatchWriteItemResult batchWriteItem(BatchWriteItemRequest batchWriteItemRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can write up to 1 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 64 KB.

NOTE: BatchWriteItem cannot update items. To update items, use the UpdateItem API.

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.

To write one item, you can use the PutItem operation; to delete one item, you can use the DeleteItem operation.

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 Amazon 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, such as Java, 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, such as PHP, BatchWriteItem will write or delete the specified items one at a time. In both situations, BatchWriteItem 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 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, Amazon DynamoDB rejects the entire batch write operation:

Specified by:
batchWriteItem in interface AmazonDynamoDB
Parameters:
batchWriteItemRequest - Container for the necessary parameters to execute the BatchWriteItem service method on AmazonDynamoDBv2.
Returns:
The response from the BatchWriteItem service method, as returned by AmazonDynamoDBv2.
Throws:
ItemCollectionSizeLimitExceededException
ResourceNotFoundException
ProvisionedThroughputExceededException
InternalServerErrorException
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonDynamoDBv2 indicating either a problem with the data in the request, or a server side issue.

describeTable

public DescribeTableResult describeTable(DescribeTableRequest describeTableRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

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.

Specified by:
describeTable in interface AmazonDynamoDB
Parameters:
describeTableRequest - Container for the necessary parameters to execute the DescribeTable service method on AmazonDynamoDBv2.
Returns:
The response from the DescribeTable service method, as returned by AmazonDynamoDBv2.
Throws:
ResourceNotFoundException
InternalServerErrorException
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonDynamoDBv2 indicating either a problem with the data in the request, or a server side issue.

getItem

public GetItemResult getItem(GetItemRequest getItemRequest)
                      throws AmazonServiceException,
                             AmazonClientException

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.

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.

Specified by:
getItem in interface AmazonDynamoDB
Parameters:
getItemRequest - Container for the necessary parameters to execute the GetItem service method on AmazonDynamoDBv2.
Returns:
The response from the GetItem service method, as returned by AmazonDynamoDBv2.
Throws:
ResourceNotFoundException
ProvisionedThroughputExceededException
InternalServerErrorException
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonDynamoDBv2 indicating either a problem with the data in the request, or a server side issue.

deleteItem

public DeleteItemResult deleteItem(DeleteItemRequest deleteItemRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

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 only deleting items if specific conditions are met. If those conditions are met, Amazon DynamoDB performs the delete. Otherwise, the item is not deleted.

Specified by:
deleteItem in interface AmazonDynamoDB
Parameters:
deleteItemRequest - Container for the necessary parameters to execute the DeleteItem service method on AmazonDynamoDBv2.
Returns:
The response from the DeleteItem service method, as returned by AmazonDynamoDBv2.
Throws:
ItemCollectionSizeLimitExceededException
ResourceNotFoundException
ConditionalCheckFailedException
ProvisionedThroughputExceededException
InternalServerErrorException
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonDynamoDBv2 indicating either a problem with the data in the request, or a server side issue.

createTable

public CreateTableResult createTable(CreateTableRequest createTableRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

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, Amazon DynamoDB immediately returns a response with a TableStatus of CREATING . After the table is created, Amazon DynamoDB sets the TableStatus to ACTIVE . You can perform read and write operations only on an ACTIVE table.

If you want to create multiple tables with local secondary indexes on them, you must create them sequentially. Only one table with local secondary indexes can be in the CREATING state at any given time.

You can use the DescribeTable API to check the table status.

Specified by:
createTable in interface AmazonDynamoDB
Parameters:
createTableRequest - Container for the necessary parameters to execute the CreateTable service method on AmazonDynamoDBv2.
Returns:
The response from the CreateTable service method, as returned by AmazonDynamoDBv2.
Throws:
ResourceInUseException
LimitExceededException
InternalServerErrorException
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonDynamoDBv2 indicating either a problem with the data in the request, or a server side issue.

query

public QueryResult query(QueryRequest queryRequest)
                  throws AmazonServiceException,
                         AmazonClientException

A Query operation directly accesses items from a table using the table primary key, or from an index using the index key. You must provide a specific hash key value. You can narrow the scope of the query by using comparison operators on the range key value, or on the index key. You can use the ScanIndexForward parameter to get results in forward or reverse order, by range key or by index key.

Queries that do not return results consume the minimum read capacity units according to the type of read.

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 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 1 MB, or if you have used Limit .

To request a strongly consistent result, set ConsistentRead to true.

Specified by:
query in interface AmazonDynamoDB
Parameters:
queryRequest - Container for the necessary parameters to execute the Query service method on AmazonDynamoDBv2.
Returns:
The response from the Query service method, as returned by AmazonDynamoDBv2.
Throws:
ResourceNotFoundException
ProvisionedThroughputExceededException
InternalServerErrorException
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonDynamoDBv2 indicating either a problem with the data in the request, or a server side issue.

putItem

public PutItemResult putItem(PutItemRequest putItemRequest)
                      throws AmazonServiceException,
                             AmazonClientException

Creates a new item, or replaces an old item with a new item. 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.

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 .

You can request that PutItem return either a copy of the old item (before the update) or a copy of the new item (after the update). For more information, see the ReturnValues description.

NOTE: To prevent a new item from replacing 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 the Amazon DynamoDB Developer Guide .

Specified by:
putItem in interface AmazonDynamoDB
Parameters:
putItemRequest - Container for the necessary parameters to execute the PutItem service method on AmazonDynamoDBv2.
Returns:
The response from the PutItem service method, as returned by AmazonDynamoDBv2.
Throws:
ItemCollectionSizeLimitExceededException
ResourceNotFoundException
ConditionalCheckFailedException
ProvisionedThroughputExceededException
InternalServerErrorException
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonDynamoDBv2 indicating either a problem with the data in the request, or a server side issue.

listTables

public ListTablesResult listTables(ListTablesRequest listTablesRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Returns an array of all the tables associated with the current account and endpoint.

Each Amazon DynamoDB endpoint is entirely independent. For example, if you have two tables called "MyTable," one in dynamodb.us-east-1.amazonaws.com and one in dynamodb.us-west-1.amazonaws.com , they are 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.

Specified by:
listTables in interface AmazonDynamoDB
Parameters:
listTablesRequest - Container for the necessary parameters to execute the ListTables service method on AmazonDynamoDBv2.
Returns:
The response from the ListTables service method, as returned by AmazonDynamoDBv2.
Throws:
InternalServerErrorException
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonDynamoDBv2 indicating either a problem with the data in the request, or a server side issue.

updateItem

public UpdateItemResult updateItem(UpdateItemRequest updateItemRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Edits an existing item's attributes, or inserts a new item if it does not already exist. You can put, delete, or add attribute values. You can also 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).

In addition to updating an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.

Specified by:
updateItem in interface AmazonDynamoDB
Parameters:
updateItemRequest - Container for the necessary parameters to execute the UpdateItem service method on AmazonDynamoDBv2.
Returns:
The response from the UpdateItem service method, as returned by AmazonDynamoDBv2.
Throws:
ItemCollectionSizeLimitExceededException
ResourceNotFoundException
ConditionalCheckFailedException
ProvisionedThroughputExceededException
InternalServerErrorException
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonDynamoDBv2 indicating either a problem with the data in the request, or a server side issue.

batchGetItem

public BatchGetItemResult batchGetItem(BatchGetItemRequest batchGetItemRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

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 1 MB of data, which can comprise 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.

For example, if you ask to retrieve 100 items, but each individual item is 50 KB in size, the system returns 20 items (1 MB) 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 dataset.

If no items can be processed because of insufficient provisioned throughput on each of the tables involved in the request, BatchGetItem throws ProvisionedThroughputExceededException .

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 fetches items in parallel.

When designing your application, keep in mind that Amazon DynamoDB does not return attributes in any particular order. To help parse the response by item, include the primary key values for the items in your request in the AttributesToGet 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 .

Specified by:
batchGetItem in interface AmazonDynamoDB
Parameters:
batchGetItemRequest - Container for the necessary parameters to execute the BatchGetItem service method on AmazonDynamoDBv2.
Returns:
The response from the BatchGetItem service method, as returned by AmazonDynamoDBv2.
Throws:
ResourceNotFoundException
ProvisionedThroughputExceededException
InternalServerErrorException
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonDynamoDBv2 indicating either a problem with the data in the request, or a server side issue.

listTables

public ListTablesResult listTables()
                            throws AmazonServiceException,
                                   AmazonClientException

Returns an array of all the tables associated with the current account and endpoint.

Each Amazon DynamoDB endpoint is entirely independent. For example, if you have two tables called "MyTable," one in dynamodb.us-east-1.amazonaws.com and one in dynamodb.us-west-1.amazonaws.com , they are 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.

Specified by:
listTables in interface AmazonDynamoDB
Returns:
The response from the ListTables service method, as returned by AmazonDynamoDBv2.
Throws:
InternalServerErrorException
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonDynamoDBv2 indicating either a problem with the data in the request, or a server side issue.

setEndpoint

public void setEndpoint(String endpoint,
                        String serviceName,
                        String regionId)
                 throws IllegalArgumentException
Overrides the default endpoint for this client ("http://dynamodb.us-east-1.amazonaws.com/") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests. In almost all cases, this region ID and service name are automatically determined from the endpoint, and callers should use the simpler one-argument form of setEndpoint instead of this method.

This method is not threadsafe. Endpoints should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit.

Callers can pass in just the endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "http://dynamodb.us-east-1.amazonaws.com/"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

Parameters:
endpoint - The endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "http://dynamodb.us-east-1.amazonaws.com/") of the region specific AWS endpoint this client will communicate with.
serviceName - The name of the AWS service to use when signing requests.
regionId - The ID of the region in which this service resides.
Throws:
IllegalArgumentException - If any problems are detected with the specified endpoint.
See Also:
AmazonDynamoDB.setRegion(Region)

getCachedResponseMetadata

public 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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Specified by:
getCachedResponseMetadata in interface AmazonDynamoDB
Parameters:
request - The originally executed request
Returns:
The response metadata for the specified request, or null if none is available.


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.