AWS SDK Version 2 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.

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

Inheritance Hierarchy

System.Object
  Amazon.DynamoDBv2.DocumentModel.DocumentBatchGet

Namespace: Amazon.DynamoDBv2.DocumentModel
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class DocumentBatchGet : Object

The DocumentBatchGet type exposes the following members

Constructors

NameDescription
Public Method DocumentBatchGet(Table) Constructs a DocumentBatchGet instance for a specific table.

Properties

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

Methods

NameDescription
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 Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8

.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8