class Aws::DynamoDB::Types::GetItemInput

@see docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/GetItemInput AWS API Documentation
@return [Hash<String,String>]<br>: 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>Item Attributes] in the *Amazon DynamoDB Developer Guide*.
For more information on expression attribute names, see [Specifying
</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
reserved words, see [Reserved Words] in the *Amazon DynamoDB
cannot be used directly in an expression. (For the complete list of
The name of this attribute conflicts with a reserved word, so it
^
* `Percentile`
name. For example, consider the following attribute name:
Use the **#** character in an expression to dereference an attribute
misinterpreted in an expression.
* To prevent special characters in an attribute name from being
name in an expression.
* To create a placeholder for repeating occurrences of an attribute
reserved word.
* To access an attribute whose name conflicts with a DynamoDB
`ExpressionAttributeNames`:
expression. The following are some use cases for using
One or more substitution tokens for attribute names in an
@!attribute [rw] expression_attribute_names
@return [String]<br>: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html<br><br><br><br>*Amazon DynamoDB Developer Guide*.
For more information, see [Specifying Item Attributes] in the
not appear in the result.
returned. If any of the requested attributes are not found, they do
If no attribute names are specified, then all attributes are
commas.
JSON document. The attributes in the expression must be separated by
table. These attributes can include scalars, sets, or elements of a
A string that identifies one or more attributes to retrieve from the
@!attribute [rw] projection_expression
@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 [Boolean]
uses eventually consistent reads.
operation uses strongly consistent reads; otherwise, the operation
Determines the read consistency model: If set to `true`, then the
@!attribute [rw] consistent_read
@return [Array<String>]<br>: docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html<br><br><br><br>Developer Guide*.
more information, see [AttributesToGet] in the *Amazon DynamoDB
This is a legacy parameter. Use `ProjectionExpression` instead. For
@!attribute [rw] attributes_to_get
@return [Hash<String,Types::AttributeValue>]
values for both the partition key and the sort key.
for the partition key. For a composite primary key, you must provide
example, with a simple primary key, you only need to provide a value
For the primary key, you must provide all of the attributes. For
the primary key of the item to retrieve.
A map of attribute names to `AttributeValue` objects, representing
@!attribute [rw] key
@return [String]
The name of the table containing the requested item.
@!attribute [rw] table_name
Represents the input of a `GetItem` operation.