Amazonka.MediaConnect.ListOfferings

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.

Creating a Request

data ListOfferings

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

ToHeaders ListOfferings

Defined in Amazonka.MediaConnect.ListOfferings

Methods

toHeaders :: ListOfferings -> [Header]

ToPath ListOfferings

Defined in Amazonka.MediaConnect.ListOfferings

Methods

toPath :: ListOfferings -> ByteString

ToQuery ListOfferings

Defined in Amazonka.MediaConnect.ListOfferings

Methods

toQuery :: ListOfferings -> QueryString

AWSPager ListOfferings

Defined in Amazonka.MediaConnect.ListOfferings

Methods

page :: ListOfferings -> AWSResponse ListOfferings -> Maybe ListOfferings

AWSRequest ListOfferings

Defined in Amazonka.MediaConnect.ListOfferings

Associated Types

type AWSResponse ListOfferings

Methods

request :: (Service -> Service) -> ListOfferings -> Request ListOfferings

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListOfferings -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListOfferings)))

Generic ListOfferings

Defined in Amazonka.MediaConnect.ListOfferings

Associated Types

type Rep ListOfferings :: Type -> Type

Methods

from :: ListOfferings -> Rep ListOfferings x

to :: Rep ListOfferings x -> ListOfferings

Read ListOfferings

Defined in Amazonka.MediaConnect.ListOfferings

Methods

readsPrec :: Int -> ReadS ListOfferings

readList :: ReadS [ListOfferings]

readPrec :: ReadPrec ListOfferings

readListPrec :: ReadPrec [ListOfferings]

Show ListOfferings

Defined in Amazonka.MediaConnect.ListOfferings

Methods

showsPrec :: Int -> ListOfferings -> ShowS

show :: ListOfferings -> String

showList :: [ListOfferings] -> ShowS

NFData ListOfferings

Defined in Amazonka.MediaConnect.ListOfferings

Methods

rnf :: ListOfferings -> ()

Eq ListOfferings

Defined in Amazonka.MediaConnect.ListOfferings

Methods

(==) :: ListOfferings -> ListOfferings -> Bool

(/=) :: ListOfferings -> ListOfferings -> Bool

Hashable ListOfferings

Defined in Amazonka.MediaConnect.ListOfferings

Methods

hashWithSalt :: Int -> ListOfferings -> Int

hash :: ListOfferings -> Int

type AWSResponse ListOfferings

Defined in Amazonka.MediaConnect.ListOfferings

type AWSResponse ListOfferings = ListOfferingsResponse

type Rep ListOfferings

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

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)

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)

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

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

Generic ListOfferingsResponse

Defined in Amazonka.MediaConnect.ListOfferings

Associated Types

type Rep ListOfferingsResponse :: Type -> Type

Methods

from :: ListOfferingsResponse -> Rep ListOfferingsResponse x

to :: Rep ListOfferingsResponse x -> ListOfferingsResponse

Read ListOfferingsResponse

Defined in Amazonka.MediaConnect.ListOfferings

Methods

readsPrec :: Int -> ReadS ListOfferingsResponse

readList :: ReadS [ListOfferingsResponse]

readPrec :: ReadPrec ListOfferingsResponse

readListPrec :: ReadPrec [ListOfferingsResponse]

Show ListOfferingsResponse

Defined in Amazonka.MediaConnect.ListOfferings

Methods

showsPrec :: Int -> ListOfferingsResponse -> ShowS

show :: ListOfferingsResponse -> String

showList :: [ListOfferingsResponse] -> ShowS

NFData ListOfferingsResponse

Defined in Amazonka.MediaConnect.ListOfferings

Methods

rnf :: ListOfferingsResponse -> ()

Eq ListOfferingsResponse

Defined in Amazonka.MediaConnect.ListOfferings

Methods

(==) :: ListOfferingsResponse -> ListOfferingsResponse -> Bool

(/=) :: ListOfferingsResponse -> ListOfferingsResponse -> Bool

type Rep ListOfferingsResponse

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

Arguments

:: Int

$sel:httpStatus:ListOfferingsResponse'

-> ListOfferingsResponse

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)

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])

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

listOfferingsResponse_httpStatus :: Lens' ListOfferingsResponse Int

The response's http status code.