NetworkInterfaces

NetworkInterfaces schema

AutomotiveConnected VehiclesIoTTelematicsVehicle Data
View JSON Schema on GitHub

JSON Schema

iot-fleetwise-network-interfaces-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-fleetwise/refs/heads/main/json-schema/iot-fleetwise-network-interfaces-schema.json",
  "title": "NetworkInterfaces",
  "description": "NetworkInterfaces schema",
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "interfaceId",
      "type"
    ],
    "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."
          }
        ]
      }
    },
    "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>"
  }
}