MediaConnect / Client / list_entitlements

list_entitlements#

MediaConnect.Client.list_entitlements(**kwargs)#

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

Request Syntax

response = client.list_entitlements(
    MaxResults=123,
    NextToken='string'
)

Parameters:

MaxResults (integer) – 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 (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Entitlements': [
        {
            'DataTransferSubscriberFeePercent': 123,
            'EntitlementArn': 'string',
            'EntitlementName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) – AWS Elemental MediaConnect returned the list of entitlements successfully.
- Entitlements (list) – A list of entitlements that have been granted to you from other AWS accounts.
  - (dict) – An entitlement that has been granted to you from other AWS accounts.
    - DataTransferSubscriberFeePercent (integer) – Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
    - EntitlementArn (string) – The ARN of the entitlement.
    - EntitlementName (string) – The name of the entitlement.
- NextToken (string) – 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.

Exceptions

MediaConnect.Client.exceptions.ServiceUnavailableException
MediaConnect.Client.exceptions.TooManyRequestsException
MediaConnect.Client.exceptions.BadRequestException
MediaConnect.Client.exceptions.InternalServerErrorException