Struct aws_sdk_iotfleetwise::input::CreateCampaignInput
source · #[non_exhaustive]pub struct CreateCampaignInput { /* private fields */ }Implementations§
source§impl CreateCampaignInput
impl CreateCampaignInput
sourcepub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CreateCampaign, AwsResponseRetryClassifier>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CreateCampaign, AwsResponseRetryClassifier>, BuildError>
Consumes the builder and constructs an Operation<CreateCampaign>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture CreateCampaignInput.
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>
(Optional) 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>
(Optional) 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>
(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)
sourcepub fn post_trigger_collection_duration(&self) -> Option<i64>
pub fn 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
sourcepub fn diagnostics_mode(&self) -> Option<&DiagnosticsMode>
pub fn 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
sourcepub fn spooling_mode(&self) -> Option<&SpoolingMode>
pub fn 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
sourcepub fn compression(&self) -> Option<&Compression>
pub fn 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
sourcepub fn priority(&self) -> Option<i32>
pub fn 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
sourcepub fn signals_to_collect(&self) -> Option<&[SignalInformation]>
pub fn signals_to_collect(&self) -> Option<&[SignalInformation]>
(Optional) A list of information about signals to collect.
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) -> Option<&[String]>
pub fn data_extra_dimensions(&self) -> Option<&[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
Metadata that can be used to manage the campaign.
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<CreateCampaignInput> for CreateCampaignInput
impl PartialEq<CreateCampaignInput> for CreateCampaignInput
source§fn eq(&self, other: &CreateCampaignInput) -> bool
fn eq(&self, other: &CreateCampaignInput) -> bool
self and other values to be equal, and is used
by ==.