Struct CampaignResponse 

#[non_exhaustive]
pub struct CampaignResponse {

    pub additional_treatments: Option<Vec<TreatmentResource>>,
    pub application_id: Option<String>,
    pub arn: Option<String>,
    pub creation_date: Option<String>,
    pub custom_delivery_configuration: Option<CustomDeliveryConfiguration>,
    pub default_state: Option<CampaignState>,
    pub description: Option<String>,
    pub holdout_percent: Option<i32>,
    pub hook: Option<CampaignHook>,
    pub id: Option<String>,
    pub is_paused: Option<bool>,
    pub last_modified_date: Option<String>,
    pub limits: Option<CampaignLimits>,
    pub message_configuration: Option<MessageConfiguration>,
    pub name: Option<String>,
    pub schedule: Option<Schedule>,
    pub segment_id: Option<String>,
    pub segment_version: Option<i32>,
    pub state: Option<CampaignState>,
    pub tags: Option<HashMap<String, String>>,
    pub template_configuration: Option<TemplateConfiguration>,
    pub treatment_description: Option<String>,
    pub treatment_name: Option<String>,
    pub version: Option<i32>,
    pub priority: Option<i32>,
}

Provides information about the status, configuration, and other settings for a campaign.

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.

additional_treatments: Option<Vec<TreatmentResource>>

An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.

application_id: Option<String>

The unique identifier for the application that the campaign applies to.

arn: Option<String>

The Amazon Resource Name (ARN) of the campaign.

creation_date: Option<String>

The date, in ISO 8601 format, when the campaign was created.

custom_delivery_configuration: Option<CustomDeliveryConfiguration>

The delivery configuration settings for sending the campaign through a custom channel.

default_state: Option<CampaignState>

The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.

description: Option<String>

The custom description of the campaign.

holdout_percent: Option<i32>

The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

hook: Option<CampaignHook>

The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

id: Option<String>

The unique identifier for the campaign.

is_paused: Option<bool>

Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.

last_modified_date: Option<String>

The date, in ISO 8601 format, when the campaign was last modified.

limits: Option<CampaignLimits>

The messaging limits for the campaign.

message_configuration: Option<MessageConfiguration>

The message configuration settings for the campaign.

name: Option<String>

The name of the campaign.

schedule: Option<Schedule>

The schedule settings for the campaign.

segment_id: Option<String>

The unique identifier for the segment that's associated with the campaign.

segment_version: Option<i32>

The version number of the segment that's associated with the campaign.

state: Option<CampaignState>

The current status of the campaign.

tags: Option<HashMap<String, String>>

A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.

template_configuration: Option<TemplateConfiguration>

The message template that’s used for the campaign.

treatment_description: Option<String>

The custom description of the default treatment for the campaign.

treatment_name: Option<String>

The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.

version: Option<i32>

The version number of the campaign.

priority: Option<i32>

Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.

Implementations

impl CampaignResponse

pub fn additional_treatments(&self) -> &[TreatmentResource]

An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .additional_treatments.is_none().

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

The unique identifier for the application that the campaign applies to.

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

The Amazon Resource Name (ARN) of the campaign.

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

The date, in ISO 8601 format, when the campaign was created.

pub fn custom_delivery_configuration( &self, ) -> Option<&CustomDeliveryConfiguration>

The delivery configuration settings for sending the campaign through a custom channel.

pub fn default_state(&self) -> Option<&CampaignState>

The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.

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

The custom description of the campaign.

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

The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

pub fn hook(&self) -> Option<&CampaignHook>

The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

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

The unique identifier for the campaign.

pub fn is_paused(&self) -> Option<bool>

Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.

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

The date, in ISO 8601 format, when the campaign was last modified.

pub fn limits(&self) -> Option<&CampaignLimits>

The messaging limits for the campaign.

pub fn message_configuration(&self) -> Option<&MessageConfiguration>

The message configuration settings for the campaign.

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

The name of the campaign.

pub fn schedule(&self) -> Option<&Schedule>

The schedule settings for the campaign.

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

The unique identifier for the segment that's associated with the campaign.

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

The version number of the segment that's associated with the campaign.

pub fn state(&self) -> Option<&CampaignState>

The current status of the campaign.

pub fn tags(&self) -> Option<&HashMap<String, String>>

A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.

pub fn template_configuration(&self) -> Option<&TemplateConfiguration>

The message template that’s used for the campaign.

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

The custom description of the default treatment for the campaign.

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

The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.

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

The version number of the campaign.

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

Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.

impl CampaignResponse

pub fn builder() -> CampaignResponseBuilder

Creates a new builder-style object to manufacture CampaignResponse.

Trait Implementations

impl Clone for CampaignResponse

fn clone(&self) -> CampaignResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CampaignResponse

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

Formats the value using the given formatter.

impl PartialEq for CampaignResponse

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