dynamodb/aws.sdk.kotlin.services.dynamodb.model/ScanResponse

ScanResponse

class ScanResponse

Represents the output of a Scan operation.

Types

Builder

class Builder

Companion

object Companion

Properties

consumedCapacity

val consumedCapacity: 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 Capacity unit consumption for read operations in the Amazon DynamoDB Developer Guide.

count

val count: Int

The number of items in the response.

items

val items: List<Map<String, AttributeValue>>?

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.

lastEvaluatedKey

val lastEvaluatedKey: Map<String, AttributeValue>?

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.

scannedCount

val scannedCount: Int

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.

Functions

copy

inline fun copy(block: ScanResponse.Builder.() -> Unit = {}): ScanResponse

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String