:doc:`IoTFleetWise <../../iotfleetwise>` / Paginator / ListDecoderManifestNetworkInterfaces

************************************
ListDecoderManifestNetworkInterfaces
************************************



.. py:class:: IoTFleetWise.Paginator.ListDecoderManifestNetworkInterfaces

  ::

    
    paginator = client.get_paginator('list_decoder_manifest_network_interfaces')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`IoTFleetWise.Client.list_decoder_manifest_network_interfaces`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iotfleetwise-2021-06-17/ListDecoderManifestNetworkInterfaces>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          name='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type name: string
    :param name: **[REQUIRED]** 

      The name of the decoder manifest to list information about.

      

    
    :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**

      
      ::

        {
            'networkInterfaces': [
                {
                    'interfaceId': 'string',
                    'type': 'CAN_INTERFACE'|'OBD_INTERFACE'|'VEHICLE_MIDDLEWARE'|'CUSTOM_DECODING_INTERFACE',
                    'canInterface': {
                        'name': 'string',
                        'protocolName': 'string',
                        'protocolVersion': 'string'
                    },
                    'obdInterface': {
                        'name': 'string',
                        'requestMessageId': 123,
                        'obdStandard': 'string',
                        'pidRequestIntervalSeconds': 123,
                        'dtcRequestIntervalSeconds': 123,
                        'useExtendedIds': True|False,
                        'hasTransmissionEcu': True|False
                    },
                    'vehicleMiddleware': {
                        'name': 'string',
                        'protocolName': 'ROS_2'
                    },
                    'customDecodingInterface': {
                        'name': 'string'
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **networkInterfaces** *(list) --* 

          A list of information about network interfaces.

          
          

          - *(dict) --* 

            Represents a node and its specifications in an in-vehicle communication network. All signal decoders must be associated with a network node.

             

            To return this information about all the network interfaces specified in a decoder manifest, use the API operation.

            
            

            - **interfaceId** *(string) --* 

              The ID of the network interface.

              
            

            - **type** *(string) --* 

              The network protocol for the vehicle. For example, ``CAN_SIGNAL`` specifies a protocol that defines how data is communicated between electronic control units (ECUs). ``OBD_SIGNAL`` specifies a protocol that defines how self-diagnostic data is communicated between ECUs.

              
            

            - **canInterface** *(dict) --* 

              Information about a network interface specified by the Controller Area Network (CAN) protocol.

              
              

              - **name** *(string) --* 

                The unique name of the interface.

                
              

              - **protocolName** *(string) --* 

                The name of the communication protocol for the interface.

                
              

              - **protocolVersion** *(string) --* 

                The version of the communication protocol for the interface.

                
          
            

            - **obdInterface** *(dict) --* 

              Information about a network interface specified by the on-board diagnostic (OBD) II protocol.

              
              

              - **name** *(string) --* 

                The name of the interface.

                
              

              - **requestMessageId** *(integer) --* 

                The ID of the message requesting vehicle data.

                
              

              - **obdStandard** *(string) --* 

                The standard OBD II PID.

                
              

              - **pidRequestIntervalSeconds** *(integer) --* 

                The maximum number message requests per second.

                
              

              - **dtcRequestIntervalSeconds** *(integer) --* 

                The maximum number message requests per diagnostic trouble code per second.

                
              

              - **useExtendedIds** *(boolean) --* 

                Whether to use extended IDs in the message.

                
              

              - **hasTransmissionEcu** *(boolean) --* 

                Whether the vehicle has a transmission control module (TCM).

                
          
            

            - **vehicleMiddleware** *(dict) --* 

              The vehicle middleware defined as a type of network interface. Examples of vehicle middleware include ``ROS2`` and ``SOME/IP``.

              
              

              - **name** *(string) --* 

                The name of the vehicle middleware.

                
              

              - **protocolName** *(string) --* 

                The protocol name of the vehicle middleware.

                
          
            

            - **customDecodingInterface** *(dict) --* 

              Information about a `custom network interface <https://docs.aws.amazon.com/iot-fleetwise/latest/APIReference/API_CustomDecodingInterface.html>`__.

              
              

              - **name** *(string) --* 

                The name of the interface.

                
          
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    