Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Returns metadata about transactions and their status. To prevent the response from growing indefinitely, only uncommitted transactions and those available for time-travel queries are returned.
This operation can help you identify uncommitted transactions or to get information about transactions.
Synopsis
- data ListTransactions = ListTransactions' {}
- newListTransactions :: ListTransactions
- listTransactions_catalogId :: Lens' ListTransactions (Maybe Text)
- listTransactions_maxResults :: Lens' ListTransactions (Maybe Natural)
- listTransactions_nextToken :: Lens' ListTransactions (Maybe Text)
- listTransactions_statusFilter :: Lens' ListTransactions (Maybe TransactionStatusFilter)
- data ListTransactionsResponse = ListTransactionsResponse' {}
- newListTransactionsResponse :: Int -> ListTransactionsResponse
- listTransactionsResponse_nextToken :: Lens' ListTransactionsResponse (Maybe Text)
- listTransactionsResponse_transactions :: Lens' ListTransactionsResponse (Maybe [TransactionDescription])
- listTransactionsResponse_httpStatus :: Lens' ListTransactionsResponse Int
Creating a Request
data ListTransactions Source #
See: newListTransactions
smart constructor.
ListTransactions' | |
|
Instances
newListTransactions :: ListTransactions Source #
Create a value of ListTransactions
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:
ListTransactions
, listTransactions_catalogId
- The catalog for which to list transactions. Defaults to the account ID
of the caller.
$sel:maxResults:ListTransactions'
, listTransactions_maxResults
- The maximum number of transactions to return in a single call.
ListTransactions
, listTransactions_nextToken
- A continuation token if this is not the first call to retrieve
transactions.
$sel:statusFilter:ListTransactions'
, listTransactions_statusFilter
- A filter indicating the status of transactions to return. Options are
ALL | COMPLETED | COMMITTED | ABORTED | ACTIVE. The default is ALL
.
Request Lenses
listTransactions_catalogId :: Lens' ListTransactions (Maybe Text) Source #
The catalog for which to list transactions. Defaults to the account ID of the caller.
listTransactions_maxResults :: Lens' ListTransactions (Maybe Natural) Source #
The maximum number of transactions to return in a single call.
listTransactions_nextToken :: Lens' ListTransactions (Maybe Text) Source #
A continuation token if this is not the first call to retrieve transactions.
listTransactions_statusFilter :: Lens' ListTransactions (Maybe TransactionStatusFilter) Source #
A filter indicating the status of transactions to return. Options are
ALL | COMPLETED | COMMITTED | ABORTED | ACTIVE. The default is ALL
.
Destructuring the Response
data ListTransactionsResponse Source #
See: newListTransactionsResponse
smart constructor.
ListTransactionsResponse' | |
|
Instances
newListTransactionsResponse Source #
Create a value of ListTransactionsResponse
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:
ListTransactions
, listTransactionsResponse_nextToken
- A continuation token indicating whether additional data is available.
$sel:transactions:ListTransactionsResponse'
, listTransactionsResponse_transactions
- A list of transactions. The record for each transaction is a
TransactionDescription
object.
$sel:httpStatus:ListTransactionsResponse'
, listTransactionsResponse_httpStatus
- The response's http status code.
Response Lenses
listTransactionsResponse_nextToken :: Lens' ListTransactionsResponse (Maybe Text) Source #
A continuation token indicating whether additional data is available.
listTransactionsResponse_transactions :: Lens' ListTransactionsResponse (Maybe [TransactionDescription]) Source #
A list of transactions. The record for each transaction is a
TransactionDescription
object.
listTransactionsResponse_httpStatus :: Lens' ListTransactionsResponse Int Source #
The response's http status code.