Struct aws_sdk_iotfleetwise::input::CreateCampaignInput

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

Implementations

impl CreateCampaignInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<CreateCampaign, AwsResponseRetryClassifier>, BuildError>

Consumes the builder and constructs an Operation<CreateCampaign>

Examples found in repository

src/client.rs (line 1082)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::CreateCampaign,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::CreateCampaignError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// 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](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::CreateCampaignOutput,
            aws_smithy_http::result::SdkError<crate::error::CreateCampaignError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CreateCampaignInput.

impl CreateCampaignInput

pub fn name(&self) -> Option<&str>

The name of the campaign to create.

pub fn description(&self) -> Option<&str>

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

pub fn signal_catalog_arn(&self) -> Option<&str>

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

pub fn target_arn(&self) -> Option<&str>

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

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

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: 253402243200 (December 31, 9999, 00:00:00 UTC)

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

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

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

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

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

pub fn signals_to_collect(&self) -> Option<&[SignalInformation]>

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

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.

pub fn data_extra_dimensions(&self) -> Option<&[String]>

(Optional) A list of vehicle attributes to associate with a campaign.

Default: An empty array

pub fn tags(&self) -> Option<&[Tag]>

Metadata that can be used to manage the campaign.

Trait Implementations

impl Clone for CreateCampaignInput

fn clone(&self) -> CreateCampaignInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateCampaignInput

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

Formats the value using the given formatter.

impl PartialEq<CreateCampaignInput> for CreateCampaignInput

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