MediaConnect / Client / list_destination_endpoints

list_destination_endpoints

MediaConnect.Client.list_destination_endpoints(**kwargs)

Retrieves a list of the destination endpoints in your account. The results are paginated. Use the NextToken value that’s returned to retrieve additional results.

See also: AWS API Documentation

Request Syntax

response = client.list_destination_endpoints(
    MaxResults=123,
    NextToken='string',
    Filters=[
        {
            'RegionNames': [
                'string',
            ],
            'DestinationTypes': [
                'STANDARD'|'ROUTER_INPUT',
            ],
            'NameContains': [
                'string',
            ]
        },
    ]
)
Parameters:

  • MaxResults (integer) – The maximum number of results to return in a single request. The valid range is 1 to 100. If you don’t specify a value, the service returns up to 100 results.

  • NextToken (string) – The token that identifies the next page of results to return. Use the token that a previous request returned.

  • Filters (list) –

    The filters to apply to the list of destination endpoints.

    • (dict) –

      A filter to apply when listing destination endpoints. This is a union type, so exactly one of its members is set.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: RegionNames, DestinationTypes, NameContains.

      • RegionNames (list) –

        Filters the results to destination endpoints in the specified Amazon Web Services Regions.

        • (string) –

      • DestinationTypes (list) –

        Filters the results to destination endpoints of the specified types.

        • (string) –

      • NameContains (list) –

        Filters the results to destination endpoints whose names contain the specified strings.

        • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'DestinationEndpoints': [
        {
            'Name': 'string',
            'Arn': 'string',
            'Id': 'string',
            'DestinationType': 'STANDARD'|'ROUTER_INPUT',
            'RegionName': 'string',
            'AvailabilityZone': 'string',
            'AvailabilityZoneId': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'LifecycleManagement': 'MANAGED'|'UNMANAGED',
            'MessageCount': 123,
            'ResourceShareOwnership': 'OWNED'|'CONSUMED',
            'ResourceShareState': 'SHARED'|'UNSHARED',
            'RegistrationState': 'REGISTERED'|'REGISTERING'|'DEREGISTERING'|'REGISTRATION_FAILED',
            'ConnectionState': 'CONNECTED'|'DISCONNECTED'|'CONNECTING'|'DISCONNECTING',
            'DecryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
            'ConnectedSource': 'string',
            'AssociatedResourceArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • DestinationEndpoints (list) –

      The destination endpoints that match the request.

      • (dict) –

        A summary of a destination endpoint that the ListDestinationEndpoints operation returns.

        • Name (string) –

          The name of the destination endpoint.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the destination endpoint.

        • Id (string) –

          The unique identifier of the destination endpoint.

        • DestinationType (string) –

          The type of the destination endpoint. Valid values include the following:

          • STANDARD – A destination endpoint that represents an external destination over a standard protocol, such as RTP, RIST, or SRT.

          • ROUTER_INPUT – A destination endpoint that represents a router input.

        • RegionName (string) –

          The name of the Amazon Web Services Region in which the destination endpoint is located.

        • AvailabilityZone (string) –

          The Availability Zone in which the destination endpoint is located.

        • AvailabilityZoneId (string) –

          The ID of the Availability Zone in which the destination endpoint is located.

        • CreatedAt (datetime) –

          The date and time when the destination endpoint was created.

        • UpdatedAt (datetime) –

          The date and time when the destination endpoint was last updated.

        • LifecycleManagement (string) –

          The entity that manages the lifecycle of the destination endpoint.

        • MessageCount (integer) –

          The number of status messages for the destination endpoint.

        • ResourceShareOwnership (string) –

          Indicates whether this account owns the destination endpoint or consumes it from another account through RAM.

        • ResourceShareState (string) –

          The sharing state of the destination endpoint.

        • RegistrationState (string) –

          The registration state of the destination endpoint. Valid values include the following:

          • REGISTERED – The destination endpoint is registered and ready to use.

          • REGISTERING – MediaConnect is registering the destination endpoint.

          • DEREGISTERING – MediaConnect is deregistering the destination endpoint.

          • REGISTRATION_FAILED – MediaConnect couldn’t register the destination endpoint.

        • ConnectionState (string) –

          The connection state of the destination endpoint. Valid values include the following:

          • CONNECTED – The destination endpoint is connected to a source endpoint.

          • DISCONNECTED – The destination endpoint isn’t connected to a source endpoint.

          • CONNECTING – The destination endpoint is connecting to a source endpoint.

          • DISCONNECTING – The destination endpoint is disconnecting from a source endpoint.

        • DecryptionType (string) –

          The type of decryption used for the destination endpoint connection.

        • ConnectedSource (string) –

          The Amazon Resource Name (ARN) of the source endpoint that is connected to the destination endpoint.

        • AssociatedResourceArn (string) –

          The Amazon Resource Name (ARN) of the resource that is associated with the destination endpoint.

    • NextToken (string) –

      The token to use in the next request to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions