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

Description

Displays a list of all entitlements that have been granted to this account. This request returns 20 results per page.

This operation returns paginated results.

Synopsis

Creating a Request

data ListEntitlements Source #

See: newListEntitlements smart constructor.

Constructors

ListEntitlements' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of results to return per API request. For example, you submit a ListEntitlements 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 20 results per page.

  • nextToken :: Maybe Text

    The token that identifies which batch of results that you want to see. For example, you submit a ListEntitlements 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 ListEntitlements request a second time and specify the NextToken value.

Instances

Instances details
ToHeaders ListEntitlements Source # 
Instance details

Defined in Amazonka.MediaConnect.ListEntitlements

ToPath ListEntitlements Source # 
Instance details

Defined in Amazonka.MediaConnect.ListEntitlements

ToQuery ListEntitlements Source # 
Instance details

Defined in Amazonka.MediaConnect.ListEntitlements

AWSPager ListEntitlements Source # 
Instance details

Defined in Amazonka.MediaConnect.ListEntitlements

AWSRequest ListEntitlements Source # 
Instance details

Defined in Amazonka.MediaConnect.ListEntitlements

Associated Types

type AWSResponse ListEntitlements #

Generic ListEntitlements Source # 
Instance details

Defined in Amazonka.MediaConnect.ListEntitlements

Associated Types

type Rep ListEntitlements :: Type -> Type #

Read ListEntitlements Source # 
Instance details

Defined in Amazonka.MediaConnect.ListEntitlements

Show ListEntitlements Source # 
Instance details

Defined in Amazonka.MediaConnect.ListEntitlements

NFData ListEntitlements Source # 
Instance details

Defined in Amazonka.MediaConnect.ListEntitlements

Methods

rnf :: ListEntitlements -> () #

Eq ListEntitlements Source # 
Instance details

Defined in Amazonka.MediaConnect.ListEntitlements

Hashable ListEntitlements Source # 
Instance details

Defined in Amazonka.MediaConnect.ListEntitlements

type AWSResponse ListEntitlements Source # 
Instance details

Defined in Amazonka.MediaConnect.ListEntitlements

type Rep ListEntitlements Source # 
Instance details

Defined in Amazonka.MediaConnect.ListEntitlements

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

newListEntitlements :: ListEntitlements Source #

Create a value of ListEntitlements 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:ListEntitlements', listEntitlements_maxResults - The maximum number of results to return per API request. For example, you submit a ListEntitlements 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 20 results per page.

ListEntitlements, listEntitlements_nextToken - The token that identifies which batch of results that you want to see. For example, you submit a ListEntitlements 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 ListEntitlements request a second time and specify the NextToken value.

Request Lenses

listEntitlements_maxResults :: Lens' ListEntitlements (Maybe Natural) Source #

The maximum number of results to return per API request. For example, you submit a ListEntitlements 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 20 results per page.

listEntitlements_nextToken :: Lens' ListEntitlements (Maybe Text) Source #

The token that identifies which batch of results that you want to see. For example, you submit a ListEntitlements 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 ListEntitlements request a second time and specify the NextToken value.

Destructuring the Response

data ListEntitlementsResponse Source #

See: newListEntitlementsResponse smart constructor.

Constructors

ListEntitlementsResponse' 

Fields

  • entitlements :: Maybe [ListedEntitlement]

    A list of entitlements that have been granted to you from other AWS accounts.

  • nextToken :: Maybe Text

    The token that identifies which batch of results that you want to see. For example, you submit a ListEntitlements 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 ListEntitlements request a second time and specify the NextToken value.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListEntitlementsResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.ListEntitlements

Associated Types

type Rep ListEntitlementsResponse :: Type -> Type #

Read ListEntitlementsResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.ListEntitlements

Show ListEntitlementsResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.ListEntitlements

NFData ListEntitlementsResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.ListEntitlements

Eq ListEntitlementsResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.ListEntitlements

type Rep ListEntitlementsResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.ListEntitlements

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

newListEntitlementsResponse Source #

Create a value of ListEntitlementsResponse 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:

ListEntitlementsResponse, listEntitlementsResponse_entitlements - A list of entitlements that have been granted to you from other AWS accounts.

ListEntitlements, listEntitlementsResponse_nextToken - The token that identifies which batch of results that you want to see. For example, you submit a ListEntitlements 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 ListEntitlements request a second time and specify the NextToken value.

$sel:httpStatus:ListEntitlementsResponse', listEntitlementsResponse_httpStatus - The response's http status code.

Response Lenses

listEntitlementsResponse_entitlements :: Lens' ListEntitlementsResponse (Maybe [ListedEntitlement]) Source #

A list of entitlements that have been granted to you from other AWS accounts.

listEntitlementsResponse_nextToken :: Lens' ListEntitlementsResponse (Maybe Text) Source #

The token that identifies which batch of results that you want to see. For example, you submit a ListEntitlements 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 ListEntitlements request a second time and specify the NextToken value.