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.

Configuration for the Table.Scan operation

Inheritance Hierarchy

System.Object
  Amazon.DynamoDBv2.DocumentModel.ScanOperationConfig

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

Syntax

C#
public class ScanOperationConfig

The ScanOperationConfig type exposes the following members

Constructors

NameDescription
Public Method ScanOperationConfig()

Initializes a default Table.Scan config object Filter is empty, Limit is Int32.MaxValue

Properties

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

List of attributes to retrieve as part of the search

Public Property CollectResults System.Boolean

Whether to collect GetNextSet and GetRemaining results in Matches property. Default is true. If set to false, Matches will always be empty.

Public Property ConditionalOperator Amazon.DynamoDBv2.DocumentModel.ConditionalOperatorValues

A logical operator to apply to the conditions in the Filter property: AND - If all of the conditions evaluate to true, then the entire filter evaluates to true. OR - If at least one of the conditions evaluate to true, then the entire filter evaluates to true. Default value is AND.

Public Property ConsistentRead System.Boolean

If set to true, this flag ensures that the most recently written data is returned.

Public Property Filter Amazon.DynamoDBv2.DocumentModel.ScanFilter

Filter for the search operation

Public Property FilterExpression Amazon.DynamoDBv2.DocumentModel.Expression

The expression that is evaluated for each item. Only items that pass the expression are returned.

Public Property IndexName System.String

Name of the index to scan against.

Public Property Limit System.Int32

Upper limit on the number of items scanned per request for matching conditions.

Public Property PaginationToken System.String

Pagination token corresponding to the item where the last Scan operation stopped, inclusive of the previous result set. Set this value to resume Scan operation from the next item. This token should be retrieved from a Search object.

Public Property Segment System.Int32

For parallel Scan requests, Segment identifies an individual segment to be scanned by an application "worker" (such as a thread or a process). Each worker issues a Scan request with a distinct value for the segment it will scan. Segment IDs are zero-based, so the first segment is always 0. For example, if you want to scan a table using four application threads, the first thread would specify a Segment value of 0, the second thread would specify 1, and so on. LastEvaluatedKey returned from a parallel scan request must be used with same Segment id in a subsequent operation. The value for Segment must be less than or equal to 0, and less than the value provided for TotalSegments. If you specify Segment, you must also specify TotalSegments.

Constraints:Range0 - 4095

Public Property Select Amazon.DynamoDBv2.DocumentModel.SelectValues

Enum specifying what data to return from query.

Public Property TotalSegments System.Int32

For parallel Scan requests, TotalSegmentsrepresents the total number of segments for a table that is being scanned. Segments are a way to logically divide a table into equally sized portions, for the duration of the Scan request. The value of TotalSegments corresponds to the number of application "workers" (such as threads or processes) that will perform the parallel Scan. For example, if you want to scan a table using four application threads, you would specify a TotalSegments value of 4. The value for TotalSegments must be greater than or equal to 1, and less than or equal to 4096. If you specify a TotalSegments value of 1, the Scan will be sequential rather than parallel. If you specify TotalSegments, you must also specify Segment.

Constraints:Range1 - 4096

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

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