NetworkInterface - AWS IoT FleetWise

NetworkInterface

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 ListDecoderManifestNetworkInterfaces API operation.

Contents

interfaceId

The ID of the network interface.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Required: Yes

type

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.

Type: String

Valid Values: CAN_INTERFACE | OBD_INTERFACE | VEHICLE_MIDDLEWARE | CUSTOM_DECODING_INTERFACE

Required: Yes

canInterface

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

Type: CanInterface object

Required: No

customDecodingInterface

Information about a custom network interface.

Type: CustomDecodingInterface object

Required: No

obdInterface

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

Type: ObdInterface object

Required: No

vehicleMiddleware

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

Type: VehicleMiddleware object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: