All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.dynamodbv2.AmazonDynamoDBAsync Maven / Gradle / Ivy

Go to download

The AWS Java SDK for Amazon DynamoDB module holds the client classes that are used for communicating with Amazon DynamoDB Service

There is a newer version: 1.12.772
Show newest version
/*
 * Copyright 2010-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 * 
 *  http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */
package com.amazonaws.services.dynamodbv2;

import java.util.concurrent.Future;

import com.amazonaws.AmazonClientException;
import com.amazonaws.AmazonServiceException;
import com.amazonaws.handlers.AsyncHandler;
import com.amazonaws.services.dynamodbv2.model.*;

/**
 * Interface for accessing AmazonDynamoDBv2 asynchronously.
 * Each asynchronous method will return a Java Future object, and users are also allowed
 * to provide a callback handler.
 * Amazon DynamoDB Overview 

* This is the Amazon DynamoDB API Reference. This guide provides * descriptions and samples of the low-level DynamoDB API. For * information about DynamoDB application development, go to the * Amazon DynamoDB Developer Guide * . *

*

* Instead of making the requests to the low-level DynamoDB API directly * from your application, we recommend that you use the AWS Software * Development Kits (SDKs). The easy-to-use libraries in the AWS SDKs * make it unnecessary to call the low-level DynamoDB API directly from * your application. The libraries take care of request authentication, * serialization, and connection management. For more information, go to * Using the AWS SDKs with DynamoDB * in the Amazon DynamoDB Developer Guide . *

*

* If you decide to code against the low-level DynamoDB API directly, you * will need to write the necessary code to authenticate your requests. * For more information on signing your requests, go to * Using the DynamoDB API * in the Amazon DynamoDB Developer Guide . *

*

* The following are short descriptions of each low-level API action, * organized by function. *

*

* Managing Tables *

*

* *

    *
  • * CreateTable - Creates a table with user-specified provisioned * throughput settings. You must designate one attribute as the hash * primary key for the table; you can optionally designate a second * attribute as the range primary key. DynamoDB creates indexes on these * key attributes for fast data access. Optionally, you can create one or * more secondary indexes, which provide fast data access using non-key * attributes. *

    *
  • *
  • * DescribeTable - Returns metadata for a table, such as table * size, status, and index information. *

    *
  • *
  • * UpdateTable - Modifies the provisioned throughput settings for * a table. Optionally, you can modify the provisioned throughput * settings for global secondary indexes on the table. *

    *
  • *
  • * ListTables - Returns a list of all tables associated with the * current AWS account and endpoint. *

    *
  • *
  • * DeleteTable - Deletes a table and all of its indexes. *

    *
  • * *
* *

*

* For conceptual information about managing tables, go to * Working with Tables * in the Amazon DynamoDB Developer Guide . *

*

* Reading Data *

*

* *

    *
  • * GetItem - Returns a set of attributes for the item that has a * given primary key. By default, GetItem performs an eventually * consistent read; however, applications can specify a strongly * consistent read instead. *

    *
  • *
  • * BatchGetItem - Performs multiple GetItem requests for * data items using their primary keys, from one table or multiple * tables. The response from BatchGetItem has a size limit of 16 * MB and returns a maximum of 100 items. Both eventually consistent and * strongly consistent reads can be used. *

    *
  • *
  • * Query - Returns one or more items from a table or a secondary * index. You must provide a specific hash key value. You can narrow the * scope of the query using comparison operators against a range key * value, or on the index key. Query supports either eventual or * strong consistency. A single response has a size limit of 1 MB. *

    *
  • *
  • * Scan - Reads every item in a table; the result set is * eventually consistent. You can limit the number of items returned by * filtering the data attributes, using conditional expressions. * Scan can be used to enable ad-hoc querying of a table against * non-key attributes; however, since this is a full table scan without * using an index, Scan should not be used for any application * query use case that requires predictable performance. *

    *
  • * *
* *

*

* For conceptual information about reading data, go to * Working with Items and Query and Scan Operations * in the Amazon DynamoDB Developer Guide . *

*

* Modifying Data *

*

* *

    *
  • * PutItem - Creates a new item, or replaces an existing item * with a new item (including all the attributes). By default, if an item * in the table already exists with the same primary key, the new item * completely replaces the existing item. You can use conditional * operators to replace an item only if its attribute values match * certain conditions, or to insert a new item only if that item doesn't * already exist. *

    *
  • *
  • * UpdateItem - Modifies the attributes of an existing item. You * can also use conditional operators to perform an update only if the * item's attribute values match certain conditions. *

    *
  • *
  • * DeleteItem - Deletes an item in a table by primary key. You * can use conditional operators to perform a delete an item only if the * item's attribute values match certain conditions. *

    *
  • *
  • * BatchWriteItem - Performs multiple PutItem and * DeleteItem requests across multiple tables in a single request. * A failure of any request(s) in the batch will not cause the entire * BatchWriteItem operation to fail. Supports batches of up to 25 * items to put or delete, with a maximum total request size of 16 MB. *

    *
  • * *
* *

*

* For conceptual information about modifying data, go to * Working with Items and Query and Scan Operations * in the Amazon DynamoDB Developer Guide . *

*/ public interface AmazonDynamoDBAsync extends AmazonDynamoDB { /** *

* The Scan operation returns one or more items and item * attributes by accessing every item in the table. To have DynamoDB * return fewer items, you can provide a ScanFilter 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. *

*

* 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 operation by specifying the Segment and * TotalSegments parameters. For more information, see * Parallel Scan * in the Amazon DynamoDB Developer Guide . *

* * @param scanRequest Container for the necessary parameters to execute * the Scan operation on AmazonDynamoDBv2. * * @return A Java Future object containing the response from the Scan * service method, as returned by AmazonDynamoDBv2. * * * @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. * @throws AmazonServiceException * If an error response is returned by AmazonDynamoDBv2 indicating * either a problem with the data in the request, or a server side issue. */ public Future scanAsync(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 DynamoDB * return fewer items, you can provide a ScanFilter 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. *

*

* 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 operation by specifying the Segment and * TotalSegments parameters. For more information, see * Parallel Scan * in the Amazon DynamoDB Developer Guide . *

* * @param scanRequest Container for the necessary parameters to execute * the Scan operation on AmazonDynamoDBv2. * @param asyncHandler Asynchronous callback handler for events in the * life-cycle of the request. Users could provide the implementation of * the four callback methods in this interface to process the operation * result or handle the exception. * * @return A Java Future object containing the response from the Scan * service method, as returned by AmazonDynamoDBv2. * * * @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. * @throws AmazonServiceException * If an error response is returned by AmazonDynamoDBv2 indicating * either a problem with the data in the request, or a server side issue. */ public Future scanAsync(ScanRequest scanRequest, AsyncHandler asyncHandler) 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 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 indexes using UpdateTable . * Indexes can only be defined at table creation time. *

* * @param updateTableRequest Container for the necessary parameters to * execute the UpdateTable operation on AmazonDynamoDBv2. * * @return A Java Future object containing the response from the * UpdateTable service method, as returned by AmazonDynamoDBv2. * * * @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. * @throws AmazonServiceException * If an error response is returned by AmazonDynamoDBv2 indicating * either a problem with the data in the request, or a server side issue. */ public Future 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 throughput feature of 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 indexes using UpdateTable . * Indexes can only be defined at table creation time. *

* * @param updateTableRequest Container for the necessary parameters to * execute the UpdateTable operation on AmazonDynamoDBv2. * @param asyncHandler Asynchronous callback handler for events in the * life-cycle of the request. Users could provide the implementation of * the four callback methods in this interface to process the operation * result or handle the exception. * * @return A Java Future object containing the response from the * UpdateTable service method, as returned by AmazonDynamoDBv2. * * * @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. * @throws AmazonServiceException * If an error response is returned by AmazonDynamoDBv2 indicating * either a problem with the data in the request, or a server side issue. */ public Future updateTableAsync(UpdateTableRequest updateTableRequest, AsyncHandler asyncHandler) 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 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. *

*

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

*

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

* * @param deleteTableRequest Container for the necessary parameters to * execute the DeleteTable operation on AmazonDynamoDBv2. * * @return A Java Future object containing the response from the * DeleteTable service method, as returned by AmazonDynamoDBv2. * * * @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. * @throws AmazonServiceException * If an error response is returned by AmazonDynamoDBv2 indicating * either a problem with the data in the request, or a server side issue. */ public Future deleteTableAsync(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 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. *

*

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

*

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

* * @param deleteTableRequest Container for the necessary parameters to * execute the DeleteTable operation on AmazonDynamoDBv2. * @param asyncHandler Asynchronous callback handler for events in the * life-cycle of the request. Users could provide the implementation of * the four callback methods in this interface to process the operation * result or handle the exception. * * @return A Java Future object containing the response from the * DeleteTable service method, as returned by AmazonDynamoDBv2. * * * @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. * @throws AmazonServiceException * If an error response is returned by AmazonDynamoDBv2 indicating * either a problem with the data in the request, or a server side issue. */ public Future deleteTableAsync(DeleteTableRequest deleteTableRequest, AsyncHandler asyncHandler) 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 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. *

*

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

*

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

*

* IMPORTANT: 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, go to 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, 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, you must update 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, 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. *

    *
  • * *
* * @param batchWriteItemRequest Container for the necessary parameters to * execute the BatchWriteItem operation on AmazonDynamoDBv2. * * @return A Java Future object containing the response from the * BatchWriteItem service method, as returned by AmazonDynamoDBv2. * * * @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. * @throws AmazonServiceException * If an error response is returned by AmazonDynamoDBv2 indicating * either a problem with the data in the request, or a server side issue. */ public Future batchWriteItemAsync(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 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. *

*

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

*

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

*

* IMPORTANT: 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, go to 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, 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, you must update 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, 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. *

    *
  • * *
* * @param batchWriteItemRequest Container for the necessary parameters to * execute the BatchWriteItem operation on AmazonDynamoDBv2. * @param asyncHandler Asynchronous callback handler for events in the * life-cycle of the request. Users could provide the implementation of * the four callback methods in this interface to process the operation * result or handle the exception. * * @return A Java Future object containing the response from the * BatchWriteItem service method, as returned by AmazonDynamoDBv2. * * * @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. * @throws AmazonServiceException * If an error response is returned by AmazonDynamoDBv2 indicating * either a problem with the data in the request, or a server side issue. */ public Future batchWriteItemAsync(BatchWriteItemRequest batchWriteItemRequest, AsyncHandler asyncHandler) 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. *

*

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

* * @param describeTableRequest Container for the necessary parameters to * execute the DescribeTable operation on AmazonDynamoDBv2. * * @return A Java Future object containing the response from the * DescribeTable service method, as returned by AmazonDynamoDBv2. * * * @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. * @throws AmazonServiceException * If an error response is returned by AmazonDynamoDBv2 indicating * either a problem with the data in the request, or a server side issue. */ public Future describeTableAsync(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. *

*

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

* * @param describeTableRequest Container for the necessary parameters to * execute the DescribeTable operation on AmazonDynamoDBv2. * @param asyncHandler Asynchronous callback handler for events in the * life-cycle of the request. Users could provide the implementation of * the four callback methods in this interface to process the operation * result or handle the exception. * * @return A Java Future object containing the response from the * DescribeTable service method, as returned by AmazonDynamoDBv2. * * * @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. * @throws AmazonServiceException * If an error response is returned by AmazonDynamoDBv2 indicating * either a problem with the data in the request, or a server side issue. */ public Future describeTableAsync(DescribeTableRequest describeTableRequest, AsyncHandler asyncHandler) 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. *

* * @param getItemRequest Container for the necessary parameters to * execute the GetItem operation on AmazonDynamoDBv2. * * @return A Java Future object containing the response from the GetItem * service method, as returned by AmazonDynamoDBv2. * * * @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. * @throws AmazonServiceException * If an error response is returned by AmazonDynamoDBv2 indicating * either a problem with the data in the request, or a server side issue. */ public Future getItemAsync(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. *

* * @param getItemRequest Container for the necessary parameters to * execute the GetItem operation on AmazonDynamoDBv2. * @param asyncHandler Asynchronous callback handler for events in the * life-cycle of the request. Users could provide the implementation of * the four callback methods in this interface to process the operation * result or handle the exception. * * @return A Java Future object containing the response from the GetItem * service method, as returned by AmazonDynamoDBv2. * * * @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. * @throws AmazonServiceException * If an error response is returned by AmazonDynamoDBv2 indicating * either a problem with the data in the request, or a server side issue. */ public Future getItemAsync(GetItemRequest getItemRequest, AsyncHandler asyncHandler) 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 deleting items only if specific * conditions are met. If those conditions are met, DynamoDB performs the * delete. Otherwise, the item is not deleted. *

* * @param deleteItemRequest Container for the necessary parameters to * execute the DeleteItem operation on AmazonDynamoDBv2. * * @return A Java Future object containing the response from the * DeleteItem service method, as returned by AmazonDynamoDBv2. * * * @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. * @throws AmazonServiceException * If an error response is returned by AmazonDynamoDBv2 indicating * either a problem with the data in the request, or a server side issue. */ public Future 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. *

*

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

* * @param deleteItemRequest Container for the necessary parameters to * execute the DeleteItem operation on AmazonDynamoDBv2. * @param asyncHandler Asynchronous callback handler for events in the * life-cycle of the request. Users could provide the implementation of * the four callback methods in this interface to process the operation * result or handle the exception. * * @return A Java Future object containing the response from the * DeleteItem service method, as returned by AmazonDynamoDBv2. * * * @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. * @throws AmazonServiceException * If an error response is returned by AmazonDynamoDBv2 indicating * either a problem with the data in the request, or a server side issue. */ public Future deleteItemAsync(DeleteItemRequest deleteItemRequest, AsyncHandler asyncHandler) 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, 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. *

*

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

*

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

* * @param createTableRequest Container for the necessary parameters to * execute the CreateTable operation on AmazonDynamoDBv2. * * @return A Java Future object containing the response from the * CreateTable service method, as returned by AmazonDynamoDBv2. * * * @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. * @throws AmazonServiceException * If an error response is returned by AmazonDynamoDBv2 indicating * either a problem with the data in the request, or a server side issue. */ public Future createTableAsync(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, 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. *

*

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

*

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

* * @param createTableRequest Container for the necessary parameters to * execute the CreateTable operation on AmazonDynamoDBv2. * @param asyncHandler Asynchronous callback handler for events in the * life-cycle of the request. Users could provide the implementation of * the four callback methods in this interface to process the operation * result or handle the exception. * * @return A Java Future object containing the response from the * CreateTable service method, as returned by AmazonDynamoDBv2. * * * @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. * @throws AmazonServiceException * If an error response is returned by AmazonDynamoDBv2 indicating * either a problem with the data in the request, or a server side issue. */ public Future createTableAsync(CreateTableRequest createTableRequest, AsyncHandler asyncHandler) 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 number of read * capacity units for that type of read operation. *

*

* If the total number of items meeting the query criteria exceeds the * result set size limit of 1 MB, the query stops and results are * returned to the user with LastEvaluatedKey to continue the * query in a subsequent operation. Unlike a Scan operation, a * Query operation never returns both an empty result set and a * LastEvaluatedKey . The LastEvaluatedKey is only provided * if the results exceed 1 MB, or if you have used Limit . *

*

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

* * @param queryRequest Container for the necessary parameters to execute * the Query operation on AmazonDynamoDBv2. * * @return A Java Future object containing the response from the Query * service method, as returned by AmazonDynamoDBv2. * * * @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. * @throws AmazonServiceException * If an error response is returned by AmazonDynamoDBv2 indicating * either a problem with the data in the request, or a server side issue. */ public Future queryAsync(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 number of read * capacity units for that type of read operation. *

*

* If the total number of items meeting the query criteria exceeds the * result set size limit of 1 MB, the query stops and results are * returned to the user with LastEvaluatedKey to continue the * query in a subsequent operation. Unlike a Scan operation, a * Query operation never returns both an empty result set and a * LastEvaluatedKey . The LastEvaluatedKey is only provided * if the results exceed 1 MB, or if you have used Limit . *

*

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

* * @param queryRequest Container for the necessary parameters to execute * the Query operation on AmazonDynamoDBv2. * @param asyncHandler Asynchronous callback handler for events in the * life-cycle of the request. Users could provide the implementation of * the four callback methods in this interface to process the operation * result or handle the exception. * * @return A Java Future object containing the response from the Query * service method, as returned by AmazonDynamoDBv2. * * * @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. * @throws AmazonServiceException * If an error response is returned by AmazonDynamoDBv2 indicating * either a problem with the data in the request, or a server side issue. */ public Future queryAsync(QueryRequest queryRequest, AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException; /** *

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

*

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

*

* When you add an item, the primary key attribute(s) are the only * required attributes. Attribute values cannot be null. String and * Binary type attributes must have lengths greater than zero. Set type * attributes cannot be empty. Requests with empty values will be * rejected with a ValidationException exception. *

*

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

*

* NOTE: To prevent a new item from replacing an existing item, * use a conditional put operation with ComparisonOperator set to NULL * for the primary key attribute, or attributes. *

*

* For more information about using this API, see * Working with Items * in the Amazon DynamoDB Developer Guide . *

* * @param putItemRequest Container for the necessary parameters to * execute the PutItem operation on AmazonDynamoDBv2. * * @return A Java Future object containing the response from the PutItem * service method, as returned by AmazonDynamoDBv2. * * * @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. * @throws AmazonServiceException * If an error response is returned by AmazonDynamoDBv2 indicating * either a problem with the data in the request, or a server side issue. */ public Future putItemAsync(PutItemRequest putItemRequest) throws AmazonServiceException, AmazonClientException; /** *

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

*

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

*

* When you add an item, the primary key attribute(s) are the only * required attributes. Attribute values cannot be null. String and * Binary type attributes must have lengths greater than zero. Set type * attributes cannot be empty. Requests with empty values will be * rejected with a ValidationException exception. *

*

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

*

* NOTE: To prevent a new item from replacing an existing item, * use a conditional put operation with ComparisonOperator set to NULL * for the primary key attribute, or attributes. *

*

* For more information about using this API, see * Working with Items * in the Amazon DynamoDB Developer Guide . *

* * @param putItemRequest Container for the necessary parameters to * execute the PutItem operation on AmazonDynamoDBv2. * @param asyncHandler Asynchronous callback handler for events in the * life-cycle of the request. Users could provide the implementation of * the four callback methods in this interface to process the operation * result or handle the exception. * * @return A Java Future object containing the response from the PutItem * service method, as returned by AmazonDynamoDBv2. * * * @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. * @throws AmazonServiceException * If an error response is returned by AmazonDynamoDBv2 indicating * either a problem with the data in the request, or a server side issue. */ public Future putItemAsync(PutItemRequest putItemRequest, AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException; /** *

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

* * @param listTablesRequest Container for the necessary parameters to * execute the ListTables operation on AmazonDynamoDBv2. * * @return A Java Future object containing the response from the * ListTables service method, as returned by AmazonDynamoDBv2. * * * @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. * @throws AmazonServiceException * If an error response is returned by AmazonDynamoDBv2 indicating * either a problem with the data in the request, or a server side issue. */ public Future listTablesAsync(ListTablesRequest listTablesRequest) throws AmazonServiceException, AmazonClientException; /** *

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

* * @param listTablesRequest Container for the necessary parameters to * execute the ListTables operation on AmazonDynamoDBv2. * @param asyncHandler Asynchronous callback handler for events in the * life-cycle of the request. Users could provide the implementation of * the four callback methods in this interface to process the operation * result or handle the exception. * * @return A Java Future object containing the response from the * ListTables service method, as returned by AmazonDynamoDBv2. * * * @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. * @throws AmazonServiceException * If an error response is returned by AmazonDynamoDBv2 indicating * either a problem with the data in the request, or a server side issue. */ public Future listTablesAsync(ListTablesRequest listTablesRequest, AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException; /** *

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

* * @param updateItemRequest Container for the necessary parameters to * execute the UpdateItem operation on AmazonDynamoDBv2. * * @return A Java Future object containing the response from the * UpdateItem service method, as returned by AmazonDynamoDBv2. * * * @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. * @throws AmazonServiceException * If an error response is returned by AmazonDynamoDBv2 indicating * either a problem with the data in the request, or a server side issue. */ public Future updateItemAsync(UpdateItemRequest updateItemRequest) throws AmazonServiceException, AmazonClientException; /** *

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

* * @param updateItemRequest Container for the necessary parameters to * execute the UpdateItem operation on AmazonDynamoDBv2. * @param asyncHandler Asynchronous callback handler for events in the * life-cycle of the request. Users could provide the implementation of * the four callback methods in this interface to process the operation * result or handle the exception. * * @return A Java Future object containing the response from the * UpdateItem service method, as returned by AmazonDynamoDBv2. * * * @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. * @throws AmazonServiceException * If an error response is returned by AmazonDynamoDBv2 indicating * either a problem with the data in the request, or a server side issue. */ public Future updateItemAsync(UpdateItemRequest updateItemRequest, AsyncHandler asyncHandler) 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 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. *

*

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

*

* IMPORTANT: 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, go to 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 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 . *

* * @param batchGetItemRequest Container for the necessary parameters to * execute the BatchGetItem operation on AmazonDynamoDBv2. * * @return A Java Future object containing the response from the * BatchGetItem service method, as returned by AmazonDynamoDBv2. * * * @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. * @throws AmazonServiceException * If an error response is returned by AmazonDynamoDBv2 indicating * either a problem with the data in the request, or a server side issue. */ public Future batchGetItemAsync(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 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. *

*

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

*

* IMPORTANT: 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, go to 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 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 . *

* * @param batchGetItemRequest Container for the necessary parameters to * execute the BatchGetItem operation on AmazonDynamoDBv2. * @param asyncHandler Asynchronous callback handler for events in the * life-cycle of the request. Users could provide the implementation of * the four callback methods in this interface to process the operation * result or handle the exception. * * @return A Java Future object containing the response from the * BatchGetItem service method, as returned by AmazonDynamoDBv2. * * * @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. * @throws AmazonServiceException * If an error response is returned by AmazonDynamoDBv2 indicating * either a problem with the data in the request, or a server side issue. */ public Future batchGetItemAsync(BatchGetItemRequest batchGetItemRequest, AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException; }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy