Skip to content

DescribeEndpointsRequest

Source code in docs_src/capo_mediaconvert/types/describe_endpoints_request.py
class DescribeEndpointsRequest(TypedDict, closed=True):
    max_results: NotRequired["capo_mediaconvert.types.__integer.__integer"]
    """Optional. Max number of endpoints, up to twenty, that will be returned at one time."""
    mode: NotRequired[
        "capo_mediaconvert.types.describe_endpoints_mode.DescribeEndpointsMode"
    ]
    """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."""
    next_token: NotRequired["capo_mediaconvert.types.__string.__string"]
    """Use this string, provided with the response to a previous request, to request the next batch of endpoints."""

max_results instance-attribute

max_results: NotRequired[__integer]

Optional. Max number of endpoints, up to twenty, that will be returned at one time.

mode instance-attribute

mode: NotRequired[DescribeEndpointsMode]

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.

next_token instance-attribute

next_token: NotRequired[__string]

Use this string, provided with the response to a previous request, to request the next batch of endpoints.