Interface BatchWriteOptionsProtected

Options for batch put & delete operations.

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

Hierarchy

  • Omit<BatchWriteCommandInput, "RequestItems">
    • BatchWriteOptions

Properties

batchProcessOptions? ReturnConsumedCapacity? ReturnItemCollectionMetrics? tableName?

Properties

OptionalbatchProcessOptions

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

OptionalReturnConsumedCapacity

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.

OptionalReturnItemCollectionMetrics

ReturnItemCollectionMetrics?: ReturnItemCollectionMetrics

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

OptionaltableName

tableName?: string

Settings

Member Visibility

On This Page

Properties