aws_iotfleetwise_campaign

account_id

Type: STRING

arn

Type: STRING
Provider name: arn
Description: The Amazon Resource Name (ARN) of the campaign.

collection_scheme

Type: STRUCT
Provider name: collectionScheme
Description: Information about the data collection scheme associated with the campaign.

• condition_based_collection_scheme
  Type: STRUCT
  Provider name: conditionBasedCollectionScheme
  Description: Information about a collection scheme that uses a simple logical expression to recognize what data to collect.
  
  • condition_language_version
    Type: INT32
    Provider name: conditionLanguageVersion
    Description: Specifies the version of the conditional expression language.
    
  • expression
    Type: STRING
    Provider name: expression
    Description: The logical expression used to recognize what data to collect. For example, $variable.Vehicle.OutsideAirTemperature >= 105.0.
    
  • minimum_trigger_interval_ms
    Type: INT64
    Provider name: minimumTriggerIntervalMs
    Description: The minimum duration of time between two triggering events to collect data, in milliseconds. If a signal changes often, you might want to collect data at a slower rate.
    
  • trigger_mode
    Type: STRING
    Provider name: triggerMode
    Description: Whether to collect data for all triggering events (ALWAYS). Specify (RISING_EDGE), or specify only when the condition first evaluates to false. For example, triggering on “AirbagDeployed”; Users aren’t interested on triggering when the airbag is already exploded; they only care about the change from not deployed => deployed.
    
• time_based_collection_scheme
  Type: STRUCT
  Provider name: timeBasedCollectionScheme
  Description: Information about a collection scheme that uses a time period to decide how often to collect data.
  
  • period_ms
    Type: INT64
    Provider name: periodMs
    Description: 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.
    

compression

Type: STRING
Provider name: compression
Description: 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

Type: TIMESTAMP
Provider name: creationTime
Description: The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).

data_destination_configs

Type: UNORDERED_LIST_STRUCT
Provider name: dataDestinationConfigs
Description: 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.

• mqtt_topic_config
  Type: STRUCT
  Provider name: mqttTopicConfig
  Description: The MQTT topic to which the Amazon Web Services IoT FleetWise campaign routes data. 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.
  
  • execution_role_arn
    Type: STRING
    Provider name: executionRoleArn
    Description: The ARN of the role that grants Amazon Web Services IoT FleetWise permission to access and act on messages sent to the MQTT topic.
    
  • mqtt_topic_arn
    Type: STRING
    Provider name: mqttTopicArn
    Description: The ARN of the MQTT topic.
    
• s3_config
  Type: STRUCT
  Provider name: s3Config
  Description: The Amazon S3 bucket where the Amazon Web Services IoT FleetWise campaign sends data.
  
  • bucket_arn
    Type: STRING
    Provider name: bucketArn
    Description: The Amazon Resource Name (ARN) of the Amazon S3 bucket.
    
  • data_format
    Type: STRING
    Provider name: dataFormat
    Description: Specify the format that files are saved in the Amazon S3 bucket. You can save files in an Apache Parquet or JSON format.
    • Parquet - Store data in a columnar storage file format. Parquet is optimal for fast data retrieval and can reduce costs. This option is selected by default.
    • JSON - Store data in a standard text-based JSON file format.
  • prefix
    Type: STRING
    Provider name: prefix
    Description: Enter an S3 bucket prefix. The prefix is the string of characters after the bucket name and before the object name. You can use the prefix to organize data stored in Amazon S3 buckets. For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide. By default, Amazon Web Services IoT FleetWise sets the prefix processed-data/year=YY/month=MM/date=DD/hour=HH/ (in UTC) to data it delivers to Amazon S3. You can enter a prefix to append it to this default prefix. For example, if you enter the prefix vehicles, the prefix will be vehicles/processed-data/year=YY/month=MM/date=DD/hour=HH/.
    
  • storage_compression_format
    Type: STRING
    Provider name: storageCompressionFormat
    Description: By default, stored data is compressed as a .gzip file. Compressed files have a reduced file size, which can optimize the cost of data storage.
    
• timestream_config
  Type: STRUCT
  Provider name: timestreamConfig
  Description: The Amazon Timestream table where the campaign sends data.
  
  • execution_role_arn
    Type: STRING
    Provider name: executionRoleArn
    Description: The Amazon Resource Name (ARN) of the task execution role that grants Amazon Web Services IoT FleetWise permission to deliver data to the Amazon Timestream table.
    
  • timestream_table_arn
    Type: STRING
    Provider name: timestreamTableArn
    Description: The Amazon Resource Name (ARN) of the Amazon Timestream table.
    

data_extra_dimensions

Type: UNORDERED_LIST_STRING
Provider name: dataExtraDimensions
Description: A list of vehicle attributes associated with the campaign.

data_partitions

Type: UNORDERED_LIST_STRUCT
Provider name: dataPartitions
Description: The data partitions associated with the signals collected from the vehicle.

• id
  Type: STRING
  Provider name: id
  Description: The ID of the data partition. The data partition ID must be unique within a campaign. You can establish a data partition as the default partition for a campaign by using default as the ID.
  
• storage_options
  Type: STRUCT
  Provider name: storageOptions
  Description: The storage options for a data partition.
  
  • maximum_size
    Type: STRUCT
    Provider name: maximumSize
    Description: The maximum storage size of the data stored in the data partition. Newer data overwrites older data when the partition reaches the maximum size.
    
    • unit
      Type: STRING
      Provider name: unit
      Description: The data type of the data to store.
      
    • value
      Type: INT32
      Provider name: value
      Description: The maximum amount of time to store data.
      
  • minimum_time_to_live
    Type: STRUCT
    Provider name: minimumTimeToLive
    Description: The amount of time that data in this partition will be kept on disk.
    • After the designated amount of time passes, the data can be removed, but it’s not guaranteed to be removed.
    • Before the time expires, data in this partition can still be deleted if the partition reaches its configured maximum size.
    • Newer data will overwrite older data when the partition reaches the maximum size.
    • unit
      Type: STRING
      Provider name: unit
      Description: The time increment type.
      
    • value
      Type: INT32
      Provider name: value
      Description: The minimum amount of time to store the data.
      
  • storage_location
    Type: STRING
    Provider name: storageLocation
    Description: The folder name for the data partition under the campaign storage folder.
    
• upload_options
  Type: STRUCT
  Provider name: uploadOptions
  Description: The upload options for the data partition.
  
  • condition_language_version
    Type: INT32
    Provider name: conditionLanguageVersion
    Description: The version of the condition language. Defaults to the most recent condition language version.
    
  • expression
    Type: STRING
    Provider name: expression
    Description: The logical expression used to recognize what data to collect. For example, $variable.Vehicle.OutsideAirTemperature >= 105.0.
    

description

Type: STRING
Provider name: description
Description: The description of the campaign.

diagnostics_mode

Type: STRING
Provider name: diagnosticsMode
Description: Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.

expiry_time

Type: TIMESTAMP
Provider name: expiryTime
Description: 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

Type: TIMESTAMP
Provider name: lastModificationTime
Description: The last time the campaign was modified.

name

Type: STRING
Provider name: name
Description: The name of the campaign.

post_trigger_collection_duration

Type: INT64
Provider name: postTriggerCollectionDuration
Description: How long (in seconds) to collect raw data after a triggering event initiates the collection.

priority

Type: INT32
Provider name: priority
Description: 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

Type: STRING
Provider name: signalCatalogArn
Description: The ARN of a signal catalog.

signals_to_collect

Type: UNORDERED_LIST_STRUCT
Provider name: signalsToCollect
Description: Information about a list of signals to collect data on.

• data_partition_id
  Type: STRING
  Provider name: dataPartitionId
  Description: The ID of the data partition this signal is associated with. The ID must match one of the IDs provided in dataPartitions. This is accomplished either by specifying a particular data partition ID or by using default for an established default partition. You can establish a default partition in the DataPartition data type. If you upload a signal as a condition for a campaign’s data partition, the same signal must be included in signalsToCollect. 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.
  
• max_sample_count
  Type: INT64
  Provider name: maxSampleCount
  Description: The maximum number of samples to collect.
  
• minimum_sampling_interval_ms
  Type: INT64
  Provider name: minimumSamplingIntervalMs
  Description: The minimum duration of time (in milliseconds) between two triggering events to collect data. If a signal changes often, you might want to collect data at a slower rate.
  
• name
  Type: STRING
  Provider name: name
  Description: The name of the signal.
  

signals_to_fetch

Type: UNORDERED_LIST_STRUCT
Provider name: signalsToFetch
Description: Information about a list of signals to fetch data from.

• actions
  Type: UNORDERED_LIST_STRING
  Provider name: actions
  Description: The actions to be performed by the signal fetch.
  
• condition_language_version
  Type: INT32
  Provider name: conditionLanguageVersion
  Description: The version of the condition language used.
  
• fully_qualified_name
  Type: STRING
  Provider name: fullyQualifiedName
  Description: The fully qualified name of the signal to be fetched.
  
• signal_fetch_config
  Type: STRUCT
  Provider name: signalFetchConfig
  Description: The configuration of the signal fetch operation.
  
  • condition_based
    Type: STRUCT
    Provider name: conditionBased
    Description: The configuration of a condition-based signal fetch operation.
    
    • condition_expression
      Type: STRING
      Provider name: conditionExpression
      Description: The condition that must be satisfied to trigger a signal fetch.
      
    • trigger_mode
      Type: STRING
      Provider name: triggerMode
      Description: Indicates the mode in which the signal fetch is triggered.
      
  • time_based
    Type: STRUCT
    Provider name: timeBased
    Description: The configuration of a time-based signal fetch operation.
    
    • execution_frequency_ms
      Type: INT64
      Provider name: executionFrequencyMs
      Description: The frequency with which the signal fetch will be executed.
      

spooling_mode

Type: STRING
Provider name: spoolingMode
Description: 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

Type: TIMESTAMP
Provider name: startTime
Description: The time, in milliseconds, to deliver a campaign after it was approved.

status

Type: STRING
Provider name: status
Description: The state of the campaign. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, and SUSPENDED.

tags

Type: UNORDERED_LIST_STRING

target_arn

Type: STRING
Provider name: targetArn
Description: The ARN of the vehicle or the fleet targeted by the campaign.