Struct aws_sdk_iotfleetwise::operation::create_campaign::builders::CreateCampaignInputBuilder

#[non_exhaustive]
pub struct CreateCampaignInputBuilder { /* private fields */ }

A builder for CreateCampaignInput.

Implementations

impl CreateCampaignInputBuilder

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

The name of the campaign to create.

This field is required.

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

The name of the campaign to create.

pub fn get_name(&self) -> &Option<String>

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 get_description(&self) -> &Option<String>

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.

This field is required.

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 get_signal_catalog_arn(&self) -> &Option<String>

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

This field is required.

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

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

pub fn get_target_arn(&self) -> &Option<String>

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

(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 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 isn't collected after the campaign expires.

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

pub fn get_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, 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 get_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, 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 get_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, 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 get_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, 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 get_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, 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 get_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, input: SignalInformation) -> Self

Appends an item to signals_to_collect.

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 get_signals_to_collect(&self) -> &Option<Vec<SignalInformation>>

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

This field is required.

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

Appends an item to data_extra_dimensions.

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 get_data_extra_dimensions(&self) -> &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

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.

pub fn get_tags(&self) -> &Option<Vec<Tag>>

Metadata that can be used to manage the campaign.

pub fn data_destination_configs(self, input: DataDestinationConfig) -> Self

Appends an item to data_destination_configs.

To override the contents of this collection use set_data_destination_configs.

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.

pub fn set_data_destination_configs( self, input: Option<Vec<DataDestinationConfig>> ) -> Self

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.

pub fn get_data_destination_configs( &self ) -> &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.

pub fn build(self) -> Result<CreateCampaignInput, BuildError>

Consumes the builder and constructs a CreateCampaignInput.

impl CreateCampaignInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<CreateCampaignOutput, SdkError<CreateCampaignError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for CreateCampaignInputBuilder

fn clone(&self) -> CreateCampaignInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateCampaignInputBuilder

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

Formats the value using the given formatter.

impl Default for CreateCampaignInputBuilder

fn default() -> CreateCampaignInputBuilder

Returns the “default value” for a type.

impl PartialEq for CreateCampaignInputBuilder

fn eq(&self, other: &CreateCampaignInputBuilder) -> 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 CreateCampaignInputBuilder