| 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.MediaConnect.ListOfferings
Description
Displays a list of all offerings that are available to this account in the current AWS Region. If you have an active reservation (which means you've purchased an offering that has already started and hasn't expired yet), your account isn't eligible for other offerings.
This operation returns paginated results.
Synopsis
- data ListOfferings = ListOfferings' {}
- newListOfferings :: ListOfferings
- listOfferings_nextToken :: Lens' ListOfferings (Maybe Text)
- listOfferings_maxResults :: Lens' ListOfferings (Maybe Natural)
- data ListOfferingsResponse = ListOfferingsResponse' {}
- newListOfferingsResponse :: Int -> ListOfferingsResponse
- listOfferingsResponse_nextToken :: Lens' ListOfferingsResponse (Maybe Text)
- listOfferingsResponse_offerings :: Lens' ListOfferingsResponse (Maybe [Offering])
- listOfferingsResponse_httpStatus :: Lens' ListOfferingsResponse Int
Creating a Request
data ListOfferings Source #
See: newListOfferings smart constructor.
Constructors
| ListOfferings' | |
Fields
| |
Instances
newListOfferings :: ListOfferings Source #
Create a value of ListOfferings 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:ListOfferings', listOfferings_nextToken - The token that identifies which batch of results that you want to see.
For example, you submit a ListOfferings 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.
$sel:maxResults:ListOfferings', listOfferings_maxResults - The maximum number of results to return per API request. For example,
you submit a ListOfferings 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.
Request Lenses
listOfferings_nextToken :: Lens' ListOfferings (Maybe Text) Source #
The token that identifies which batch of results that you want to see. For example, you submit a ListOfferings 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.
listOfferings_maxResults :: Lens' ListOfferings (Maybe Natural) Source #
The maximum number of results to return per API request. For example, you submit a ListOfferings 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.
Destructuring the Response
data ListOfferingsResponse Source #
See: newListOfferingsResponse smart constructor.
Constructors
| ListOfferingsResponse' | |
Fields
| |
Instances
newListOfferingsResponse Source #
Create a value of ListOfferingsResponse 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:ListOfferings', listOfferingsResponse_nextToken - The token that identifies which batch of results that you want to see.
For example, you submit a ListOfferings 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.
$sel:offerings:ListOfferingsResponse', listOfferingsResponse_offerings - A list of offerings that are available to this account in the current
AWS Region.
$sel:httpStatus:ListOfferingsResponse', listOfferingsResponse_httpStatus - The response's http status code.
Response Lenses
listOfferingsResponse_nextToken :: Lens' ListOfferingsResponse (Maybe Text) Source #
The token that identifies which batch of results that you want to see. For example, you submit a ListOfferings 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.
listOfferingsResponse_offerings :: Lens' ListOfferingsResponse (Maybe [Offering]) Source #
A list of offerings that are available to this account in the current AWS Region.
listOfferingsResponse_httpStatus :: Lens' ListOfferingsResponse Int Source #
The response's http status code.