AWS SDK for .NET Documentation
BatchGetItemRequest Class
AmazonAmazon.DynamoDBv2.ModelBatchGetItemRequest Did this page help you?   Yes   No    Tell us about it...
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 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 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 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 . If at least one of the items is successfully processed, then BatchGetItem completes successfully, while returning the keys of the unread items in UnprocessedKeys .

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.

Declaration Syntax
public class BatchGetItemRequest : AmazonWebServiceRequest
All MembersConstructorsMethodsProperties

Initializes a new instance of the BatchGetItemRequest class

Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Serves as a hash function for a particular type.
(Inherited from Object.)
Gets the type of the current instance.
(Inherited from Object.)
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. By default, all attributes are returned. If a specified attribute is not found, it does not appear in the result. Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
  • ConsistentRead - If true, a strongly consistent read is used; if false (the default), an eventually consistent read is used.


1 - 100

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.


Allowed Values

Returns a string that represents the current object.
(Inherited from Object.)
WithRequestItems(array<KeyValuePair<(Of <<'(String, KeysAndAttributes>)>>)>[]()[][]) Obsolete.
Adds the KeyValuePairs to the RequestItems dictionary.

WithReturnConsumedCapacity(String) Obsolete.
Sets the ReturnConsumedCapacity property


The following examples show how to batch get item from two tables.

This example will construct the collection of keys for the items to retrieve from the first table.

CopyBatchGet sample - First table
// Define attributes to get and keys to retrieve
List<string> attributesToGet = new List<string> { "Author", "Title", "Year" };
List<Dictionary<string, AttributeValue>> sampleTableKeys = new List<Dictionary<string, AttributeValue>>
    new Dictionary<string, AttributeValue>
        { "Author", new AttributeValue { S = "Mark Twain" } },
        { "Title", new AttributeValue { S = "The Adventures of Tom Sawyer" } }
    new Dictionary<string, AttributeValue>
        { "Author", new AttributeValue { S = "Mark Twain" } },
        { "Title", new AttributeValue { S = "Adventures of Huckleberry Finn" } }

// Construct get-request for first table
KeysAndAttributes sampleTableItems = new KeysAndAttributes
    AttributesToGet = attributesToGet,
    Keys = sampleTableKeys

This example will construct the collection of keys for the items to retrieve from the second table.

CopyBatchGet sample - Second table
// Define keys to retrieve
List<Dictionary<string, AttributeValue>> authorsTableKeys = new List<Dictionary<string, AttributeValue>>
    new Dictionary<string, AttributeValue>
        { "Author", new AttributeValue { S = "Mark Twain" } },
    new Dictionary<string, AttributeValue>
        { "Author", new AttributeValue { S = "Booker Taliaferro Washington" } },

// Construct get-request for second table
//  Skip setting AttributesToGet property to retrieve all attributes
KeysAndAttributes authorsTableItems = new KeysAndAttributes
    Keys = authorsTableKeys,

This example will construct the BatchGet request from the two earlier-created collections, will issue the call and in case some items are not processed, will attempt to retrieve the remaining items.

CopyBatchGet sample - Service calls
// Create a client
AmazonDynamoDBClient client = new AmazonDynamoDBClient();

// Construct table-keys mapping
Dictionary<string, KeysAndAttributes> requestItems = new Dictionary<string, KeysAndAttributes>();
requestItems["SampleTable"] = sampleTableItems;
requestItems["AuthorsTable"] = authorsTableItems;

// Construct request
BatchGetItemRequest request = new BatchGetItemRequest
    RequestItems = requestItems

BatchGetItemResult result;
    // Issue request and retrieve items
    result = client.BatchGetItem(request).BatchGetItemResult;

    // Iterate through responses
    Dictionary<string, List<Dictionary<string, AttributeValue>>> responses = result.Responses;
    foreach (string tableName in responses.Keys)
        // Get items for each table
        List<Dictionary<string, AttributeValue>> tableItems = responses[tableName];

        // View items
        foreach (Dictionary<string, AttributeValue> item in tableItems)
            foreach (var keyValuePair in item)
                Console.WriteLine("{0} : S={1}, N={2}, SS=[{3}], NS=[{4}]",
                    string.Join(", ", keyValuePair.Value.SS ?? new List<string>()),
                    string.Join(", ", keyValuePair.Value.NS ?? new List<string>()));

    // Some items may not have been retrieved!
    //  Set RequestItems to the result's UnprocessedKeys and reissue request
    request.RequestItems = result.UnprocessedKeys;

} while (result.UnprocessedKeys.Count > 0);
Inheritance Hierarchy
See Also

Assembly: AWSSDK (Module: AWSSDK) Version: (