AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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 returns a partial result if the response size limit
is exceeded, the table's provisioned throughput is exceeded, more than 1MB per partition
is requested, 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.
If you request more than 100 items, BatchGetItem returns a ValidationException
with the message "Too many items requested for the BatchGetItem call."
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 dataset.
If none of the items can be processed due to insufficient provisioned throughput
on all of the tables in the request, then BatchGetItem returns 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.
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, see 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 may retrieve items in parallel.
When designing your application, keep in mind that DynamoDB does not return items
in any particular order. To help parse the response by item, include the primary key
values for the items in your request in the ProjectionExpression 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 Working with Tables in the Amazon DynamoDB Developer Guide.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginBatchGetItem and EndBatchGetItem.
Namespace: Amazon.DynamoDBv2
Assembly: AWSSDK.DynamoDBv2.dll
Version: 3.x.y.z
public abstract Task<BatchGetItemResponse> BatchGetItemAsync( BatchGetItemRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the BatchGetItem service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| InternalServerErrorException | An error occurred on the server side. |
| ProvisionedThroughputExceededException | Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide. |
| RequestLimitExceededException | Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase. |
| ResourceNotFoundException | The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5