AWS Elemental MediaConnect
API Reference

ListEntitlements

URI

/v1/entitlements

HTTP Methods

GET

Operation ID: ListEntitlements

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

Query Parameters

Name Type Required Description
nextToken String False

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 String False

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.

Responses

Status Code Response Model Description
200 ListEntitlementsResponse

AWS Elemental MediaConnect returned the list of entitlements successfully.

400 ResponseError

The request that you submitted is not valid.

429 ResponseError

You have exceeded the service request rate limit for your AWS Elemental MediaConnect account.

500 ResponseError

AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition.

503 ResponseError

AWS Elemental MediaConnect is currently unavailable. Try again later.

See Also

Schemas

Response Bodies

Example ListEntitlementsResponse

{ "entitlements": [ { "entitlementArn": "string", "entitlementName": "string" } ], "nextToken": "string" }

Example ResponseError

{ "message": "string" }

Properties

ListEntitlementsResponse

The result of a successful ListEntitlements request. The response includes the Amazon Resource Name (ARN) of each entitlement, the name of the associated flow, and the NextToken to use in a subsequent ListEntitlements request.

Property Type Required Description
entitlements

array

True

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

nextToken

string

False

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.

See Also

ListedEntitlement

An entitlement that has been granted to you from other AWS accounts.

Property Type Required Description
entitlementArn

string

True

The ARN of the entitlement.

entitlementName

string

True

The name of the entitlement.

See Also

ResponseError

An exception raised by AWS Elemental MediaConnect when you submit a request that cannot be completed. For more information, see the error message and documentation for the operation.

Property Type Required Description
message

string

True

The specific error message that AWS Elemental MediaConnect returns to help you understand the reason that the request did not succeed.

See Also