Class ScanResponse

Namespace

Amazon.DynamoDBv2.Model

Assembly

AWSSDK.DynamoDBv2.dll

Represents the output of a

Scan

operation.

public class ScanResponse : AmazonWebServiceResponse

Inheritance

object

ScanResponse

Constructors

ScanResponse()

public ScanResponse()

Properties

ConsumedCapacity

Gets and sets the property ConsumedCapacity.

The capacity units consumed by the

Scan

operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation.

ConsumedCapacity

is only returned if the

ReturnConsumedCapacity

parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

public ConsumedCapacity ConsumedCapacity { get; set; }

Property Value

ConsumedCapacity

Count

Gets and sets the property Count.

The number of items in the response.

If you set

ScanFilter

in the request, then

Count

is the number of items returned after the filter was applied, and

ScannedCount

is the number of matching items before the filter was applied.

If you did not use a filter in the request, then

Count

is the same as

ScannedCount

.

public int Count { get; set; }

Property Value

int

Items

Gets and sets the property Items.

An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.

public List<Dictionary<string, AttributeValue>> Items { get; set; }

Property Value

List<Dictionary<string, AttributeValue>>

LastEvaluatedKey

Gets and sets the property LastEvaluatedKey.

The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If

LastEvaluatedKey

is empty, then the "last page" of results has been processed and there is no more data to be retrieved.

If

LastEvaluatedKey

is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when

LastEvaluatedKey

is empty.

public Dictionary<string, AttributeValue> LastEvaluatedKey { get; set; }

Property Value

Dictionary<string, AttributeValue>

ScannedCount

Gets and sets the property ScannedCount.

The number of items evaluated, before any

ScanFilter

is applied. A high

ScannedCount

value with few, or no,

Count

results indicates an inefficient

Scan

operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

If you did not use a filter in the request, then

ScannedCount

is the same as

Count

.

public int ScannedCount { get; set; }

Property Value

int