Struct GetCampaignOutput

#[non_exhaustive]
pub struct GetCampaignOutput {

    pub name: Option<String>,
    pub arn: Option<String>,
    pub description: Option<String>,
    pub signal_catalog_arn: Option<String>,
    pub target_arn: Option<String>,
    pub status: Option<CampaignStatus>,
    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 creation_time: Option<DateTime>,
    pub last_modification_time: Option<DateTime>,
    pub data_destination_configs: Option<Vec<DataDestinationConfig>>,
    pub data_partitions: Option<Vec<DataPartition>>,
    pub signals_to_fetch: Option<Vec<SignalFetchInformation>>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The name of the campaign.

arn: Option<String>

The Amazon Resource Name (ARN) of the campaign.

description: Option<String>

The description of the campaign.

signal_catalog_arn: Option<String>

The ARN of a signal catalog.

target_arn: Option<String>

The ARN of the vehicle or the fleet targeted by the campaign.

status: Option<CampaignStatus>

The state of the campaign. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, and SUSPENDED.

start_time: Option<DateTime>

The time, in milliseconds, to deliver a campaign after it was approved.

expiry_time: Option<DateTime>

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.

post_trigger_collection_duration: Option<i64>

How long (in seconds) to collect raw data after a triggering event initiates the collection.

diagnostics_mode: Option<DiagnosticsMode>

Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.

spooling_mode: Option<SpoolingMode>

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.

compression: Option<Compression>

Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If OFF is specified, the signals aren't compressed. If it's not specified, SNAPPY is used.

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.

signals_to_collect: Option<Vec<SignalInformation>>

Information about a list of signals to collect data on.

collection_scheme: Option<CollectionScheme>

Information about the data collection scheme associated with the campaign.

data_extra_dimensions: Option<Vec<String>>

A list of vehicle attributes associated with the campaign.

creation_time: Option<DateTime>

The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).

last_modification_time: Option<DateTime>

The last time the campaign was modified.

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.

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

Information about a list of signals to fetch data from.

Implementations

impl GetCampaignOutput

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

The name of the campaign.

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

The Amazon Resource Name (ARN) of the campaign.

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

The description of the campaign.

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

The ARN of a signal catalog.

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

The ARN of the vehicle or the fleet targeted by the campaign.

pub fn status(&self) -> Option<&CampaignStatus>

The state of the campaign. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, and SUSPENDED.

pub fn start_time(&self) -> Option<&DateTime>

The time, in milliseconds, to deliver a campaign after it was approved.

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

pub fn post_trigger_collection_duration(&self) -> Option<i64>

How long (in seconds) to collect raw data after a triggering event initiates the collection.

pub fn diagnostics_mode(&self) -> Option<&DiagnosticsMode>

Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.

pub fn spooling_mode(&self) -> Option<&SpoolingMode>

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.

pub fn compression(&self) -> Option<&Compression>

Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If OFF is specified, the signals aren't compressed. If it's not specified, SNAPPY is used.

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.

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

Information about a list of signals to collect data on.

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

pub fn collection_scheme(&self) -> Option<&CollectionScheme>

Information about the data collection scheme associated with the campaign.

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

A list of vehicle attributes associated with 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 .data_extra_dimensions.is_none().

pub fn creation_time(&self) -> Option<&DateTime>

The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).

pub fn last_modification_time(&self) -> Option<&DateTime>

The last time the campaign was modified.

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.

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

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

pub fn signals_to_fetch(&self) -> &[SignalFetchInformation]

Information about a list of signals to fetch data from.

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

impl GetCampaignOutput

pub fn builder() -> GetCampaignOutputBuilder

Creates a new builder-style object to manufacture GetCampaignOutput.

Trait Implementations

impl Clone for GetCampaignOutput

fn clone(&self) -> GetCampaignOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetCampaignOutput

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

Formats the value using the given formatter.

impl PartialEq for GetCampaignOutput

fn eq(&self, other: &GetCampaignOutput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for GetCampaignOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for GetCampaignOutput