CreateCampaignRequest
Types
Properties
The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.
(Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If you don't want to compress the signals, use OFF
. If it's not specified, SNAPPY
is used.
The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.
(Optional) A list of vehicle attributes to associate with a campaign.
An optional description of the campaign to help identify its purpose.
(Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. If you want to send diagnostic trouble codes, use SEND_ACTIVE_DTCS
. If it's not specified, OFF
is used.
(Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data isn't collected after the campaign expires.
(Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection. If it's not specified, 0
is used.
(Optional) The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.
(Optional) A list of information about signals to collect.
(Optional) 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. If you want to store collected data when a vehicle loses connection with the cloud, use TO_DISK
. If it's not specified, OFF
is used.