aws_sdk_iotfleetwise/client/

create_campaign.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateCampaign`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`name(impl Into<String>)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::set_name):<br>required: **true**<br><p>The name of the campaign to create.</p><br>
    ///   - [`description(impl Into<String>)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::set_description):<br>required: **false**<br><p>An optional description of the campaign to help identify its purpose.</p><br>
    ///   - [`signal_catalog_arn(impl Into<String>)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::signal_catalog_arn) / [`set_signal_catalog_arn(Option<String>)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::set_signal_catalog_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.</p><br>
    ///   - [`target_arn(impl Into<String>)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::target_arn) / [`set_target_arn(Option<String>)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::set_target_arn):<br>required: **true**<br><p>The ARN of the vehicle or fleet to deploy a campaign to.</p><br>
    ///   - [`start_time(DateTime)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::start_time) / [`set_start_time(Option<DateTime>)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::set_start_time):<br>required: **false**<br><p>The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, <code>0</code> is used.</p> <p>Default: <code>0</code></p><br>
    ///   - [`expiry_time(DateTime)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::expiry_time) / [`set_expiry_time(Option<DateTime>)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::set_expiry_time):<br>required: **false**<br><p>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.</p> <p>Default: 253402214400 (December 31, 9999, 00:00:00 UTC)</p><br>
    ///   - [`post_trigger_collection_duration(i64)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::post_trigger_collection_duration) / [`set_post_trigger_collection_duration(Option<i64>)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::set_post_trigger_collection_duration):<br>required: **false**<br><p>How long (in milliseconds) to collect raw data after a triggering event initiates the collection. If it's not specified, <code>0</code> is used.</p> <p>Default: <code>0</code></p><br>
    ///   - [`diagnostics_mode(DiagnosticsMode)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::diagnostics_mode) / [`set_diagnostics_mode(Option<DiagnosticsMode>)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::set_diagnostics_mode):<br>required: **false**<br><p>Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. If you want to send diagnostic trouble codes, use <code>SEND_ACTIVE_DTCS</code>. If it's not specified, <code>OFF</code> is used.</p> <p>Default: <code>OFF</code></p><br>
    ///   - [`spooling_mode(SpoolingMode)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::spooling_mode) / [`set_spooling_mode(Option<SpoolingMode>)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::set_spooling_mode):<br>required: **false**<br><p>Determines 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 <code>TO_DISK</code>. If it's not specified, <code>OFF</code> is used.</p> <p>Default: <code>OFF</code></p><br>
    ///   - [`compression(Compression)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::compression) / [`set_compression(Option<Compression>)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::set_compression):<br>required: **false**<br><p>Determines whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If you don't want to compress the signals, use <code>OFF</code>. If it's not specified, <code>SNAPPY</code> is used.</p> <p>Default: <code>SNAPPY</code></p><br>
    ///   - [`priority(i32)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::priority) / [`set_priority(Option<i32>)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::set_priority):<br>required: **false**<br><p>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, <code>0</code> is used.</p> <p>Default: <code>0</code></p><br>
    ///   - [`signals_to_collect(SignalInformation)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::signals_to_collect) / [`set_signals_to_collect(Option<Vec::<SignalInformation>>)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::set_signals_to_collect):<br>required: **false**<br><p>A list of information about signals to collect.</p><note>  <p>If you upload a signal as a condition in a data partition for a campaign, then those same signals must be included in <code>signalsToCollect</code>.</p> </note><br>
    ///   - [`collection_scheme(CollectionScheme)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::collection_scheme) / [`set_collection_scheme(Option<CollectionScheme>)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::set_collection_scheme):<br>required: **true**<br><p>The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.</p><br>
    ///   - [`data_extra_dimensions(impl Into<String>)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::data_extra_dimensions) / [`set_data_extra_dimensions(Option<Vec::<String>>)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::set_data_extra_dimensions):<br>required: **false**<br><p>A list of vehicle attributes to associate with a campaign.</p> <p>Enrich the data with specified vehicle attributes. For example, add <code>make</code> and <code>model</code> 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 <code>make</code> and <code>model</code>.</p> <p>Default: An empty array</p><br>
    ///   - [`tags(Tag)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::set_tags):<br>required: **false**<br><p>Metadata that can be used to manage the campaign.</p><br>
    ///   - [`data_destination_configs(DataDestinationConfig)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::data_destination_configs) / [`set_data_destination_configs(Option<Vec::<DataDestinationConfig>>)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::set_data_destination_configs):<br>required: **false**<br><p>The destination where the campaign sends data. You can send data to an MQTT topic, or store it in Amazon S3 or Amazon Timestream.</p> <p>MQTT is the publish/subscribe messaging protocol used by Amazon Web Services IoT to communicate with your devices.</p> <p>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.</p> <p>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.</p><br>
    ///   - [`data_partitions(DataPartition)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::data_partitions) / [`set_data_partitions(Option<Vec::<DataPartition>>)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::set_data_partitions):<br>required: **false**<br><p>The data partitions associated with the signals collected from the vehicle.</p><br>
    ///   - [`signals_to_fetch(SignalFetchInformation)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::signals_to_fetch) / [`set_signals_to_fetch(Option<Vec::<SignalFetchInformation>>)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::set_signals_to_fetch):<br>required: **false**<br><p>A list of information about signals to fetch.</p><br>
    /// - On success, responds with [`CreateCampaignOutput`](crate::operation::create_campaign::CreateCampaignOutput) with field(s):
    ///   - [`name(Option<String>)`](crate::operation::create_campaign::CreateCampaignOutput::name): <p>The name of the created campaign.</p>
    ///   - [`arn(Option<String>)`](crate::operation::create_campaign::CreateCampaignOutput::arn): <p>The ARN of the created campaign.</p>
    /// - On failure, responds with [`SdkError<CreateCampaignError>`](crate::operation::create_campaign::CreateCampaignError)
    pub fn create_campaign(&self) -> crate::operation::create_campaign::builders::CreateCampaignFluentBuilder {
        crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::new(self.handle.clone())
    }
}