Twoorb Plugins  1.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Amazon.DynamoDBv2.Model.BatchGetItemRequest Class Reference

Container for the parameters to the BatchGetItem operation. More...

Inheritance diagram for Amazon.DynamoDBv2.Model.BatchGetItemRequest:
Amazon.DynamoDBv2.AmazonDynamoDBv2Request

Properties

Dictionary< string,
KeysAndAttributes
RequestItems [get, set]
 A map of one or more table names and, for each table, the corresponding primary keys for the items to retrieve. Each table name can be invoked only once. Each element in the map consists of the following: More...
 
ReturnConsumedCapacity ReturnConsumedCapacity [get, set]
 If set to TOTAL, ConsumedCapacity is included in the response; if set to NONE (the default), ConsumedCapacity is not included. More...
 

Detailed Description

Container for the parameters to the BatchGetItem operation.

The BatchGetItem operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key.

A single operation can retrieve up to 1 MB of data, which can comprise as many as 100 items. BatchGetItem will return a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for UnprocessedKeys . You can use this value to retry the operation starting with the next item to get.

For example, if you ask to retrieve 100 items, but each individual item is 50 KB in size, the system returns 20 items (1 MB) and an appropriate UnprocessedKeys value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one dataset.

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

By default, BatchGetItem performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set ConsistentRead to true for any or all tables.

In order to minimize response latency, BatchGetItem fetches items in parallel.

When designing your application, keep in mind that Amazon DynamoDB does not return attributes in any particular order. To help parse the response by item, include the primary key values for the items in your request in the AttributesToGet parameter.

If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see Capacity Units Calculations in the Amazon DynamoDB Developer Guide.

Property Documentation

Dictionary<string,KeysAndAttributes> Amazon.DynamoDBv2.Model.BatchGetItemRequest.RequestItems
getset

A map of one or more table names and, for each table, the corresponding primary keys for the items to retrieve. Each table name can be invoked only once. Each element in the map consists of the following:

  • Keys - An array of primary key attribute values that define specific items in the table.
  • AttributesToGet - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a specified attribute is not found, it does not appear in the result.
  • ConsistentRead - If true, a strongly consistent read is used; if false (the default), an eventually consistent read is used.

Constraints:

  • Length 1 - 100
ReturnConsumedCapacity Amazon.DynamoDBv2.Model.BatchGetItemRequest.ReturnConsumedCapacity
getset

If set to TOTAL, ConsumedCapacity is included in the response; if set to NONE (the default), ConsumedCapacity is not included.

Constraints:

  • Allowed Values INDEXES, TOTAL, NONE

The documentation for this class was generated from the following file: