| 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 |
Amazonka.MediaConnect.ListReservations
Description
Displays a list of all reservations that have been purchased by this account in the current AWS Region. This list includes all reservations in all states (such as active and expired).
This operation returns paginated results.
Synopsis
- data ListReservations = ListReservations' {}
- newListReservations :: ListReservations
- listReservations_maxResults :: Lens' ListReservations (Maybe Natural)
- listReservations_nextToken :: Lens' ListReservations (Maybe Text)
- data ListReservationsResponse = ListReservationsResponse' {
- nextToken :: Maybe Text
- reservations :: Maybe [Reservation]
- httpStatus :: Int
- newListReservationsResponse :: Int -> ListReservationsResponse
- listReservationsResponse_nextToken :: Lens' ListReservationsResponse (Maybe Text)
- listReservationsResponse_reservations :: Lens' ListReservationsResponse (Maybe [Reservation])
- listReservationsResponse_httpStatus :: Lens' ListReservationsResponse Int
Creating a Request
data ListReservations Source #
See: newListReservations smart constructor.
Constructors
| ListReservations' | |
Fields
| |
Instances
newListReservations :: ListReservations Source #
Create a value of ListReservations 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:maxResults:ListReservations', listReservations_maxResults - The maximum number of results to return per API request. For example,
you submit a ListReservations request with MaxResults set at 5. Although
20 items match your request, the service returns no more than the first
5 items. (The service also returns a NextToken value that you can use to
fetch the next batch of results.) The service might return fewer results
than the MaxResults value. If MaxResults is not included in the request,
the service defaults to pagination with a maximum of 10 results per
page.
ListReservations, listReservations_nextToken - The token that identifies which batch of results that you want to see.
For example, you submit a ListReservations request with MaxResults set
at 5. The service returns the first batch of results (up to 5) and a
NextToken value. To see the next batch of results, you can submit the
ListOfferings request a second time and specify the NextToken value.
Request Lenses
listReservations_maxResults :: Lens' ListReservations (Maybe Natural) Source #
The maximum number of results to return per API request. For example, you submit a ListReservations request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.
listReservations_nextToken :: Lens' ListReservations (Maybe Text) Source #
The token that identifies which batch of results that you want to see. For example, you submit a ListReservations request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListOfferings request a second time and specify the NextToken value.
Destructuring the Response
data ListReservationsResponse Source #
See: newListReservationsResponse smart constructor.
Constructors
| ListReservationsResponse' | |
Fields
| |
Instances
newListReservationsResponse Source #
Create a value of ListReservationsResponse 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:
ListReservations, listReservationsResponse_nextToken - The token that identifies which batch of results that you want to see.
For example, you submit a ListReservations request with MaxResults set
at 5. The service returns the first batch of results (up to 5) and a
NextToken value. To see the next batch of results, you can submit the
ListReservations request a second time and specify the NextToken value.
$sel:reservations:ListReservationsResponse', listReservationsResponse_reservations - A list of all reservations that have been purchased by this account in
the current AWS Region.
$sel:httpStatus:ListReservationsResponse', listReservationsResponse_httpStatus - The response's http status code.
Response Lenses
listReservationsResponse_nextToken :: Lens' ListReservationsResponse (Maybe Text) Source #
The token that identifies which batch of results that you want to see. For example, you submit a ListReservations request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListReservations request a second time and specify the NextToken value.
listReservationsResponse_reservations :: Lens' ListReservationsResponse (Maybe [Reservation]) Source #
A list of all reservations that have been purchased by this account in the current AWS Region.
listReservationsResponse_httpStatus :: Lens' ListReservationsResponse Int Source #
The response's http status code.