Module types

Data structures used by operation inputs/outputs.

Modules

builders

Builders

error

Error types that AWS IoT FleetWise can respond with.

Structs

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.

Updating actuator data can change the state of a device. For example, you can turn on or off the heater by updating its actuator data.

Attribute

A signal that represents static information about the vehicle, such as engine type or manufacturing date.

Branch

A group of signals that are defined in a hierarchical structure.

CampaignSummary

Information about a campaign.

You can use the API operation to return this information about multiple created campaigns.

CanDbcDefinition

Configurations used to create a decoder manifest.

CanInterface

A single controller area network (CAN) device interface.

CanSignal

Information about a single controller area network (CAN) signal and the messages it receives and transmits.

CloudWatchLogDeliveryOptions

The log delivery option to send data to Amazon CloudWatch Logs.

ConditionBasedCollectionScheme

Information about a collection scheme that uses a simple logical expression to recognize what data to collect.

ConditionBasedSignalFetchConfig

Specifies the condition under which a signal fetch occurs.

CreateVehicleError

An HTTP error resulting from creating a vehicle.

CreateVehicleRequestItem

Information about the vehicle to create.

CreateVehicleResponseItem

Information about a created vehicle.

CustomDecodingInterface

Represents a custom network interface as defined by the customer.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

CustomDecodingSignal

Information about signals using a custom decoding protocol as defined by the customer.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

CustomProperty

Represents a member of the complex data structure. The data type of the property can be either primitive or another struct.

CustomStruct

The custom structure represents a complex or higher-order data structure.

DataPartition

The configuration for signal data storage and upload options. You can only specify these options when the campaign's spooling mode is TO_DISK.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

DataPartitionStorageOptions

Size, time, and location options for the data partition.

DataPartitionUploadOptions

The upload options for the data partition. If upload options are specified, you must also specify storage options. See DataPartitionStorageOptions.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

DecoderManifestSummary

Information about a created decoder manifest. You can use the API operation to return this information about multiple decoder manifests.

FleetSummary

Information about a fleet.

You can use the API operation to return this information about multiple fleets.

IamRegistrationResponse

Information about registering an Identity and Access Management (IAM) resource so Amazon Web Services IoT FleetWise edge agent software can transfer your vehicle data to Amazon Timestream.

IamResources

The IAM resource that enables Amazon Web Services IoT FleetWise edge agent software to send data to Amazon Timestream.

For more information, see IAM roles in the Identity and Access Management User Guide.

InvalidNetworkInterface

A reason a vehicle network interface isn't valid.

InvalidSignal

A reason that a signal isn't valid.

InvalidSignalDecoder

A reason that a signal decoder isn't valid.

MessageSignal

The decoding information for a specific message which support higher order data types.

ModelManifestSummary

Information about a vehicle model (model manifest). You can use the API operation to return this information about multiple vehicle models.

MqttTopicConfig

The MQTT topic to which the Amazon Web Services IoT FleetWise campaign routes data. For more information, see Device communication protocols in the Amazon Web Services IoT Core Developer Guide.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

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

NodeCounts

Information about the number of nodes and node types in a vehicle network.

ObdInterface

A network interface that specifies the on-board diagnostic (OBD) II network protocol.

ObdSignal

Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle.

OnChangeStateTemplateUpdateStrategy

Vehicles associated with the state template will stream telemetry data when there is a change.

PeriodicStateTemplateUpdateStrategy

Vehicles associated with the state template will stream telemetry data during a specified time period.

Ros2PrimitiveMessageDefinition

Represents a ROS 2 compliant primitive type message of the complex data structure.

S3Config

The Amazon S3 bucket where the Amazon Web Services IoT FleetWise campaign sends data. Amazon S3 is an object storage service that stores data as objects within buckets. For more information, see Creating, configuring, and working with Amazon S3 buckets in the Amazon Simple Storage Service User Guide.

Sensor

An input component that reports the environmental condition of a vehicle.

You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.

SignalCatalogSummary

Information about a collection of standardized signals, which can be attributes, branches, sensors, or actuators.

SignalDecoder

Information about a signal decoder.

SignalFetchInformation

Information about the signal to be fetched.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

SignalInformation

Information about a signal.

StateTemplateAssociation

The state template associated with a vehicle. State templates contain state properties, which are signals that belong to a signal catalog that is synchronized between the Amazon Web Services IoT FleetWise Edge and the Amazon Web Services Cloud.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

StateTemplateSummary

Information about a state template.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

StorageMaximumSize

The maximum storage size for the data partition.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

StorageMinimumTimeToLive

Information about the minimum amount of time that data will be kept.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

StructuredMessageFieldNameAndDataTypePair

Represents a StructureMessageName to DataType map element.

StructuredMessageListDefinition

Represents a list type node of the complex data structure.

Tag

A set of key/value pairs that are used to manage the resource.

TimeBasedCollectionScheme

Information about a collection scheme that uses a time period to decide how often to collect data.

TimeBasedSignalFetchConfig

Used to configure a frequency-based vehicle signal fetch.

TimePeriod

The length of time between state template updates.

TimestreamConfig

The Amazon Timestream table where the Amazon Web Services IoT FleetWise campaign sends data. Timestream stores and organizes data to optimize query processing time and to reduce storage costs. For more information, see Data modeling in the Amazon Timestream Developer Guide.

TimestreamRegistrationResponse

Information about the registered Amazon Timestream resources or errors, if any.

TimestreamResources

The registered Amazon Timestream resources that Amazon Web Services IoT FleetWise edge agent software can transfer your vehicle data to.

UpdateVehicleError

An HTTP error resulting from updating the description for a vehicle.

UpdateVehicleRequestItem

Information about the vehicle to update.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

UpdateVehicleResponseItem

Information about the updated vehicle.

ValidationExceptionField

A validation error due to mismatch between the expected data type, length, or pattern of the parameter and the input.

VehicleMiddleware

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

VehicleStatus

Information about a campaign associated with a vehicle.

VehicleSummary

Information about a vehicle.

To return this information about vehicles in your account, you can use the API operation.

Enums

CampaignStatus

When writing a match expression against CampaignStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

CollectionScheme

Specifies what data to collect and how often or when to collect it.

Compression

When writing a match expression against Compression, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DataDestinationConfig

The destination where the campaign sends data. You can send data to an MQTT topic, or store it in Amazon S3 or Amazon Timestream.

DataFormat

When writing a match expression against DataFormat, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DefaultForUnmappedSignalsType

When writing a match expression against DefaultForUnmappedSignalsType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DiagnosticsMode

When writing a match expression against DiagnosticsMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EncryptionStatus

When writing a match expression against EncryptionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EncryptionType

When writing a match expression against EncryptionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FormattedVss

Vehicle Signal Specification (VSS) is a precise language used to describe and model signals in vehicle networks. The JSON file collects signal specificiations in a VSS format.

ListResponseScope

When writing a match expression against ListResponseScope, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

LogType

When writing a match expression against LogType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ManifestStatus

When writing a match expression against ManifestStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

NetworkFileDefinition

Specifications for defining a vehicle network.

NetworkInterfaceFailureReason

When writing a match expression against NetworkInterfaceFailureReason, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

NetworkInterfaceType

When writing a match expression against NetworkInterfaceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Node

A general abstraction of a signal. A node can be specified as an actuator, attribute, branch, or sensor.

NodeDataEncoding

When writing a match expression against NodeDataEncoding, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

NodeDataType

When writing a match expression against NodeDataType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PrimitiveMessageDefinition

Represents a primitive type node of the complex data structure.

RegistrationStatus

When writing a match expression against RegistrationStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Ros2PrimitiveType

When writing a match expression against Ros2PrimitiveType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SignalDecoderFailureReason

When writing a match expression against SignalDecoderFailureReason, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SignalDecoderType

When writing a match expression against SignalDecoderType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SignalFetchConfig

The configuration of the signal fetch operation.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

SignalNodeType

When writing a match expression against SignalNodeType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SignalValueType

When writing a match expression against SignalValueType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SpoolingMode

When writing a match expression against SpoolingMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

StateTemplateUpdateStrategy

The update strategy for the state template. Vehicles associated with the state template can stream telemetry data with either an onChange or periodic update strategy.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

StorageCompressionFormat

When writing a match expression against StorageCompressionFormat, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

StorageMaximumSizeUnit

When writing a match expression against StorageMaximumSizeUnit, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

StorageMinimumTimeToLiveUnit

When writing a match expression against StorageMinimumTimeToLiveUnit, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

StructuredMessage

The structured message for the message signal. It can be defined with either a primitiveMessageDefinition, structuredMessageListDefinition, or structuredMessageDefinition recursively.

StructuredMessageListType

When writing a match expression against StructuredMessageListType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

TimeUnit

When writing a match expression against TimeUnit, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

TriggerMode

When writing a match expression against TriggerMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

UpdateCampaignAction

When writing a match expression against UpdateCampaignAction, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

UpdateMode

When writing a match expression against UpdateMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ValidationExceptionReason

When writing a match expression against ValidationExceptionReason, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

VehicleAssociationBehavior

When writing a match expression against VehicleAssociationBehavior, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

VehicleMiddlewareProtocol

When writing a match expression against VehicleMiddlewareProtocol, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

VehicleState

When writing a match expression against VehicleState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.