MediaConnect / Client / list_router_network_interfaces

list_router_network_interfaces¶

MediaConnect.Client.list_router_network_interfaces(**kwargs)¶

Retrieves a list of router network interfaces in AWS Elemental MediaConnect.

Request Syntax

response = client.list_router_network_interfaces(
    MaxResults=123,
    NextToken='string',
    Filters=[
        {
            'RegionNames': [
                'string',
            ],
            'NetworkInterfaceTypes': [
                'PUBLIC'|'VPC',
            ],
            'NameContains': [
                'string',
            ]
        },
    ]
)

Parameters:

MaxResults (integer) – The maximum number of router network interfaces 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 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) –

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)
        },
    ],
    'NextToken': 'string'
}

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 Amazon Web Services 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.
- NextToken (string) –
  
  The token to use to retrieve the next page of results.

Exceptions

MediaConnect.Client.exceptions.BadRequestException
MediaConnect.Client.exceptions.TooManyRequestsException
MediaConnect.Client.exceptions.ConflictException
MediaConnect.Client.exceptions.InternalServerErrorException
MediaConnect.Client.exceptions.ServiceUnavailableException