Struct aws_sdk_iotfleetwise::operation::create_campaign::CreateCampaignInput

#[non_exhaustive]
pub struct CreateCampaignInput {

    pub name: Option<String>,
    pub description: Option<String>,
    pub signal_catalog_arn: Option<String>,
    pub target_arn: Option<String>,
    pub start_time: Option<DateTime>,
    pub expiry_time: Option<DateTime>,
    pub post_trigger_collection_duration: Option<i64>,
    pub diagnostics_mode: Option<DiagnosticsMode>,
    pub spooling_mode: Option<SpoolingMode>,
    pub compression: Option<Compression>,
    pub priority: Option<i32>,
    pub signals_to_collect: Option<Vec<SignalInformation>>,
    pub collection_scheme: Option<CollectionScheme>,
    pub data_extra_dimensions: Option<Vec<String>>,
    pub tags: Option<Vec<Tag>>,
    pub data_destination_configs: Option<Vec<DataDestinationConfig>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The name of the campaign to create.

description: Option<String>

An optional description of the campaign to help identify its purpose.

signal_catalog_arn: Option<String>

(Optional) The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.

target_arn: Option<String>

The ARN of the vehicle or fleet to deploy a campaign to.

start_time: Option<DateTime>

(Optional) The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, 0 is used.

Default: 0

expiry_time: Option<DateTime>

(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.

Default: 253402214400 (December 31, 9999, 00:00:00 UTC)

post_trigger_collection_duration: Option<i64>

(Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection. If it's not specified, 0 is used.

Default: 0

diagnostics_mode: Option<DiagnosticsMode>

(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.

Default: OFF

spooling_mode: Option<SpoolingMode>

(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.

Default: OFF

compression: Option<Compression>

(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.

Default: SNAPPY

priority: Option<i32>

(Optional) 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. If it's not specified, 0 is used.

Default: 0

signals_to_collect: Option<Vec<SignalInformation>>

(Optional) A list of information about signals to collect.

collection_scheme: Option<CollectionScheme>

The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.

data_extra_dimensions: Option<Vec<String>>

(Optional) A list of vehicle attributes to associate with a campaign.

Enrich the data with specified vehicle attributes. For example, add make and model to the campaign, and Amazon Web Services IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream. You can then query the data against make and model.

Default: An empty array

tags: Option<Vec<Tag>>

Metadata that can be used to manage the campaign.

data_destination_configs: Option<Vec<DataDestinationConfig>>

The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.

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. Amazon Web Services IoT FleetWise supports at-least-once file delivery to S3. Your vehicle data is stored on multiple Amazon Web Services IoT FleetWise servers for redundancy and high availability.

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.

Implementations

impl CreateCampaignInput

pub fn name(&self) -> Option<&str>

The name of the campaign to create.

pub fn description(&self) -> Option<&str>

An optional description of the campaign to help identify its purpose.

pub fn signal_catalog_arn(&self) -> Option<&str>

(Optional) The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.

pub fn target_arn(&self) -> Option<&str>

The ARN of the vehicle or fleet to deploy a campaign to.

pub fn start_time(&self) -> Option<&DateTime>

(Optional) The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, 0 is used.

Default: 0

pub fn expiry_time(&self) -> Option<&DateTime>

(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.

Default: 253402214400 (December 31, 9999, 00:00:00 UTC)

pub fn post_trigger_collection_duration(&self) -> Option<i64>

(Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection. If it's not specified, 0 is used.

Default: 0

pub fn diagnostics_mode(&self) -> Option<&DiagnosticsMode>

(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.

Default: OFF

pub fn spooling_mode(&self) -> Option<&SpoolingMode>

(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.

Default: OFF

pub fn compression(&self) -> Option<&Compression>

(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.

Default: SNAPPY

pub fn priority(&self) -> Option<i32>

(Optional) 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. If it's not specified, 0 is used.

Default: 0

pub fn signals_to_collect(&self) -> &[SignalInformation]

(Optional) A list of information about signals to collect.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .signals_to_collect.is_none().

pub fn collection_scheme(&self) -> Option<&CollectionScheme>

The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.

pub fn data_extra_dimensions(&self) -> &[String]

(Optional) A list of vehicle attributes to associate with a campaign.

Enrich the data with specified vehicle attributes. For example, add make and model to the campaign, and Amazon Web Services IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream. You can then query the data against make and model.

Default: An empty array

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .data_extra_dimensions.is_none().

pub fn tags(&self) -> &[Tag]

Metadata that can be used to manage the campaign.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn data_destination_configs(&self) -> &[DataDestinationConfig]

The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.

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. Amazon Web Services IoT FleetWise supports at-least-once file delivery to S3. Your vehicle data is stored on multiple Amazon Web Services IoT FleetWise servers for redundancy and high availability.

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .data_destination_configs.is_none().

impl CreateCampaignInput

pub fn builder() -> CreateCampaignInputBuilder

Creates a new builder-style object to manufacture CreateCampaignInput.

Trait Implementations

impl Clone for CreateCampaignInput

fn clone(&self) -> CreateCampaignInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateCampaignInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateCampaignInput

fn eq(&self, other: &CreateCampaignInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateCampaignInput