Struct aws_sdk_personalize::types::Campaign

#[non_exhaustive]
pub struct Campaign {
    pub name: Option<String>,
    pub campaign_arn: Option<String>,
    pub solution_version_arn: Option<String>,
    pub min_provisioned_tps: Option<i32>,
    pub campaign_config: Option<CampaignConfig>,
    pub status: Option<String>,
    pub failure_reason: Option<String>,
    pub creation_date_time: Option<DateTime>,
    pub last_updated_date_time: Option<DateTime>,
    pub latest_campaign_update: Option<CampaignUpdateSummary>,
}

An object that describes the deployment of a solution version. For more information on campaigns, see CreateCampaign.

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.

campaign_arn: Option<String>

The Amazon Resource Name (ARN) of the campaign.

solution_version_arn: Option<String>

The Amazon Resource Name (ARN) of a specific version of the solution.

min_provisioned_tps: Option<i32>

Specifies the requested minimum provisioned transactions (recommendations) per second. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.

campaign_config: Option<CampaignConfig>

The configuration details of a campaign.

status: Option<String>

The status of the campaign.

A campaign can be in one of the following states:

• CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

• DELETE PENDING > DELETE IN_PROGRESS

failure_reason: Option<String>

If a campaign fails, the reason behind the failure.

creation_date_time: Option<DateTime>

The date and time (in Unix format) that the campaign was created.

last_updated_date_time: Option<DateTime>

The date and time (in Unix format) that the campaign was last updated.

latest_campaign_update: Option<CampaignUpdateSummary>

Provides a summary of the properties of a campaign update. For a complete listing, call the DescribeCampaign API.

Implementations

impl Campaign

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

The name of the campaign.

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

The Amazon Resource Name (ARN) of the campaign.

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

The Amazon Resource Name (ARN) of a specific version of the solution.

pub fn min_provisioned_tps(&self) -> Option<i32>

Specifies the requested minimum provisioned transactions (recommendations) per second. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.

pub fn campaign_config(&self) -> Option<&CampaignConfig>

The configuration details of a campaign.

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

The status of the campaign.

A campaign can be in one of the following states:

• CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

• DELETE PENDING > DELETE IN_PROGRESS

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

If a campaign fails, the reason behind the failure.

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

The date and time (in Unix format) that the campaign was created.

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

The date and time (in Unix format) that the campaign was last updated.

pub fn latest_campaign_update(&self) -> Option<&CampaignUpdateSummary>

Provides a summary of the properties of a campaign update. For a complete listing, call the DescribeCampaign API.

impl Campaign

pub fn builder() -> CampaignBuilder

Creates a new builder-style object to manufacture Campaign.

Trait Implementations

impl Clone for Campaign

fn clone(&self) -> Campaign

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Campaign

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

Formats the value using the given formatter.

impl PartialEq for Campaign

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