MediaConnect / Client / list_router_outputs

list_router_outputs

MediaConnect.Client.list_router_outputs(**kwargs)

Retrieves a list of router outputs in AWS Elemental MediaConnect.

See also: AWS API Documentation

Request Syntax

response = client.list_router_outputs(
    MaxResults=123,
    NextToken='string',
    Filters=[
        {
            'RegionNames': [
                'string',
            ],
            'OutputTypes': [
                'STANDARD'|'MEDIACONNECT_FLOW'|'MEDIALIVE_INPUT',
            ],
            'NameContains': [
                'string',
            ],
            'NetworkInterfaceArns': [
                'string',
            ],
            'RoutedInputArns': [
                'string',
            ],
            'RoutingScopes': [
                'REGIONAL'|'GLOBAL',
            ]
        },
    ]
)
Parameters:

  • MaxResults (integer) – The maximum number of router outputs to return in the response.

  • NextToken (string) – A token used to retrieve the next page of results.

  • Filters (list) –

    The filters to apply when retrieving the list of router outputs.

    • (dict) –

      A filter that can be used to retrieve a list of router outputs.

      Note

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

      • RegionNames (list) –

        The AWS Regions of the router outputs to include in the filter.

        • (string) –

      • OutputTypes (list) –

        The types of router outputs to include in the filter.

        • (string) –

      • NameContains (list) –

        The names of the router outputs to include in the filter.

        • (string) –

      • NetworkInterfaceArns (list) –

        The Amazon Resource Names (ARNs) of the network interfaces associated with the router outputs to include in the filter.

        • (string) –

      • RoutedInputArns (list) –

        The ARNs of the router inputs associated with the router outputs to include in the filter.

        • (string) –

      • RoutingScopes (list) –

        Filter criteria to list router outputs based on their routing scope.

        • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'RouterOutputs': [
        {
            'Name': 'string',
            'Arn': 'string',
            'Id': 'string',
            'OutputType': 'STANDARD'|'MEDIACONNECT_FLOW'|'MEDIALIVE_INPUT',
            'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING',
            'RoutedState': 'ROUTED'|'ROUTING'|'UNROUTED',
            'RegionName': 'string',
            'AvailabilityZone': 'string',
            'MaximumBitrate': 123,
            'RoutingScope': 'REGIONAL'|'GLOBAL',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'MessageCount': 123,
            'RoutedInputArn': 'string',
            'NetworkInterfaceArn': 'string',
            'MaintenanceScheduleType': 'WINDOW',
            'MaintenanceSchedule': {
                'Window': {
                    'Start': datetime(2015, 1, 1),
                    'End': datetime(2015, 1, 1),
                    'ScheduledTime': datetime(2015, 1, 1)
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • RouterOutputs (list) –

      The summary information for the retrieved router outputs.

      • (dict) –

        A summary of a router output, including its name, type, ARN, ID, state, routed state, and other key details. This structure is used in the response of the ListRouterOutputs operation.

        • Name (string) –

          The name of the router output.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the router output.

        • Id (string) –

          The unique identifier of the router output.

        • OutputType (string) –

          The type of the router output.

        • State (string) –

          The overall state of the router output.

        • RoutedState (string) –

          The current state of the association between the router output and its input.

        • RegionName (string) –

          The AWS Region where the router output is located.

        • AvailabilityZone (string) –

          The Availability Zone of the router output.

        • MaximumBitrate (integer) –

          The maximum bitrate of the router output.

        • RoutingScope (string) –

          Indicates whether the router output is configured for Regional or global routing.

        • CreatedAt (datetime) –

          The timestamp when the router output was created.

        • UpdatedAt (datetime) –

          The timestamp when the router output was last updated.

        • MessageCount (integer) –

          The number of messages associated with the router output.

        • RoutedInputArn (string) –

          The ARN of the router input associated with the output.

        • NetworkInterfaceArn (string) –

          The ARN of the network interface associated with the router output.

        • MaintenanceScheduleType (string) –

          The type of maintenance schedule currently associated with the listed router output.

        • MaintenanceSchedule (dict) –

          The details of the maintenance schedule for the listed router output.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: Window. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

          • Window (dict) –

            Defines a specific time window for maintenance operations.

            • Start (datetime) –

              The start time of the maintenance window.

            • End (datetime) –

              The end time of the maintenance window.

            • ScheduledTime (datetime) –

              The date and time when the maintenance window is scheduled to occur.

    • NextToken (string) –

      The token to use to retrieve the next page of results.

Exceptions