Struct aws_sdk_pinpoint::model::WriteCampaignRequest
source · [−]#[non_exhaustive]pub struct WriteCampaignRequest {Show 17 fields
pub additional_treatments: Option<Vec<WriteTreatmentResource>>,
pub custom_delivery_configuration: Option<CustomDeliveryConfiguration>,
pub description: Option<String>,
pub holdout_percent: i32,
pub hook: Option<CampaignHook>,
pub is_paused: bool,
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: i32,
pub tags: Option<HashMap<String, String>>,
pub template_configuration: Option<TemplateConfiguration>,
pub treatment_description: Option<String>,
pub treatment_name: Option<String>,
pub priority: i32,
}
Expand description
Specifies the configuration and other settings for a campaign.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.additional_treatments: Option<Vec<WriteTreatmentResource>>
An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
custom_delivery_configuration: Option<CustomDeliveryConfiguration>
The delivery configuration settings for sending the campaign through a custom channel. This object is required if the MessageConfiguration object for the campaign specifies a CustomMessage object.
description: Option<String>
A custom description of the campaign.
holdout_percent: 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 invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
is_paused: bool
Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.
limits: Option<CampaignLimits>
The messaging limits for the campaign.
message_configuration: Option<MessageConfiguration>
The message configuration settings for the campaign.
name: Option<String>
A custom name for the campaign.
schedule: Option<Schedule>
The schedule settings for the campaign.
segment_id: Option<String>
The unique identifier for the segment to associate with the campaign.
segment_version: i32
The version of the segment to associate with the campaign.
A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value.
template_configuration: Option<TemplateConfiguration>
The message template to use for the campaign.
treatment_description: Option<String>
A custom description of the default treatment for the campaign.
treatment_name: Option<String>
A 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.
priority: 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
An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
The delivery configuration settings for sending the campaign through a custom channel. This object is required if the MessageConfiguration object for the campaign specifies a CustomMessage object.
A custom description of the campaign.
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.
The messaging limits for the campaign.
The message configuration settings for the campaign.
The unique identifier for the segment to associate with the campaign.
The version of the segment to associate with the campaign.
A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value.
The message template to use for the campaign.
A custom description of the default treatment for the campaign.
A 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.
Creates a new builder-style object to manufacture WriteCampaignRequest
Trait Implementations
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for WriteCampaignRequest
impl Send for WriteCampaignRequest
impl Sync for WriteCampaignRequest
impl Unpin for WriteCampaignRequest
impl UnwindSafe for WriteCampaignRequest
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more