Module Values.ScanOutputSource

Represents the output of a Scan operation.

Sourcetype nonrec t = {
  1. items : ItemList.t option;
    (*

    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.

    *)
  2. count : Integer.t option;
    (*

    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.

    *)
  3. scannedCount : Integer.t option;
    (*

    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.

    *)
  4. lastEvaluatedKey : Key.t option;
    (*

    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.

    *)
  5. consumedCapacity : ConsumedCapacity.t option;
    (*

    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.

    *)
}
Sourcetype nonrec error = [
  1. | `InternalServerError of InternalServerError.t
  2. | `ProvisionedThroughputExceededException of ProvisionedThroughputExceededException.t
  3. | `RequestLimitExceeded of RequestLimitExceeded.t
  4. | `ResourceNotFoundException of ResourceNotFoundException.t
  5. | `ThrottlingException of ThrottlingException.t
  6. | `Unknown_operation_error of string * string option
]
Sourceval make : ?items:??? -> ?count:??? -> ?scannedCount:??? -> ?lastEvaluatedKey:??? -> ?consumedCapacity:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `InternalServerError of InternalServerError.t | `ProvisionedThroughputExceededException of ProvisionedThroughputExceededException.t | `RequestLimitExceeded of RequestLimitExceeded.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `InternalServerError of InternalServerError.t | `ProvisionedThroughputExceededException of ProvisionedThroughputExceededException.t | `RequestLimitExceeded of RequestLimitExceeded.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Integer of Integer.t | `List of [> `Map of ([> `String of AttributeName.t ] * Awso.Botodata.value) list ] list | `Map of ([> `String of AttributeName.t ] * Awso.Botodata.value) list | `Structure of (string * [> `Double of ConsumedCapacityUnits.t | `Map of ([> `String of IndexName.t ] * [> `Structure of (string * [> `Double of ConsumedCapacityUnits.t ]) list ]) list | `String of TableArn.t | `Structure of (string * [> `Double of ConsumedCapacityUnits.t ]) list ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t