amazonka-mediaconnect-2.0: Amazon MediaConnect SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

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

Creating a Request

data ListOfferings Source #

See: newListOfferings smart constructor.

Constructors

ListOfferings' 

Fields

  • maxResults :: Maybe Natural

    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.

  • nextToken :: Maybe Text

    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.

Instances

Instances details
ToHeaders ListOfferings Source # 
Instance details

Defined in Amazonka.MediaConnect.ListOfferings

ToPath ListOfferings Source # 
Instance details

Defined in Amazonka.MediaConnect.ListOfferings

ToQuery ListOfferings Source # 
Instance details

Defined in Amazonka.MediaConnect.ListOfferings

AWSPager ListOfferings Source # 
Instance details

Defined in Amazonka.MediaConnect.ListOfferings

AWSRequest ListOfferings Source # 
Instance details

Defined in Amazonka.MediaConnect.ListOfferings

Associated Types

type AWSResponse ListOfferings #

Generic ListOfferings Source # 
Instance details

Defined in Amazonka.MediaConnect.ListOfferings

Associated Types

type Rep ListOfferings :: Type -> Type #

Read ListOfferings Source # 
Instance details

Defined in Amazonka.MediaConnect.ListOfferings

Show ListOfferings Source # 
Instance details

Defined in Amazonka.MediaConnect.ListOfferings

NFData ListOfferings Source # 
Instance details

Defined in Amazonka.MediaConnect.ListOfferings

Methods

rnf :: ListOfferings -> () #

Eq ListOfferings Source # 
Instance details

Defined in Amazonka.MediaConnect.ListOfferings

Hashable ListOfferings Source # 
Instance details

Defined in Amazonka.MediaConnect.ListOfferings

type AWSResponse ListOfferings Source # 
Instance details

Defined in Amazonka.MediaConnect.ListOfferings

type Rep ListOfferings Source # 
Instance details

Defined in Amazonka.MediaConnect.ListOfferings

type Rep ListOfferings = D1 ('MetaData "ListOfferings" "Amazonka.MediaConnect.ListOfferings" "amazonka-mediaconnect-2.0-KNF7B97aPsN1PZ2vBYFgux" 'False) (C1 ('MetaCons "ListOfferings'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

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: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.

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.

Request Lenses

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.

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.

Destructuring the Response

data ListOfferingsResponse Source #

See: newListOfferingsResponse smart constructor.

Constructors

ListOfferingsResponse' 

Fields

  • nextToken :: Maybe Text

    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.

  • offerings :: Maybe [Offering]

    A list of offerings that are available to this account in the current AWS Region.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListOfferingsResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.ListOfferings

Associated Types

type Rep ListOfferingsResponse :: Type -> Type #

Read ListOfferingsResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.ListOfferings

Show ListOfferingsResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.ListOfferings

NFData ListOfferingsResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.ListOfferings

Methods

rnf :: ListOfferingsResponse -> () #

Eq ListOfferingsResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.ListOfferings

type Rep ListOfferingsResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.ListOfferings

type Rep ListOfferingsResponse = D1 ('MetaData "ListOfferingsResponse" "Amazonka.MediaConnect.ListOfferings" "amazonka-mediaconnect-2.0-KNF7B97aPsN1PZ2vBYFgux" 'False) (C1 ('MetaCons "ListOfferingsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "offerings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Offering])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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:

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.