NetworkFileDefinition
Specifications for defining a vehicle network.
Contents
canDbc
Information, including CAN DBC files, about the configurations used to create a decoder manifest.
Type: CanDbcDefinition (p. 148) object Required: No
networkFileType The type of file.
Type: String
Valid Values: CAN_DBC Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2021-06-17 170
NetworkInterface
NetworkInterface
Represents a node and its specifications in an in-vehicle communication network. All signal decoders must be associated with a network node.
You can use the ListDecoderManifestNetworkInterfaces (p. 81) API operation to return this information about all the network interfaces specified in a decoder manifest.
Contents
canInterface
Information about a network interface specified by the Controller Area Network (CAN) protocol.
Type: CanInterface (p. 149) object Required: No
interfaceId
The ID of the network interface.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Required: Yes obdInterface
Information about a network interface specified by the On-board diagnostic (OBD) II protocol.
Type: ObdInterface (p. 175) object Required: No
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 Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
AWS IoT FleetWise Welcome Node
Node
A general abstraction of a signal. A node can be specified as an actuator, attribute, branch, or sensor.
Contents
actuator
Information about a node specified as an actuator.
NoteAn actuator is a digital representation of a vehicle device.
Type: Actuator (p. 141) object Required: No
attribute
Information about a node specified as an attribute.
NoteAn attribute represents static information about a vehicle.
Type: Attribute (p. 143) object Required: No
branch
Information about a node specified as a branch.
NoteA group of signals that are defined in a hierarchical structure.
Type: Branch (p. 145) object Required: No
sensor
An input component that reports the environmental condition of a vehicle.
NoteYou can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.
Type: Sensor (p. 179) object Required: No
type
The type of the node. Possible values are: Actuator, Attribute, Branch, and Sensor.
Type: String
Valid Values: Sensor | Actuator | Attribute | Branch Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
API Version 2021-06-17 172
See Also
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
AWS IoT FleetWise Welcome NodeCounts
NodeCounts
Information about the number of nodes and node types in a vehicle network.
Contents
totalActuators
The total number of nodes in a vehicle network that represent actuators.
Type: Integer Required: No totalAttributes
The total number of nodes in a vehicle network that represent attributes.
Type: Integer Required: No totalBranches
The total number of nodes in a vehicle network that represent branches.
Type: Integer Required: No totalNodes
The total number of nodes in a vehicle network.
Type: Integer Required: No totalSensors
The total number of nodes in a vehicle network that represent sensors.
Type: Integer Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2021-06-17 174
ObdInterface
ObdInterface
A network interface that specifies the On-board diagnostic (OBD) II network protocol.
Contents
dtcRequestIntervalSeconds
The maximum number message requests per diagnostic trouble code per second.
Type: Integer
Valid Range: Minimum value of 0.
Required: No hasTransmissionEcu
Whether the vehicle has a transmission control module (TCM).
Type: Boolean Required: No obdInterfaceName
The name of the interface.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes obdStandard
The standard OBD II PID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Required: No
pidRequestIntervalSeconds
The maximum number message requests per second.
Type: Integer
Valid Range: Minimum value of 0.
Required: No requestMessageId
The ID of the message requesting vehicle data.
Type: Integer
Valid Range: Minimum value of 0.
Required: Yes
AWS IoT FleetWise Welcome See Also
useExtendedIds
Whether to use extended IDs in the message.
Type: Boolean Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2021-06-17 176
ObdSignal
ObdSignal
Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle.
Contents
bitMaskLength
The number of bits to mask in a message.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 8.
Required: No bitRightShift
The number of positions to shift bits in the message.
Type: Integer
Valid Range: Minimum value of 0.
Required: No byteLength
The length of a message.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 8.
Required: Yes offset
Indicates where data appears in the message.
Type: Double Required: Yes pid
The diagnostic code used to request data from a vehicle for this signal.
Type: Integer
Valid Range: Minimum value of 0.
Required: Yes pidResponseLength
The length of the requested data.
Type: Integer
Valid Range: Minimum value of 1.
Required: Yes
AWS IoT FleetWise Welcome See Also
scaling
A multiplier used to decode the message.
Type: Double Required: Yes serviceMode
The mode of operation (diagnostic service) in a message.
Type: Integer
Valid Range: Minimum value of 0.
Required: Yes startByte
Indicates the beginning of the message.
Type: Integer
Valid Range: Minimum value of 0.
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2021-06-17 178
Sensor
Sensor
An input component that reports the environmental condition of a vehicle.
NoteYou can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.
Contents
allowedValues
A list of possible values a sensor can take.
Type: Array of strings Required: No
dataType
The specified data type of the sensor.
Type: String
Valid Values: INT8 | UINT8 | INT16 | UINT16 | INT32 | UINT32 | INT64 | UINT64
| BOOLEAN | FLOAT | DOUBLE | STRING | UNIX_TIMESTAMP | INT8_ARRAY | UINT8_ARRAY | INT16_ARRAY | UINT16_ARRAY | INT32_ARRAY | UINT32_ARRAY | INT64_ARRAY | UINT64_ARRAY | BOOLEAN_ARRAY | FLOAT_ARRAY | DOUBLE_ARRAY | STRING_ARRAY | UNIX_TIMESTAMP_ARRAY | UNKNOWN
Required: Yes description
A brief description of a sensor.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: ^[^\u0000-\u001F\u007F]+$
Required: No fullyQualifiedName
The fully qualified name of the sensor. For example, the fully qualified name of a sensor might be Vehicle.Body.Engine.Battery.
Type: String Required: Yes max
The specified possible maximum value of the sensor.
Type: Double Required: No min
The specified possible minimum value of the sensor.
AWS IoT FleetWise Welcome See Also
Type: Double Required: No name
The name of the sensor.
Type: String Required: Yes unit
The scientific unit of measurement for data collected by the sensor.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2021-06-17 180
SignalCatalogSummary
SignalCatalogSummary
Information about a collection of standardized signals, which can be attributes, branches, sensors, or actuators.
Contents
creationDate
The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time).
Type: Long Required: No lastModificationDate
The time the signal catalog was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
Type: Long Required: No signalCatalogArn
The Amazon Resource Name (ARN) of the signal catalog.
Type: String Required: No signalCatalogName
The name of the signal catalog.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
AWS IoT FleetWise Welcome SignalDecoder
SignalDecoder
Information about a signal decoder.
Contents
canSignal
Information about signal decoder using the Controller Area Network (CAN) protocol.
Type: CanSignal (p. 150) object Required: No
fullyQualifiedName
The fully qualified name of a signal decoder as defined in a vehicle model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 150.
Required: Yes interfaceId
The ID of a network interface that specifies what network protocol a vehicle follows.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Required: Yes obdSignal
Information about signal decoder using the On-board diagnostic (OBD) II protocol.
Type: ObdSignal (p. 177) object Required: No
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_SIGNAL | OBD_SIGNAL Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
API Version 2021-06-17 182
See Also
• AWS SDK for Java V2
• AWS SDK for Ruby V3
AWS IoT FleetWise Welcome SignalInformation
SignalInformation
Information about a signal.
Contents
maxSampleCount
The maximum number of samples to collect.
Type: Long
Valid Range: Minimum value of 1. Maximum value of 4294967295.
Required: No
minimumSamplingIntervalMs
The minimum duration of time (in milliseconds) between two triggering events to collect data.
NoteIf a signal changes often, you might want to collect data at a slower rate.
Type: Long
Valid Range: Minimum value of 0. Maximum value of 4294967295.
Required: No signalName
The name of the signal.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 150.
Pattern: ^[\w|*|-]+(\.[\w|*|-]+)*$
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2021-06-17 184
TimeBasedCollectionScheme
TimeBasedCollectionScheme
Information about a collection scheme that uses a time period to decide how often to collect data.
Contents
periodMs
The time period (in milliseconds) to decide how often to collect data. For example, if the time period is 60000 the Edge Agent software collects data once every minute.
Type: Long
Valid Range: Minimum value of 10000. Maximum value of 60000.
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
AWS IoT FleetWise Welcome TimestreamRegistrationResponse
TimestreamRegistrationResponse
Information about the registered Amazon Timestream resources or errors, if any.
Contents
errorMessage
A message associated with a registration error.
Type: String Required: No registrationStatus
The status of registering your Amazon Timestream resources. The status can be one of REGISTRATION_SUCCESS, REGISTRATION_PENDING, REGISTRATION_FAILURE.
Type: String
Valid Values: REGISTRATION_PENDING | REGISTRATION_SUCCESS | REGISTRATION_FAILURE
Required: Yes timestreamDatabaseArn
The Amazon Resource Name (ARN) of the Timestream database.
Type: String Required: No
timestreamDatabaseName
The name of the Timestream database.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: ^[a-zA-Z0-9_.-]+$
Required: Yes timestreamTableArn
The ARN of the Timestream database table.
Type: String Required: No timestreamTableName
The name of the Timestream database table.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: ^[a-zA-Z0-9_.-]+$
API Version 2021-06-17 186
See Also
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
AWS IoT FleetWise Welcome TimestreamResources
TimestreamResources
The registered Amazon Timestream resources that AWS IoT FleetWise edge agent software can transfer your vehicle data to.
Contents
timestreamDatabaseName
The name of the registered Amazon Timestream database.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: ^[a-zA-Z0-9_.-]+$
Required: Yes timestreamTableName
The name of the registered Amazon Timestream database table.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: ^[a-zA-Z0-9_.-]+$
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2021-06-17 188
UpdateVehicleError
UpdateVehicleError
An HTTP error resulting from updating the description for a vehicle.
Contents
code
The relevant HTTP error code (400+).
Type: Integer Required: No message
A message associated with the error.
Type: String Required: No vehicleId
The ID of the vehicle with the error.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[a-zA-Z\d\-_:]+$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
AWS IoT FleetWise Welcome UpdateVehicleRequestItem
UpdateVehicleRequestItem
Information about the vehicle to update.
Contents
attributes
Static information about a vehicle in a key-value pair. For example:
"engineType" : "1.3 L R2"
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 150.
Key Pattern: ^[a-zA-Z0-9_.-]+$
Required: No decoderManifestArn
The ARN of the signal decoder manifest associated with the vehicle to update.
Type: String Required: No mergeAttributes
Specifies whether a list of vehicle attributes is merged with existing vehicle attributes instead of overwriting them.
Type: Boolean Required: No modelManifestArn
The ARN of the vehicle model (model manifest) associated with the vehicle to update.
Type: String Required: No vehicleId
The unique ID of the vehicle to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[a-zA-Z\d\-_:]+$
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
API Version 2021-06-17 190