IoT FleetWise Campaign

Docs > DDSQL Reference > Data Directory > IoT FleetWise Campaign

An AWS IoT FleetWise Campaign is a resource that defines how vehicle data is collected, processed, and transferred to the cloud. It specifies which signals to gather from vehicles, the conditions for data collection, and the destination for the data. Campaigns help optimize data usage by controlling frequency, filtering, and event-based triggers, enabling efficient analysis and insights from connected vehicle fleets.

aws.iotfleetwise_campaign

Fields

ID	Type	Data Type	Description
_key	core	string
account_id	core	string
arn	core	string	The Amazon Resource Name (ARN) of the campaign.
collection_scheme	core	json	Information about the data collection scheme associated with the campaign.
compression	core	string	Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If OFF is specified, the signals aren't compressed. If it's not specified, SNAPPY is used.
creation_time	core	timestamp	The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).
data_destination_configs	core	json	The destination where the campaign sends data. You can send data to an MQTT topic, or store it in Amazon S3 or Amazon Timestream. MQTT is the publish/subscribe messaging protocol used by Amazon Web Services IoT to communicate with your devices. Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.
data_extra_dimensions	core	array<string>	A list of vehicle attributes associated with the campaign.
data_partitions	core	json	The data partitions associated with the signals collected from the vehicle.
description	core	string	The description of the campaign.
diagnostics_mode	core	string	Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.
expiry_time	core	timestamp	The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data won't be collected after the campaign expires.
last_modification_time	core	timestamp	The last time the campaign was modified.
name	core	string	The name of the campaign.
post_trigger_collection_duration	core	int64	How long (in seconds) to collect raw data after a triggering event initiates the collection.
priority	core	int64	A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns.
signal_catalog_arn	core	string	The ARN of a signal catalog.
signals_to_collect	core	json	Information about a list of signals to collect data on.
signals_to_fetch	core	json	Information about a list of signals to fetch data from.
spooling_mode	core	string	Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise.
start_time	core	timestamp	The time, in milliseconds, to deliver a campaign after it was approved.
status	core	string	The state of the campaign. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, and SUSPENDED.
tags	core	hstore
target_arn	core	string	The ARN of the vehicle or the fleet targeted by the campaign.