Represents a request to scan items in a DynamoDB table or index using the Document Model. This class introduces a modern expression-based API that replaces legacy parameter-based approaches. Legacy parameters such as ScanFilter, AttributesToGet are not supported. Use FilterExpression and ProjectionExpression instead.
In this article ▶
Inheritance Hierarchy
Amazon.DynamoDBv2.DocumentModel.DocumentOperationRequest
Amazon.DynamoDBv2.DocumentModel.ScanDocumentOperationRequest
Namespace: Amazon.DynamoDBv2.DocumentModel
Assembly: AWSSDK.DynamoDBv2.dll
Version: 3.x.y.z
Syntax
public class ScanDocumentOperationRequest : DocumentOperationRequest
The ScanDocumentOperationRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
ScanDocumentOperationRequest() |
Initializes a new instance of the Amazon.DynamoDBv2.DocumentModel.ScanDocumentOperationRequest class. |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
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. |
|
|
ConsistentRead | System.Boolean |
Gets or sets the consistent read flag. Strongly consistent reads are only supported for tables and local secondary indexes. |
|
|
FilterExpression | Amazon.DynamoDBv2.DocumentModel.Expression |
Gets or sets the filter expression specifying which items should be returned after scanning. Applied after DynamoDB reads the items. |
|
|
IndexName | System.String |
Gets or sets the index name to scan against. |
|
|
Limit | System.Int32 |
Gets or sets the maximum number of items DynamoDB should process before returning a page of results. Defaults to int.MaxValue (service default paging behavior). |
|
|
PaginationToken | System.String |
Pagination token corresponding to the item where the last Scan operation stopped. Set this value to resume the scan from the next item. Retrieved from a Search object. |
|
|
ProjectionExpression | Amazon.DynamoDBv2.DocumentModel.Expression |
Gets or sets the projection expression specifying which attributes should be retrieved. |
|
|
Segment | System.Int32 |
The segment number to scan in a parallel scan. Must be between 0 and TotalSegments - 1 when specified. If null, a non-parallel (single segment) scan is performed. |
|
|
Select | Amazon.DynamoDBv2.DocumentModel.SelectValues |
Enum specifying what data to return from the scan (e.g., attributes or count). |
|
|
TotalSegments | System.Int32 |
Total number of segments for a parallel scan. Defaults to 1 (no parallelism). |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer