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 |
Lists orders. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of the network site or the status of the order.
If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.
This operation returns paginated results.
Synopsis
- data ListOrders = ListOrders' {
- filters :: Maybe (HashMap OrderFilterKeys [Text])
- maxResults :: Maybe Natural
- startToken :: Maybe Text
- networkArn :: Text
- newListOrders :: Text -> ListOrders
- listOrders_filters :: Lens' ListOrders (Maybe (HashMap OrderFilterKeys [Text]))
- listOrders_maxResults :: Lens' ListOrders (Maybe Natural)
- listOrders_startToken :: Lens' ListOrders (Maybe Text)
- listOrders_networkArn :: Lens' ListOrders Text
- data ListOrdersResponse = ListOrdersResponse' {}
- newListOrdersResponse :: Int -> ListOrdersResponse
- listOrdersResponse_nextToken :: Lens' ListOrdersResponse (Maybe Text)
- listOrdersResponse_orders :: Lens' ListOrdersResponse (Maybe [Order])
- listOrdersResponse_httpStatus :: Lens' ListOrdersResponse Int
Creating a Request
data ListOrders Source #
See: newListOrders
smart constructor.
ListOrders' | |
|
Instances
:: Text | |
-> ListOrders |
Create a value of ListOrders
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:filters:ListOrders'
, listOrders_filters
- The filters.
NETWORK_SITE
- The Amazon Resource Name (ARN) of the network site.STATUS
- The status (ACKNOWLEDGING
|ACKNOWLEDGED
|UNACKNOWLEDGED
).
Filter values are case sensitive. If you specify multiple values for a
filter, the values are joined with an OR
, and the request returns all
results that match any of the specified values.
$sel:maxResults:ListOrders'
, listOrders_maxResults
- The maximum number of results to return.
$sel:startToken:ListOrders'
, listOrders_startToken
- The token for the next page of results.
ListOrders
, listOrders_networkArn
- The Amazon Resource Name (ARN) of the network.
Request Lenses
listOrders_filters :: Lens' ListOrders (Maybe (HashMap OrderFilterKeys [Text])) Source #
The filters.
NETWORK_SITE
- The Amazon Resource Name (ARN) of the network site.STATUS
- The status (ACKNOWLEDGING
|ACKNOWLEDGED
|UNACKNOWLEDGED
).
Filter values are case sensitive. If you specify multiple values for a
filter, the values are joined with an OR
, and the request returns all
results that match any of the specified values.
listOrders_maxResults :: Lens' ListOrders (Maybe Natural) Source #
The maximum number of results to return.
listOrders_startToken :: Lens' ListOrders (Maybe Text) Source #
The token for the next page of results.
listOrders_networkArn :: Lens' ListOrders Text Source #
The Amazon Resource Name (ARN) of the network.
Destructuring the Response
data ListOrdersResponse Source #
See: newListOrdersResponse
smart constructor.
Instances
newListOrdersResponse Source #
Create a value of ListOrdersResponse
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:nextToken:ListOrdersResponse'
, listOrdersResponse_nextToken
- The token for the next page of results.
$sel:orders:ListOrdersResponse'
, listOrdersResponse_orders
- Information about the orders.
$sel:httpStatus:ListOrdersResponse'
, listOrdersResponse_httpStatus
- The response's http status code.
Response Lenses
listOrdersResponse_nextToken :: Lens' ListOrdersResponse (Maybe Text) Source #
The token for the next page of results.
listOrdersResponse_orders :: Lens' ListOrdersResponse (Maybe [Order]) Source #
Information about the orders.
listOrdersResponse_httpStatus :: Lens' ListOrdersResponse Int Source #
The response's http status code.