MediaConvert / Paginator / DescribeEndpoints

DescribeEndpoints

class MediaConvert.Paginator.DescribeEndpoints

paginator = client.get_paginator('describe_endpoints')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MediaConvert.Client.describe_endpoints().

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Mode='DEFAULT'|'GET_ONLY',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Mode (string) – Optional field, defaults to DEFAULT. Specify DEFAULT for this operation to return your endpoints if any exist, or to create an endpoint for you and return it if one doesn’t already exist. Specify GET_ONLY to return your endpoints if any exist, or an empty list if none exist.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Endpoints': [
        {
            'Url': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • Endpoints (list) – List of endpoints

    • (dict) – Describes an account-specific API endpoint.

      • Url (string) – URL of endpoint