class Aws::DynamoDB::Types::BatchGetItemInput


@see docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/BatchGetItemInput AWS API Documentation
@return [String]
response.
* ‘NONE` - No `ConsumedCapacity` details are included in the
`ConsumedCapacity` for the operation.
* `TOTAL` - The response includes only the aggregate
table(s).
`INDEXES` will only return `ConsumedCapacity` information for
do not access any indexes at all. In these cases, specifying
Note that some operations, such as `GetItem` and `BatchGetItem`,
and secondary index that was accessed.
for the operation, together with `ConsumedCapacity` for each table
* `INDEXES` - The response includes the aggregate `ConsumedCapacity`
throughput consumption that is returned in the response:
Determines the level of detail about either provisioned or on-demand
@!attribute [rw] return_consumed_capacity
@return [Hash<String,Types::KeysAndAttributes>]<br>: docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html<br>[2]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html<br>[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html<br><br><br><br>[AttributesToGet][3] in the *Amazon DynamoDB Developer Guide*.
`ProjectionExpression` instead. For more information, see
* `AttributesToGet` - This is a legacy parameter. Use
*Amazon DynamoDB Developer Guide*.
For more information, see [Accessing Item Attributes] in the
do not appear in the result.
returned. If any of the requested attributes are not found, they
If no attribute names are specified, then all attributes are
attributes in the expression must be separated by commas.
include scalars, sets, or elements of a JSON document. The
attributes to retrieve from the table. These attributes can
* `ProjectionExpression` - A string that identifies one or more
and the sort key value.
a composite key, you must provide both the partition key value
primary key, you only need to provide the partition key value. For
provide all of the key attributes. For example, with a simple
specific items in the table. For each primary key, you must
* `Keys` - An array of primary key attribute values that define
Guide*.
[Accessing Item Attributes] in the *Amazon DynamoDB Developer
For more information about expression attribute names, see
</note>
runtime.
attribute values*, which are placeholders for the actual value at
<note markdown=“1”> Tokens that begin with the : character are *expression
^
* `#P = :val`
example:
You could then use this substitution in an expression, as in this
^
* `{“#P”:“Percentile”}`
following for `ExpressionAttributeNames`:
Developer Guide*). To work around this, you could specify the
of reserved words, see [Reserved Words] in the *Amazon DynamoDB
cannot be used directly in an expression. (For the complete list
The name of this attribute conflicts with a reserved word, so it
^
* `Percentile`
name:
attribute name. For example, consider the following attribute
Use the **#** character in an expression to dereference an
misinterpreted in an expression.
* To prevent special characters in an attribute name from being
attribute name in an expression.
* To create a placeholder for repeating occurrences of an
reserved word.
* To access an attribute whose name conflicts with a DynamoDB
following are some use cases for using `ExpressionAttributeNames`:
attribute names in the `ProjectionExpression` parameter. The
* `ExpressionAttributeNames` - One or more substitution tokens for
if `false` (the default), an eventually consistent read is used.
* `ConsistentRead` - If `true`, a strongly consistent read is used;
following:
Each element in the map of items to retrieve consists of the
request.
Each table name or ARN can be used only once per `BatchGetItem`
a map that describes one or more items to retrieve from that table.
A map of one or more table names or table ARNs and, for each table,
@!attribute [rw] request_items
Represents the input of a `BatchGetItem` operation.