The AWS IoT FleetWise API contains several data types that various actions use. This section describes each data type in detail.
NoteThe order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.
The following data types are supported:
• Actuator (p. 141)
• Attribute (p. 143)
• Branch (p. 145)
• CampaignSummary (p. 146)
• CanDbcDefinition (p. 148)
• CanInterface (p. 149)
• CanSignal (p. 150)
• CollectionScheme (p. 152)
• ConditionBasedCollectionScheme (p. 153)
• CreateVehicleError (p. 155)
• CreateVehicleRequestItem (p. 156)
• CreateVehicleResponseItem (p. 158)
• DecoderManifestSummary (p. 159)
• FleetSummary (p. 161)
• IamRegistrationResponse (p. 163)
• IamResources (p. 164)
• InvalidNetworkInterface (p. 165)
• InvalidSignal (p. 166)
• InvalidSignalDecoder (p. 167)
• ModelManifestSummary (p. 168)
• NetworkFileDefinition (p. 170)
• NetworkInterface (p. 171)
• Node (p. 172)
• NodeCounts (p. 174)
• ObdInterface (p. 175)
• ObdSignal (p. 177)
• Sensor (p. 179)
• SignalCatalogSummary (p. 181)
• SignalDecoder (p. 182)
• SignalInformation (p. 184)
• TimeBasedCollectionScheme (p. 185)
• TimestreamRegistrationResponse (p. 186)
• TimestreamResources (p. 188)
• UpdateVehicleError (p. 189)
• UpdateVehicleRequestItem (p. 190)
AWS IoT FleetWise Welcome
• UpdateVehicleResponseItem (p. 192)
• ValidationExceptionField (p. 193)
• VehicleStatus (p. 194)
• VehicleSummary (p. 195)
• VssFormats (p. 197)
API Version 2021-06-17 140
Actuator
Actuator
A signal that represents a vehicle device such as the engine, heater, and door locks. Data from an actuator reports the state of a certain vehicle device.
NoteUpdating actuator data can change the state of a device. For example, you can turn on or off the heater by updating its actuator data.
Contents
allowedValues
A list of possible values an actuator can take.
Type: Array of strings Required: No
assignedValue
A specified value for the actuator.
Type: String Required: No dataType
The specified data type of the actuator.
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 the actuator.
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 actuator. For example, the fully qualified name of an actuator might be Vehicle.Front.Left.Door.Lock.
Type: String Required: Yes
AWS IoT FleetWise Welcome See Also
max
The specified possible maximum value of an actuator.
Type: Double Required: No min
The specified possible minimum value of an actuator.
Type: Double Required: No name
The unique name of the actuator.
Type: String Required: Yes unit
The scientific unit for the actuator.
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 142
Attribute
Attribute
A signal that represents static information about the vehicle, such as engine type or manufacturing date.
Contents
allowedValues
A list of possible values an attribute can be assigned.
Type: Array of strings Required: No
assignedValue
A specified value for the attribute.
Type: String Required: No dataType
The specified data type of the attribute.
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 defaultValue
The default value of the attribute.
Type: String Required: No description
A brief description of the attribute.
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 attribute. For example, the fully qualified name of an attribute might be Vehicle.Body.Engine.Type.
Type: String
AWS IoT FleetWise Welcome See Also
Required: Yes max
The specified possible maximum value of the attribute.
Type: Double Required: No min
The specified possible minimum value of the attribute.
Type: Double Required: No name
The name of the attribute.
Type: String Required: Yes unit
The scientific unit for the attribute.
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 144
Branch
Branch
A group of signals that are defined in a hierarchical structure.
Contents
description
A brief description of the branch.
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 branch. For example, the fully qualified name of a branch might be Vehicle.Body.Engine.
Type: String Required: Yes name
The name of the branch.
Type: String 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 CampaignSummary
CampaignSummary
Information about a campaign.
You can use the ListCampaigns (p. 78) API operation to return this information about multiple created campaigns.
Contents
arn
The Amazon Resource Name (ARN) of a campaign.
Type: String Required: No campaignName
The name of a campaign.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[a-zA-Z\d\-_:]+$
Required: No signalCatalogArn
The ARN of the signal catalog associated with the campaign.
Type: String Required: No status
The state of a campaign. The status can be one of:
• CREATING - AWS IoT FleetWise is processing your request to create the campaign.
• WAITING_FOR_APPROVAL - After a campaign is created, it enters the WAITING_FOR_APPROVAL state. To allow AWS IoT FleetWise to deploy the campaign to the target vehicle or fleet, use the UpdateCampaign (p. 119) API operation to approve the campaign.
• RUNNING - The campaign is active.
• SUSPENDED - The campaign is suspended. To resume the campaign, use the UpdateCampaign (p. 119) API operation.
Type: String
Valid Values: CREATING | WAITING_FOR_APPROVAL | RUNNING | SUSPENDED Required: No
targetArn
The ARN of a vehicle or fleet to which the campaign is deployed.
Type: String Required: No
API Version 2021-06-17 146
See Also
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