com.amazonaws.services.dynamodbv2.model

Class BatchWriteItemRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.dynamodbv2.model.BatchWriteItemRequest

All Implemented Interfaces:

Serializable

public class BatchWriteItemRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the BatchWriteItem operation.

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.

Note that if none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchGetItem will throw a ProvisionedThroughputExceededException .

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

• The total request size exceeds 1 MB.

• Any individual item in a batch exceeds 64 KB.

See Also:

AmazonDynamoDB.batchWriteItem(BatchWriteItemRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
BatchWriteItemRequest() Default constructor for a new BatchWriteItemRequest object.
BatchWriteItemRequest(Map<String,List<WriteRequest>> requestItems) Constructs a new BatchWriteItemRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
BatchWriteItemRequest	addRequestItemsEntry(String key, List<WriteRequest> value) A map of one or more table names and, for each table, a list of operations to be performed (DeleteRequest or PutRequest).
BatchWriteItemRequest	clearRequestItemsEntries() Removes all the entries added into RequestItems.
boolean	equals(Object obj)
Map<String,List<WriteRequest>>	getRequestItems() A map of one or more table names and, for each table, a list of operations to be performed (DeleteRequest or PutRequest).
String	getReturnConsumedCapacity() If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes.
String	getReturnItemCollectionMetrics() If set to SIZE, statistics about item collections, if any, that were modified during the operation are returned in the response.
int	hashCode()
void	setRequestItems(Map<String,List<WriteRequest>> requestItems) A map of one or more table names and, for each table, a list of operations to be performed (DeleteRequest or PutRequest).
void	setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes.
void	setReturnConsumedCapacity(String returnConsumedCapacity) If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes.
void	setReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics) If set to SIZE, statistics about item collections, if any, that were modified during the operation are returned in the response.
void	setReturnItemCollectionMetrics(String returnItemCollectionMetrics) If set to SIZE, statistics about item collections, if any, that were modified during the operation are returned in the response.
String	toString() Returns a string representation of this object; useful for testing and debugging.
BatchWriteItemRequest	withRequestItems(Map<String,List<WriteRequest>> requestItems) A map of one or more table names and, for each table, a list of operations to be performed (DeleteRequest or PutRequest).
BatchWriteItemRequest	withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes.
BatchWriteItemRequest	withReturnConsumedCapacity(String returnConsumedCapacity) If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes.
BatchWriteItemRequest	withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics) If set to SIZE, statistics about item collections, if any, that were modified during the operation are returned in the response.
BatchWriteItemRequest	withReturnItemCollectionMetrics(String returnItemCollectionMetrics) If set to SIZE, statistics about item collections, if any, that were modified during the operation are returned in the response.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BatchWriteItemRequest

public BatchWriteItemRequest()

Default constructor for a new BatchWriteItemRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

BatchWriteItemRequest

public BatchWriteItemRequest(Map<String,List<WriteRequest>> requestItems)

Constructs a new BatchWriteItemRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

requestItems - A map of one or more table names and, for each table, a list of operations to be performed (DeleteRequest or PutRequest). Each element in the map consists of the following:

• DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:

  • Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.

• PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:

  • Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException.

    If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

Method Detail

getRequestItems

public Map<String,List<WriteRequest>> getRequestItems()

A map of one or more table names and, for each table, a list of operations to be performed (DeleteRequest or PutRequest). Each element in the map consists of the following:

• DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:

  • Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.

• PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:

  • Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException.

    If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

Constraints:
Length: 1 - 25

Returns:

A map of one or more table names and, for each table, a list of operations to be performed (DeleteRequest or PutRequest). Each element in the map consists of the following:

• DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:

  • Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.

• PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:

  • Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException.

    If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

setRequestItems

public void setRequestItems(Map<String,List<WriteRequest>> requestItems)

A map of one or more table names and, for each table, a list of operations to be performed (DeleteRequest or PutRequest). Each element in the map consists of the following:

• DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:

  • Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.

• PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:

  • Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException.

    If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

Constraints:
Length: 1 - 25

Parameters:

requestItems - A map of one or more table names and, for each table, a list of operations to be performed (DeleteRequest or PutRequest). Each element in the map consists of the following:

• DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:

  • Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.

• PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:

  • Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException.

    If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

withRequestItems

public BatchWriteItemRequest withRequestItems(Map<String,List<WriteRequest>> requestItems)

A map of one or more table names and, for each table, a list of operations to be performed (DeleteRequest or PutRequest). Each element in the map consists of the following:

• DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:

  • Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.

• PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:

  • Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException.

    If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 25

Parameters:

requestItems - A map of one or more table names and, for each table, a list of operations to be performed (DeleteRequest or PutRequest). Each element in the map consists of the following:

• DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:

  • Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.

• PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:

  • Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException.

    If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

Returns:

A reference to this updated object so that method calls can be chained together.

addRequestItemsEntry

public BatchWriteItemRequest addRequestItemsEntry(String key,
                                         List<WriteRequest> value)

A map of one or more table names and, for each table, a list of operations to be performed (DeleteRequest or PutRequest). Each element in the map consists of the following:

• DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:

  • Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.

• PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:

  • Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException.

    If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

The method adds a new key-value pair into RequestItems parameter, and returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 25

Parameters:

key - The key of the entry to be added into RequestItems.

value - The corresponding value of the entry to be added into RequestItems.

clearRequestItemsEntries

public BatchWriteItemRequest clearRequestItemsEntries()

Removes all the entries added into RequestItems.

Returns a reference to this object so that method calls can be chained together.

getReturnConsumedCapacity

public String getReturnConsumedCapacity()

If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.

Constraints:
Allowed Values: INDEXES, TOTAL, NONE

Returns:

If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.

See Also:

ReturnConsumedCapacity

setReturnConsumedCapacity

public void setReturnConsumedCapacity(String returnConsumedCapacity)

If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.

Constraints:
Allowed Values: INDEXES, TOTAL, NONE

Parameters:

returnConsumedCapacity - If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.

See Also:

ReturnConsumedCapacity

withReturnConsumedCapacity

public BatchWriteItemRequest withReturnConsumedCapacity(String returnConsumedCapacity)

If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: INDEXES, TOTAL, NONE

Parameters:

returnConsumedCapacity - If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ReturnConsumedCapacity

setReturnConsumedCapacity

public void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)

If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.

Constraints:
Allowed Values: INDEXES, TOTAL, NONE

Parameters:

returnConsumedCapacity - If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.

See Also:

ReturnConsumedCapacity

withReturnConsumedCapacity

public BatchWriteItemRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)

If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: INDEXES, TOTAL, NONE

Parameters:

returnConsumedCapacity - If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ReturnConsumedCapacity

getReturnItemCollectionMetrics

public String getReturnItemCollectionMetrics()

If set to SIZE, statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Constraints:
Allowed Values: SIZE, NONE

Returns:

If set to SIZE, statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

See Also:

ReturnItemCollectionMetrics

setReturnItemCollectionMetrics

public void setReturnItemCollectionMetrics(String returnItemCollectionMetrics)

If set to SIZE, statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Constraints:
Allowed Values: SIZE, NONE

Parameters:

returnItemCollectionMetrics - If set to SIZE, statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

See Also:

ReturnItemCollectionMetrics

withReturnItemCollectionMetrics

public BatchWriteItemRequest withReturnItemCollectionMetrics(String returnItemCollectionMetrics)

If set to SIZE, statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: SIZE, NONE

Parameters:

returnItemCollectionMetrics - If set to SIZE, statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ReturnItemCollectionMetrics

setReturnItemCollectionMetrics

public void setReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)

If set to SIZE, statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Constraints:
Allowed Values: SIZE, NONE

Parameters:

returnItemCollectionMetrics - If set to SIZE, statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

See Also:

ReturnItemCollectionMetrics

withReturnItemCollectionMetrics

public BatchWriteItemRequest withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)

If set to SIZE, statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: SIZE, NONE

Parameters:

returnItemCollectionMetrics - If set to SIZE, statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ReturnItemCollectionMetrics

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object