Struct aws_sdk_iotfleetwise::types::CampaignSummary

#[non_exhaustive]
pub struct CampaignSummary {
    pub arn: Option<String>,
    pub name: Option<String>,
    pub description: Option<String>,
    pub signal_catalog_arn: Option<String>,
    pub target_arn: Option<String>,
    pub status: Option<CampaignStatus>,
    pub creation_time: DateTime,
    pub last_modification_time: DateTime,
}

Information about a campaign.

You can use the API operation to return this information about multiple created campaigns.

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.

arn: Option<String>

The Amazon Resource Name (ARN) of a campaign.

name: Option<String>

The name of a campaign.

description: Option<String>

The description of the campaign.

signal_catalog_arn: Option<String>

The ARN of the signal catalog associated with the campaign.

target_arn: Option<String>

The ARN of a vehicle or fleet to which the campaign is deployed.

status: Option<CampaignStatus>

The state of a campaign. The status can be one of the following:

• CREATING - Amazon Web Services IoT FleetWise is processing your request to create the campaign.

• WAITING_FOR_APPROVAL - After a campaign is created, it enters the WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT FleetWise to deploy the campaign to the target vehicle or fleet, use the API operation to approve the campaign.

• RUNNING - The campaign is active.

• SUSPENDED - The campaign is suspended. To resume the campaign, use the API operation.

creation_time: DateTime

The time the campaign was created.

last_modification_time: DateTime

The last time the campaign was modified.

Implementations

impl CampaignSummary

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

The Amazon Resource Name (ARN) of a campaign.

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

The name of a campaign.

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

The description of the campaign.

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

The ARN of the signal catalog associated with the campaign.

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

The ARN of a vehicle or fleet to which the campaign is deployed.

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

The state of a campaign. The status can be one of the following:

• CREATING - Amazon Web Services IoT FleetWise is processing your request to create the campaign.

• WAITING_FOR_APPROVAL - After a campaign is created, it enters the WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT FleetWise to deploy the campaign to the target vehicle or fleet, use the API operation to approve the campaign.

• RUNNING - The campaign is active.

• SUSPENDED - The campaign is suspended. To resume the campaign, use the API operation.

pub fn creation_time(&self) -> &DateTime

The time the campaign was created.

pub fn last_modification_time(&self) -> &DateTime

The last time the campaign was modified.

impl CampaignSummary

pub fn builder() -> CampaignSummaryBuilder

Creates a new builder-style object to manufacture CampaignSummary.

Trait Implementations

impl Clone for CampaignSummary

fn clone(&self) -> CampaignSummary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CampaignSummary

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

Formats the value using the given formatter.

impl PartialEq for CampaignSummary

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