IoTFleetWise / Client / list_decoder_manifest_network_interfaces

list_decoder_manifest_network_interfaces

IoTFleetWise.Client.list_decoder_manifest_network_interfaces(**kwargs)

Lists the network interfaces specified in a decoder manifest.

Note

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

See also: AWS API Documentation

Request Syntax

response = client.list_decoder_manifest_network_interfaces(
    name='string',
    nextToken='string',
    maxResults=123
)

Parameters:

• name (string) –

  [REQUIRED]

  The name of the decoder manifest to list information about.

• nextToken (string) –

  A pagination token for the next set of results.

  If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

• maxResults (integer) – The maximum number of items to return, between 1 and 100, inclusive.

Return type:

dict

Returns:

Response Syntax

{
    'networkInterfaces': [
        {
            'interfaceId': 'string',
            'type': 'CAN_INTERFACE'|'OBD_INTERFACE'|'VEHICLE_MIDDLEWARE',
            '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'
            }
        },
    ],
    '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.

  • nextToken (string) –

    The token to retrieve the next set of results, or null if there are no more results.

Exceptions

• IoTFleetWise.Client.exceptions.ResourceNotFoundException

• IoTFleetWise.Client.exceptions.InternalServerException

• IoTFleetWise.Client.exceptions.ThrottlingException

• IoTFleetWise.Client.exceptions.ValidationException

• IoTFleetWise.Client.exceptions.AccessDeniedException