MediaConnect / Paginator / ListRouterNetworkInterfaces

ListRouterNetworkInterfaces

class MediaConnect.Paginator.ListRouterNetworkInterfaces

paginator = client.get_paginator('list_router_network_interfaces')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MediaConnect.Client.list_router_network_interfaces().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'RegionNames': [
                'string',
            ],
            'NetworkInterfaceTypes': [
                'PUBLIC'|'VPC',
            ],
            'NameContains': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Filters (list) –

  The filters to apply when retrieving the list of router network interfaces.

  • (dict) –

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

    Note

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

    • RegionNames (list) –

      The AWS Regions of the router network interfaces to include in the filter.

      • (string) –

    • NetworkInterfaceTypes (list) –

      The types of router network interfaces to include in the filter.

      • (string) –

    • NameContains (list) –

      The names of the router network interfaces to include in the filter.

      • (string) –

• 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

{
    'RouterNetworkInterfaces': [
        {
            'Name': 'string',
            'Arn': 'string',
            'Id': 'string',
            'NetworkInterfaceType': 'PUBLIC'|'VPC',
            'AssociatedOutputCount': 123,
            'AssociatedInputCount': 123,
            'State': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'ERROR'|'RECOVERING',
            'RegionName': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • RouterNetworkInterfaces (list) –

    The summary information for the retrieved router network interfaces.

    • (dict) –

      A summary of a router network interface, including its name, type, ARN, ID, associated input/output counts, state, and other key details. This structure is used in the response of the ListRouterNetworkInterfaces operation.

      • Name (string) –

        The name of the router network interface.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the router network interface.

      • Id (string) –

        The unique identifier of the router network interface.

      • NetworkInterfaceType (string) –

        The type of the router network interface.

      • AssociatedOutputCount (integer) –

        The number of router outputs associated with the network interface.

      • AssociatedInputCount (integer) –

        The number of router inputs associated with the network interface.

      • State (string) –

        The current state of the router network interface.

      • RegionName (string) –

        The AWS Region where the router network interface is located.

      • CreatedAt (datetime) –

        The timestamp when the network interface was created.

      • UpdatedAt (datetime) –

        The timestamp when the router network interface was last updated.