:doc:`MediaConnect <../../mediaconnect>` / Paginator / ListRouterInputs

****************
ListRouterInputs
****************



.. py:class:: MediaConnect.Paginator.ListRouterInputs

  ::

    
    paginator = client.get_paginator('list_router_inputs')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`MediaConnect.Client.list_router_inputs`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/ListRouterInputs>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          Filters=[
              {
                  'RegionNames': [
                      'string',
                  ],
                  'InputTypes': [
                      'STANDARD'|'FAILOVER'|'MERGE'|'MEDIACONNECT_FLOW',
                  ],
                  'NameContains': [
                      'string',
                  ],
                  'NetworkInterfaceArns': [
                      'string',
                  ],
                  'RoutingScopes': [
                      'REGIONAL'|'GLOBAL',
                  ]
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type Filters: list
    :param Filters: 

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

      

    
      - *(dict) --* 

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

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

      
        - **RegionNames** *(list) --* 

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

          

        
          - *(string) --* 

          
      
        - **InputTypes** *(list) --* 

          The types of router inputs to include in the filter.

          

        
          - *(string) --* 

          
      
        - **NameContains** *(list) --* 

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

          

        
          - *(string) --* 

          
      
        - **NetworkInterfaceArns** *(list) --* 

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

          

        
          - *(string) --* 

          
      
        - **RoutingScopes** *(list) --* 

          Filter criteria to list router inputs based on their routing scope (REGIONAL or GLOBAL).

          

        
          - *(string) --* 

          
      
      
  
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'RouterInputs': [
                {
                    'Name': 'string',
                    'Arn': 'string',
                    'Id': 'string',
                    'InputType': 'STANDARD'|'FAILOVER'|'MERGE'|'MEDIACONNECT_FLOW',
                    'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING',
                    'RoutedOutputs': 123,
                    'RegionName': 'string',
                    'AvailabilityZone': 'string',
                    'MaximumBitrate': 123,
                    'RoutingScope': 'REGIONAL'|'GLOBAL',
                    'CreatedAt': datetime(2015, 1, 1),
                    'UpdatedAt': datetime(2015, 1, 1),
                    'MessageCount': 123,
                    'NetworkInterfaceArn': 'string',
                    'MaintenanceScheduleType': 'WINDOW',
                    'MaintenanceSchedule': {
                        'Window': {
                            'Start': datetime(2015, 1, 1),
                            'End': datetime(2015, 1, 1),
                            'ScheduledTime': datetime(2015, 1, 1)
                        }
                    }
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **RouterInputs** *(list) --* 

          The summary information for the retrieved router inputs.

          
          

          - *(dict) --* 

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

            
            

            - **Name** *(string) --* 

              The name of the router input.

              
            

            - **Arn** *(string) --* 

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

              
            

            - **Id** *(string) --* 

              The unique identifier of the router input.

              
            

            - **InputType** *(string) --* 

              The type of the router input.

              
            

            - **State** *(string) --* 

              The overall state of the router input.

              
            

            - **RoutedOutputs** *(integer) --* 

              The number of router outputs that are associated with this router input.

              
            

            - **RegionName** *(string) --* 

              The Amazon Web Services Region where the router input is located.

              
            

            - **AvailabilityZone** *(string) --* 

              The Availability Zone of the router input.

              
            

            - **MaximumBitrate** *(integer) --* 

              The maximum bitrate of the router input.

              
            

            - **RoutingScope** *(string) --* 

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

              
            

            - **CreatedAt** *(datetime) --* 

              The timestamp when the router input was created.

              
            

            - **UpdatedAt** *(datetime) --* 

              The timestamp when the router input was last updated.

              
            

            - **MessageCount** *(integer) --* 

              The number of messages associated with the router input.

              
            

            - **NetworkInterfaceArn** *(string) --* 

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

              
            

            - **MaintenanceScheduleType** *(string) --* 

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

              
            

            - **MaintenanceSchedule** *(dict) --* 

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

              .. 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.

                  
            
          
        
      
    