libZSservicesZSamazonka-mediaconnectZSamazonka-mediaconnect
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

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

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

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

Instances

Instances details
Eq ListEntitlements Source # 
Instance details

Defined in Amazonka.MediaConnect.ListEntitlements

Read ListEntitlements Source # 
Instance details

Defined in Amazonka.MediaConnect.ListEntitlements

Show ListEntitlements Source # 
Instance details

Defined in Amazonka.MediaConnect.ListEntitlements

Generic ListEntitlements Source # 
Instance details

Defined in Amazonka.MediaConnect.ListEntitlements

Associated Types

type Rep ListEntitlements :: Type -> Type #

NFData ListEntitlements Source # 
Instance details

Defined in Amazonka.MediaConnect.ListEntitlements

Methods

rnf :: ListEntitlements -> () #

Hashable 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 #

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

type Rep ListEntitlements Source # 
Instance details

Defined in Amazonka.MediaConnect.ListEntitlements

type Rep ListEntitlements = D1 ('MetaData "ListEntitlements" "Amazonka.MediaConnect.ListEntitlements" "libZSservicesZSamazonka-mediaconnectZSamazonka-mediaconnect" 'False) (C1 ('MetaCons "ListEntitlements'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))
type AWSResponse ListEntitlements Source # 
Instance details

Defined in Amazonka.MediaConnect.ListEntitlements

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

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

Request Lenses

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.

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.

Destructuring the Response

data ListEntitlementsResponse Source #

See: newListEntitlementsResponse smart constructor.

Constructors

ListEntitlementsResponse' 

Fields

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

  • entitlements :: Maybe [ListedEntitlement]

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListEntitlementsResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.ListEntitlements

Read ListEntitlementsResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.ListEntitlements

Show ListEntitlementsResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.ListEntitlements

Generic ListEntitlementsResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.ListEntitlements

Associated Types

type Rep ListEntitlementsResponse :: Type -> Type #

NFData 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" "libZSservicesZSamazonka-mediaconnectZSamazonka-mediaconnect" 'False) (C1 ('MetaCons "ListEntitlementsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "entitlements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ListedEntitlement])) :*: 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:

$sel:nextToken: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:entitlements:ListEntitlementsResponse', listEntitlementsResponse_entitlements - A list of entitlements that have been granted to you from other AWS accounts.

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

Response Lenses

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.

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

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