Struct aws_sdk_iotfleetwise::client::fluent_builders::CreateCampaign

pub struct CreateCampaign { /* private fields */ }

Fluent builder constructing a request to CreateCampaign.

Creates an orchestration of data collection rules. The Amazon Web Services IoT FleetWise Edge Agent software running in vehicles uses campaigns to decide how to collect and transfer data to the cloud. You create campaigns in the cloud. After you or your team approve campaigns, Amazon Web Services IoT FleetWise automatically deploys them to vehicles.

For more information, see Collect and transfer data with campaigns in the Amazon Web Services IoT FleetWise Developer Guide.

Implementations

impl CreateCampaign

pub async fn customize(
    self
) -> Result<CustomizableOperation<CreateCampaign, AwsResponseRetryClassifier>, SdkError<CreateCampaignError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<CreateCampaignOutput, SdkError<CreateCampaignError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn name(self, input: impl Into<String>) -> Self

The name of the campaign to create.

pub fn set_name(self, input: Option<String>) -> Self

The name of the campaign to create.

pub fn description(self, input: impl Into<String>) -> Self

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

pub fn set_description(self, input: Option<String>) -> Self

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

pub fn signal_catalog_arn(self, input: impl Into<String>) -> Self

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

pub fn set_signal_catalog_arn(self, input: Option<String>) -> Self

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

pub fn target_arn(self, input: impl Into<String>) -> Self

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

pub fn set_target_arn(self, input: Option<String>) -> Self

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

pub fn start_time(self, input: DateTime) -> Self

(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 set_start_time(self, input: Option<DateTime>) -> Self

(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, input: DateTime) -> Self

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

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

pub fn set_expiry_time(self, input: Option<DateTime>) -> Self

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

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

pub fn post_trigger_collection_duration(self, input: i64) -> Self

(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 set_post_trigger_collection_duration(self, input: Option<i64>) -> Self

(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, input: DiagnosticsMode) -> Self

(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 set_diagnostics_mode(self, input: Option<DiagnosticsMode>) -> Self

(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, input: SpoolingMode) -> Self

(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 set_spooling_mode(self, input: Option<SpoolingMode>) -> Self

(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, input: Compression) -> Self

(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 set_compression(self, input: Option<Compression>) -> Self

(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, input: i32) -> Self

(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 set_priority(self, input: Option<i32>) -> Self

(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, input: SignalInformation) -> Self

Appends an item to signalsToCollect.

To override the contents of this collection use set_signals_to_collect.

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

pub fn set_signals_to_collect(
    self,
    input: Option<Vec<SignalInformation>>
) -> Self

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

pub fn collection_scheme(self, input: CollectionScheme) -> Self

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

pub fn set_collection_scheme(self, input: Option<CollectionScheme>) -> Self

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, input: impl Into<String>) -> Self

Appends an item to dataExtraDimensions.

To override the contents of this collection use set_data_extra_dimensions.

(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

pub fn set_data_extra_dimensions(self, input: Option<Vec<String>>) -> Self

(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

pub fn tags(self, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

Metadata that can be used to manage the campaign.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

Metadata that can be used to manage the campaign.

Trait Implementations

impl Clone for CreateCampaign

fn clone(&self) -> CreateCampaign

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateCampaign

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

Formats the value using the given formatter.