Struct aws_sdk_iotfleetwise::operation::create_campaign::builders::CreateCampaignFluentBuilder

source ·

pub struct CreateCampaignFluentBuilder { /* private fields */ }

Expand description

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§

source §

impl CreateCampaignFluentBuilder

source

pub fn as_input(&self) -> &CreateCampaignInputBuilder

Access the CreateCampaign as a reference.

source

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

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.

source

pub fn customize( self ) -> CustomizableOperation<CreateCampaignOutput, CreateCampaignError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

source

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

The name of the campaign to create.

source

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

The name of the campaign to create.

source

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

The name of the campaign to create.

source

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

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

source

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

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

source

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

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

source

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.

source

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.

source

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

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

source

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

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

source

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

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

source

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

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

source

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

source

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

source

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

source

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)

source

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)

source

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)

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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.

source

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

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

source

pub fn get_signals_to_collect(&self) -> &Option<Vec<SignalInformation>>

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

source

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.

source

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.

source

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.

source

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

source

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

source

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

source

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.

source

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

Metadata that can be used to manage the campaign.

source

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

Metadata that can be used to manage the campaign.

source

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

Appends an item to dataDestinationConfigs.

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.

source

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.

source

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.