Amazon IoT FleetWise · JSON Structure

Iot Fleetwise Network Interface Structure

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.

Type: object Properties: 4 Required: 2
AutomotiveConnected VehiclesIoTTelematicsVehicle Data

NetworkInterface is a JSON Structure definition published by Amazon IoT FleetWise, describing 4 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

interfaceId type canInterface obdInterface

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-fleetwise/refs/heads/main/json-structure/iot-fleetwise-network-interface-structure.json",
  "name": "NetworkInterface",
  "description": "<p>Represents a node and its specifications in an in-vehicle communication network. All signal decoders must be associated with a network node. </p> <p> To return this information about all the network interfaces specified in a decoder manifest, use the API operation.</p>",
  "type": "object",
  "properties": {
    "interfaceId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InterfaceId"
        },
        {
          "description": "The ID of the network interface."
        }
      ]
    },
    "type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NetworkInterfaceType"
        },
        {
          "description": "The network protocol for the vehicle. For example, <code>CAN_SIGNAL</code> specifies a protocol that defines how data is communicated between electronic control units (ECUs). <code>OBD_SIGNAL</code> specifies a protocol that defines how self-diagnostic data is communicated between ECUs."
        }
      ]
    },
    "canInterface": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CanInterface"
        },
        {
          "description": "Information about a network interface specified by the Controller Area Network (CAN) protocol."
        }
      ]
    },
    "obdInterface": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ObdInterface"
        },
        {
          "description": "Information about a network interface specified by the On-board diagnostic (OBD) II protocol."
        }
      ]
    }
  },
  "required": [
    "interfaceId",
    "type"
  ]
}