Interface BatchGetOptions

Options for batch get operations.

interface BatchGetOptions {
    batchProcessOptions?: Omit<
        BatchProcessOptions<unknown, unknown>,
        "batchHandler" | "unprocessedItemExtractor",
    >;
    ReturnConsumedCapacity?: ReturnConsumedCapacity;
    tableName?: string;
}

Hierarchy

Omit<BatchGetCommandInput, "RequestItems">
- BatchGetOptions

Index

Properties

batchProcessOptions? ReturnConsumedCapacity? tableName?

Properties

`Optional`batchProcessOptions

batchProcessOptions?: Omit<
BatchProcessOptions<unknown, unknown>,
"batchHandler" | "unprocessedItemExtractor",
>

Optional BatchProcessOptions override passed to the internal batching loop.

`Optional`ReturnConsumedCapacity

ReturnConsumedCapacity?: ReturnConsumedCapacity

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.

`Optional`tableName

tableName?: string

Optional table name override (defaults to EntityClient.tableName).