MediaConvert / Client / describe_endpoints

describe_endpoints#

MediaConvert.Client.describe_endpoints(**kwargs)#

Send an request with an empty body to the regional API endpoint to get your account API endpoint.

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 = client.describe_endpoints(
    MaxResults=123,
    Mode='DEFAULT'|'GET_ONLY',
    NextToken='string'
)
Parameters:

  • MaxResults (integer) – Optional. Max number of endpoints, up to twenty, that will be returned at one time.

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

  • NextToken (string) – Use this string, provided with the response to a previous request, to request the next batch of endpoints.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • Endpoints (list) – List of endpoints

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

        • Url (string) – URL of endpoint

    • NextToken (string) – Use this string to request the next batch of endpoints.

Exceptions

  • MediaConvert.Client.exceptions.BadRequestException

  • MediaConvert.Client.exceptions.InternalServerErrorException

  • MediaConvert.Client.exceptions.ForbiddenException

  • MediaConvert.Client.exceptions.NotFoundException

  • MediaConvert.Client.exceptions.TooManyRequestsException

  • MediaConvert.Client.exceptions.ConflictException