BatchGetItemOutput
import type { BatchGetItemOutput } from "https://aws-api.deno.dev/v0.3/services/dynamodb.ts?docs=full";
Represents the output of a BatchGetItem
operation.
interface BatchGetItemOutput {
ConsumedCapacity?: ConsumedCapacity[] | null;
Responses?: {} | null;
[key: string]: ({})[] | null | undefined;
[key: string]: AttributeValue | null | undefined;
UnprocessedKeys?: {} | null;
}[key: string]: KeysAndAttributes | null | undefined;
§Properties
§
ConsumedCapacity?: ConsumedCapacity[] | null
[src]The read capacity units consumed by the entire BatchGetItem
operation.
Each element consists of:
TableName
- The table that consumed the provisioned throughput.CapacityUnits
- The total number of capacity units consumed.
§
Responses?: {} | null
[src][key: string]: ({})[] | null | undefined;
[key: string]: AttributeValue | null | undefined;
A map of table name to a list of items.
Each object in Responses
consists of a table name, along with a map of attribute data consisting of the data type and attribute value.
§
UnprocessedKeys?: {} | null
[src][key: string]: KeysAndAttributes | null | undefined;
A map of tables and their respective keys that were not processed with the current response.
The UnprocessedKeys
value is in the same form as RequestItems
, so the value can be provided directly to a subsequent BatchGetItem
operation.
For more information, see RequestItems
in the Request Parameters section.
Each element consists of:
Keys
- An array of primary key attribute values that define specific items in the table.ProjectionExpression
- One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result.ConsistentRead
- The consistency of a read operation. If set totrue
, then a strongly consistent read is used; otherwise, an eventually consistent read is used.
If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys
map.