| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.DynamoDB.TransactGetItems
Description
TransactGetItems is a synchronous operation that atomically retrieves
multiple items from one or more tables (but not from indexes) in a
single account and Region. A TransactGetItems call can contain up to
25 TransactGetItem objects, each of which contains a Get structure
that specifies an item to retrieve from a table in the account and
Region. A call to TransactGetItems cannot retrieve items from tables
in more than one AWS account or Region. The aggregate size of the items
in the transaction cannot exceed 4 MB.
DynamoDB rejects the entire TransactGetItems request if any of the
following is true:
- A conflicting operation is in the process of updating an item to be read.
- There is insufficient provisioned capacity for the transaction to be completed.
- There is a user error, such as an invalid data format.
- The aggregate size of the items in the transaction cannot exceed 4 MB.
Synopsis
- data TransactGetItems = TransactGetItems' {}
- newTransactGetItems :: NonEmpty TransactGetItem -> TransactGetItems
- transactGetItems_returnConsumedCapacity :: Lens' TransactGetItems (Maybe ReturnConsumedCapacity)
- transactGetItems_transactItems :: Lens' TransactGetItems (NonEmpty TransactGetItem)
- data TransactGetItemsResponse = TransactGetItemsResponse' {}
- newTransactGetItemsResponse :: Int -> TransactGetItemsResponse
- transactGetItemsResponse_responses :: Lens' TransactGetItemsResponse (Maybe (NonEmpty ItemResponse))
- transactGetItemsResponse_consumedCapacity :: Lens' TransactGetItemsResponse (Maybe [ConsumedCapacity])
- transactGetItemsResponse_httpStatus :: Lens' TransactGetItemsResponse Int
Creating a Request
data TransactGetItems Source #
See: newTransactGetItems smart constructor.
Constructors
| TransactGetItems' | |
Fields
| |
Instances
Create a value of TransactGetItems with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:returnConsumedCapacity:TransactGetItems', transactGetItems_returnConsumedCapacity - A value of TOTAL causes consumed capacity information to be returned,
and a value of NONE prevents that information from being returned. No
other value is valid.
$sel:transactItems:TransactGetItems', transactGetItems_transactItems - An ordered array of up to 25 TransactGetItem objects, each of which
contains a Get structure.
Request Lenses
transactGetItems_returnConsumedCapacity :: Lens' TransactGetItems (Maybe ReturnConsumedCapacity) Source #
A value of TOTAL causes consumed capacity information to be returned,
and a value of NONE prevents that information from being returned. No
other value is valid.
transactGetItems_transactItems :: Lens' TransactGetItems (NonEmpty TransactGetItem) Source #
An ordered array of up to 25 TransactGetItem objects, each of which
contains a Get structure.
Destructuring the Response
data TransactGetItemsResponse Source #
See: newTransactGetItemsResponse smart constructor.
Constructors
| TransactGetItemsResponse' | |
Fields
| |
Instances
newTransactGetItemsResponse Source #
Create a value of TransactGetItemsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:responses:TransactGetItemsResponse', transactGetItemsResponse_responses - An ordered array of up to 25 ItemResponse objects, each of which
corresponds to the TransactGetItem object in the same position in the
TransactItems array. Each ItemResponse object contains a Map of the
name-value pairs that are the projected attributes of the requested
item.
If a requested item could not be retrieved, the corresponding
ItemResponse object is Null, or if the requested item has no projected
attributes, the corresponding ItemResponse object is an empty Map.
$sel:consumedCapacity:TransactGetItemsResponse', transactGetItemsResponse_consumedCapacity - If the ReturnConsumedCapacity value was TOTAL, this is an array of
ConsumedCapacity objects, one for each table addressed by
TransactGetItem objects in the TransactItems parameter. These
ConsumedCapacity objects report the read-capacity units consumed by
the TransactGetItems call in that table.
$sel:httpStatus:TransactGetItemsResponse', transactGetItemsResponse_httpStatus - The response's http status code.
Response Lenses
transactGetItemsResponse_responses :: Lens' TransactGetItemsResponse (Maybe (NonEmpty ItemResponse)) Source #
An ordered array of up to 25 ItemResponse objects, each of which
corresponds to the TransactGetItem object in the same position in the
TransactItems array. Each ItemResponse object contains a Map of the
name-value pairs that are the projected attributes of the requested
item.
If a requested item could not be retrieved, the corresponding
ItemResponse object is Null, or if the requested item has no projected
attributes, the corresponding ItemResponse object is an empty Map.
transactGetItemsResponse_consumedCapacity :: Lens' TransactGetItemsResponse (Maybe [ConsumedCapacity]) Source #
If the ReturnConsumedCapacity value was TOTAL, this is an array of
ConsumedCapacity objects, one for each table addressed by
TransactGetItem objects in the TransactItems parameter. These
ConsumedCapacity objects report the read-capacity units consumed by
the TransactGetItems call in that table.
transactGetItemsResponse_httpStatus :: Lens' TransactGetItemsResponse Int Source #
The response's http status code.