AmazonDynamoDBAsync (AWS SDK for Java

Overview

Package

Class

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.dynamodb
Interface AmazonDynamoDBAsync

All Superinterfaces:: AmazonDynamoDB

All Known Implementing Classes:: AmazonDynamoDBAsyncClient

public interface AmazonDynamoDBAsync
extends AmazonDynamoDB
extends AmazonDynamoDB

Interface for accessing AmazonDynamoDB asynchronously, using Java Futures.

Amazon DynamoDB is a fast, highly scalable, highly available, cost-effective non-relational database service. Amazon DynamoDB removes traditional scalability limitations on data storage while maintaining low latency and predictable performance.

Method Summary
`Future<BatchGetItemResult>`	`batchGetItemAsync(BatchGetItemRequest batchGetItemRequest)` The BatchGetItem operation returns the attributes for multiple items from multiple tables using their primary keys.
`Future<CreateTableResult>`	`createTableAsync(CreateTableRequest createTableRequest)` The CreateTable operation adds a new table to your account.
`Future<DeleteItemResult>`	`deleteItemAsync(DeleteItemRequest deleteItemRequest)` Deletes a single item in a table by primary key.
`Future<DeleteTableResult>`	`deleteTableAsync(DeleteTableRequest deleteTableRequest)` The DeleteTable operation deletes a table and all of its items.
`Future<DescribeTableResult>`	`describeTableAsync(DescribeTableRequest describeTableRequest)` Returns information about the table, including the current status of the table, the primary key schema and when the table was created.
`Future<GetItemResult>`	`getItemAsync(GetItemRequest getItemRequest)` The GetItem operation returns a set of Attributes for an item that matches the primary key.
`Future<ListTablesResult>`	`listTablesAsync(ListTablesRequest listTablesRequest)` Returns a paginated list of table names created by the AWS Account of the caller in the AWS Region (e.g.
`Future<PutItemResult>`	`putItemAsync(PutItemRequest putItemRequest)` Creates a new item, or replaces an old item with a new item (including all the attributes).
`Future<QueryResult>`	`queryAsync(QueryRequest queryRequest)` The Query operation gets the values of one or more items and its attributes by primary key (composite primary key, only).
`Future<ScanResult>`	`scanAsync(ScanRequest scanRequest)` The Scan operation returns one or more items and its attributes by performing a full scan of a table.
`Future<UpdateItemResult>`	`updateItemAsync(UpdateItemRequest updateItemRequest)` Edits an existing item's attributes.
`Future<UpdateTableResult>`	`updateTableAsync(UpdateTableRequest updateTableRequest)` Updates the provisioned throughput for the given table.

Methods inherited from interface com.amazonaws.services.dynamodb.AmazonDynamoDB
`batchGetItem, createTable, deleteItem, deleteTable, describeTable, getCachedResponseMetadata, getItem, listTables, listTables, putItem, query, scan, setEndpoint, shutdown, updateItem, updateTable`

Method Detail

scanAsync

Future<ScanResult> scanAsync(ScanRequest scanRequest)
                             throws AmazonServiceException,
                                    AmazonClientException

The Scan operation returns one or more items and its attributes by performing a full scan of a table. Limit the returned results by specifying a filter.

Parameters:: scanRequest - Container for the necessary parameters to execute the Scan operation on AmazonDynamoDB.
Returns:: A Java Future object containing the response from the Scan service method, as returned by AmazonDynamoDB.
Throws:: 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 AmazonDynamoDB indicating either a problem with the data in the request, or a server side issue.

createTableAsync

Future<CreateTableResult> createTableAsync(CreateTableRequest createTableRequest)
                                           throws AmazonServiceException,
                                                  AmazonClientException

The CreateTable operation adds a new table to your account. The table name must be unique among those associated with the AWS Account issuing the request, and the AWS Region that receives the request (e.g. us-east-1). The CreateTable operation triggers an asynchronous workflow to begin creating the table. Amazon DynamoDB immediately returns the state of the table (CREATING) until the table is in the ACTIVE state. Once the table is in the ACTIVE state, you can perform data plane operations.

Parameters:: createTableRequest - Container for the necessary parameters to execute the CreateTable operation on AmazonDynamoDB.
Returns:: A Java Future object containing the response from the CreateTable service method, as returned by AmazonDynamoDB.
Throws:: 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 AmazonDynamoDB indicating either a problem with the data in the request, or a server side issue.

listTablesAsync

Future<ListTablesResult> listTablesAsync(ListTablesRequest listTablesRequest)
                                         throws AmazonServiceException,
                                                AmazonClientException

Returns a paginated list of table names created by the AWS Account of the caller in the AWS Region (e.g. us-east-1).

Parameters:: listTablesRequest - Container for the necessary parameters to execute the ListTables operation on AmazonDynamoDB.
Returns:: A Java Future object containing the response from the ListTables service method, as returned by AmazonDynamoDB.
Throws:: 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 AmazonDynamoDB indicating either a problem with the data in the request, or a server side issue.

queryAsync

Future<QueryResult> queryAsync(QueryRequest queryRequest)
                               throws AmazonServiceException,
                                      AmazonClientException

The Query operation gets the values of one or more items and its attributes by primary key (composite primary key, only). Narrow the scope of the query using comparison operators on the RangeKeyValue of the composite key. Use the ScanIndexForward parameter to get results in forward or reverse order by range key.

Parameters:: queryRequest - Container for the necessary parameters to execute the Query operation on AmazonDynamoDB.
Returns:: A Java Future object containing the response from the Query service method, as returned by AmazonDynamoDB.
Throws:: 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 AmazonDynamoDB indicating either a problem with the data in the request, or a server side issue.

updateItemAsync

Future<UpdateItemResult> updateItemAsync(UpdateItemRequest updateItemRequest)
                                         throws AmazonServiceException,
                                                AmazonClientException

Edits an existing item's attributes. You can perform a conditional update (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values).

Parameters:: updateItemRequest - Container for the necessary parameters to execute the UpdateItem operation on AmazonDynamoDB.
Returns:: A Java Future object containing the response from the UpdateItem service method, as returned by AmazonDynamoDB.
Throws:: 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 AmazonDynamoDB indicating either a problem with the data in the request, or a server side issue.

updateTableAsync

Future<UpdateTableResult> updateTableAsync(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 Capacity feature of Amazon DynamoDB.

Parameters:: updateTableRequest - Container for the necessary parameters to execute the UpdateTable operation on AmazonDynamoDB.
Returns:: A Java Future object containing the response from the UpdateTable service method, as returned by AmazonDynamoDB.
Throws:: 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 AmazonDynamoDB indicating either a problem with the data in the request, or a server side issue.

putItemAsync

Future<PutItemResult> putItemAsync(PutItemRequest putItemRequest)
                                   throws AmazonServiceException,
                                          AmazonClientException

Creates a new item, or replaces an old item with a new item (including all the attributes). If an item already exists in the specified table with the same primary key, the new item completely replaces the existing item. You can perform a conditional put (insert a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values.

Parameters:: putItemRequest - Container for the necessary parameters to execute the PutItem operation on AmazonDynamoDB.
Returns:: A Java Future object containing the response from the PutItem service method, as returned by AmazonDynamoDB.
Throws:: 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 AmazonDynamoDB indicating either a problem with the data in the request, or a server side issue.

deleteTableAsync

Future<DeleteTableResult> deleteTableAsync(DeleteTableRequest deleteTableRequest)
                                           throws AmazonServiceException,
                                                  AmazonClientException

The DeleteTable operation deletes a table and all of its items. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DeleteTable returns a ResourceInUseException. If the specified table does not exist, Amazon DynamoDB returns a ResourceNotFoundException.

Parameters:: deleteTableRequest - Container for the necessary parameters to execute the DeleteTable operation on AmazonDynamoDB.
Returns:: A Java Future object containing the response from the DeleteTable service method, as returned by AmazonDynamoDB.
Throws:: 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 AmazonDynamoDB indicating either a problem with the data in the request, or a server side issue.

deleteItemAsync

Future<DeleteItemResult> deleteItemAsync(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.

Parameters:: deleteItemRequest - Container for the necessary parameters to execute the DeleteItem operation on AmazonDynamoDB.
Returns:: A Java Future object containing the response from the DeleteItem service method, as returned by AmazonDynamoDB.
Throws:: 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 AmazonDynamoDB indicating either a problem with the data in the request, or a server side issue.

describeTableAsync

Future<DescribeTableResult> describeTableAsync(DescribeTableRequest describeTableRequest)
                                               throws AmazonServiceException,
                                                      AmazonClientException

Returns information about the table, including the current status of the table, the primary key schema and when the table was created. If the table does not exist, the server returns a ResourceNotFoundException.

Parameters:: describeTableRequest - Container for the necessary parameters to execute the DescribeTable operation on AmazonDynamoDB.
Returns:: A Java Future object containing the response from the DescribeTable service method, as returned by AmazonDynamoDB.
Throws:: 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 AmazonDynamoDB indicating either a problem with the data in the request, or a server side issue.

getItemAsync

Future<GetItemResult> getItemAsync(GetItemRequest getItemRequest)
                                   throws AmazonServiceException,
                                          AmazonClientException

The GetItem operation returns a set of Attributes for an item that matches the primary key. The GetItem operation provides an eventually consistent read by default. If eventually consistent reads are not acceptable for your application, use ConsistentRead. Although this operation might take longer than a standard read, it always returns the last updated value.

Parameters:: getItemRequest - Container for the necessary parameters to execute the GetItem operation on AmazonDynamoDB.
Returns:: A Java Future object containing the response from the GetItem service method, as returned by AmazonDynamoDB.
Throws:: 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 AmazonDynamoDB indicating either a problem with the data in the request, or a server side issue.

batchGetItemAsync

Future<BatchGetItemResult> batchGetItemAsync(BatchGetItemRequest batchGetItemRequest)
                                             throws AmazonServiceException,
                                                    AmazonClientException

The BatchGetItem operation returns the attributes for multiple items from multiple tables using their primary keys. The maximum number of item attributes that can be retrieved for a single operation is 100. Also, the number of items retrieved is constrained by a 1 MB the size limit. If the response size limit is exceeded or a partial result is returned due to an internal processing failure, Amazon DynamoDB returns an UnprocessedKeys value so you can retry the operation starting with the next item to get. Amazon DynamoDB automatically adjusts the number of items returned per page to enforce this limit. For example, even if you ask to retrieve 100 items, but each individual item is 50 KB in size, the system returns 20 items and an appropriate UnprocessedKeys value so you can get the next page of results. If necessary, your application needs its own logic to assemble the pages of results into one set.

Parameters:: batchGetItemRequest - Container for the necessary parameters to execute the BatchGetItem operation on AmazonDynamoDB.
Returns:: A Java Future object containing the response from the BatchGetItem service method, as returned by AmazonDynamoDB.
Throws:: 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 AmazonDynamoDB indicating either a problem with the data in the request, or a server side issue.