AWS SDK Version 3 for .NET
API Reference

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.

Class for retrieving a batch of Documents from a single DynamoDB table.

Inheritance Hierarchy


Namespace: Amazon.DynamoDBv2.DocumentModel
Assembly: AWSSDK.DynamoDBv2.dll
Version: 3.x.y.z


public class DocumentBatchGet

The DocumentBatchGet type exposes the following members


Public Method DocumentBatchGet(Table)

Constructs a DocumentBatchGet instance for a specific table.


Public Property AttributesToGet System.Collections.Generic.List<System.String>

List of attributes to retrieve.

Public Property ConsistentRead System.Boolean

If set to true, a consistent read is issued. Otherwise eventually-consistent is used.

Public Property Results System.Collections.Generic.List<Amazon.DynamoDBv2.DocumentModel.Document>

List of results retrieved from DynamoDB. Populated after Execute is called.



Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

Public Method AddKey(Primitive)

Add a single item to get, identified by its hash primary key.

Public Method AddKey(Primitive, Primitive)

Add a single item to get, identified by its hash-and-range primary key.

Public Method AddKey(IDictionary<String, DynamoDBEntry>)

Add a single item to get, identified by its key.

Public Method Combine(DocumentBatchGet)

Creates a MultiTableDocumentBatchGet object that is a combination of the current DocumentBatchGet and the specified DocumentBatchGet.

Public Method Execute()

Executes a server call to batch-get the documents requested. Populates Results with the retrieved items.

Public Method ExecuteAsync(CancellationToken)

Initiates the asynchronous execution of the Execute operation. Amazon.DynamoDBv2.DocumentModel.DocumentBatchGet.Execute

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone