#[non_exhaustive]pub struct CreateCampaignInput {Show 18 fields
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>>,
pub data_partitions: Option<Vec<DataPartition>>,
pub signals_to_fetch: Option<Vec<SignalFetchInformation>>,
}Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
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>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>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>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>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>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>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 TO_DISK. If it's not specified, OFF is used.
Default: OFF
compression: Option<Compression>Determines 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>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>>A list of information about signals to collect.
If you upload a signal as a condition in a data partition for a campaign, then those same signals must be included in signalsToCollect.
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>>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
Metadata that can be used to manage the campaign.
data_destination_configs: Option<Vec<DataDestinationConfig>>The destination where the campaign sends data. You can send data to an MQTT topic, or store it in Amazon S3 or Amazon Timestream.
MQTT is the publish/subscribe messaging protocol used by Amazon Web Services IoT to communicate with your devices.
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.
data_partitions: Option<Vec<DataPartition>>The data partitions associated with the signals collected from the vehicle.
signals_to_fetch: Option<Vec<SignalFetchInformation>>A list of information about signals to fetch.
Implementations§
Source§impl CreateCampaignInput
impl CreateCampaignInput
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
An optional description of the campaign to help identify its purpose.
Sourcepub fn signal_catalog_arn(&self) -> Option<&str>
pub fn signal_catalog_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.
Sourcepub fn target_arn(&self) -> Option<&str>
pub fn target_arn(&self) -> Option<&str>
The ARN of the vehicle or fleet to deploy a campaign to.
Sourcepub fn start_time(&self) -> Option<&DateTime>
pub fn start_time(&self) -> Option<&DateTime>
The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, 0 is used.
Default: 0
Sourcepub fn expiry_time(&self) -> Option<&DateTime>
pub fn expiry_time(&self) -> Option<&DateTime>
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)
Sourcepub fn post_trigger_collection_duration(&self) -> Option<i64>
pub fn post_trigger_collection_duration(&self) -> Option<i64>
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
Sourcepub fn diagnostics_mode(&self) -> Option<&DiagnosticsMode>
pub fn diagnostics_mode(&self) -> Option<&DiagnosticsMode>
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
Sourcepub fn spooling_mode(&self) -> Option<&SpoolingMode>
pub fn spooling_mode(&self) -> Option<&SpoolingMode>
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 TO_DISK. If it's not specified, OFF is used.
Default: OFF
Sourcepub fn compression(&self) -> Option<&Compression>
pub fn compression(&self) -> Option<&Compression>
Determines 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
Sourcepub fn priority(&self) -> Option<i32>
👎Deprecated: priority is no longer used or needed as input
pub fn priority(&self) -> Option<i32>
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
Sourcepub fn signals_to_collect(&self) -> &[SignalInformation]
pub fn signals_to_collect(&self) -> &[SignalInformation]
A list of information about signals to collect.
If you upload a signal as a condition in a data partition for a campaign, then those same signals must be included in signalsToCollect.
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().
Sourcepub fn collection_scheme(&self) -> Option<&CollectionScheme>
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.
Sourcepub fn data_extra_dimensions(&self) -> &[String]
pub fn data_extra_dimensions(&self) -> &[String]
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().
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().
Sourcepub fn data_destination_configs(&self) -> &[DataDestinationConfig]
pub fn data_destination_configs(&self) -> &[DataDestinationConfig]
The destination where the campaign sends data. You can send data to an MQTT topic, or store it in Amazon S3 or Amazon Timestream.
MQTT is the publish/subscribe messaging protocol used by Amazon Web Services IoT to communicate with your devices.
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().
Sourcepub fn data_partitions(&self) -> &[DataPartition]
pub fn data_partitions(&self) -> &[DataPartition]
The data partitions associated with the signals collected from the vehicle.
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_partitions.is_none().
Sourcepub fn signals_to_fetch(&self) -> &[SignalFetchInformation]
pub fn signals_to_fetch(&self) -> &[SignalFetchInformation]
A list of information about signals to fetch.
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_fetch.is_none().
Source§impl CreateCampaignInput
impl CreateCampaignInput
Sourcepub fn builder() -> CreateCampaignInputBuilder
pub fn builder() -> CreateCampaignInputBuilder
Creates a new builder-style object to manufacture CreateCampaignInput.
Trait Implementations§
Source§impl Clone for CreateCampaignInput
impl Clone for CreateCampaignInput
Source§fn clone(&self) -> CreateCampaignInput
fn clone(&self) -> CreateCampaignInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for CreateCampaignInput
impl Debug for CreateCampaignInput
Source§impl PartialEq for CreateCampaignInput
impl PartialEq for CreateCampaignInput
impl StructuralPartialEq for CreateCampaignInput
Auto Trait Implementations§
impl Freeze for CreateCampaignInput
impl RefUnwindSafe for CreateCampaignInput
impl Send for CreateCampaignInput
impl Sync for CreateCampaignInput
impl Unpin for CreateCampaignInput
impl UnwindSafe for CreateCampaignInput
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);