Class: Aws::Pinpoint::Types::WriteCampaignRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pinpoint::Types::WriteCampaignRequest
- Defined in:
- gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb
Overview
Specifies the configuration and other settings for a campaign.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#additional_treatments ⇒ Array<Types::WriteTreatmentResource>
An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
-
#custom_delivery_configuration ⇒ Types::CustomDeliveryConfiguration
The delivery configuration settings for sending the campaign through a custom channel.
-
#description ⇒ String
A custom description of the campaign.
-
#holdout_percent ⇒ Integer
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
-
#hook ⇒ Types::CampaignHook
The settings for the AWS Lambda function to invoke as a code hook for the campaign.
-
#is_paused ⇒ Boolean
Specifies whether to pause the campaign.
-
#limits ⇒ Types::CampaignLimits
The messaging limits for the campaign.
-
#message_configuration ⇒ Types::MessageConfiguration
The message configuration settings for the campaign.
-
#name ⇒ String
A custom name for the campaign.
-
#priority ⇒ Integer
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.
-
#schedule ⇒ Types::Schedule
The schedule settings for the campaign.
-
#segment_id ⇒ String
The unique identifier for the segment to associate with the campaign.
-
#segment_version ⇒ Integer
The version of the segment to associate with the campaign.
-
#tags ⇒ Hash<String,String>
As of 22-05-2023 tags has been deprecated for update operations. -
#template_configuration ⇒ Types::TemplateConfiguration
The message template to use for the campaign.
-
#treatment_description ⇒ String
A custom description of the default treatment for the campaign.
-
#treatment_name ⇒ String
A custom name of the default treatment for the campaign, if the campaign has multiple treatments.
Instance Attribute Details
#additional_treatments ⇒ Array<Types::WriteTreatmentResource>
An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13589 class WriteCampaignRequest < Struct.new( :additional_treatments, :custom_delivery_configuration, :description, :holdout_percent, :hook, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :tags, :template_configuration, :treatment_description, :treatment_name, :priority) SENSITIVE = [] include Aws::Structure end |
#custom_delivery_configuration ⇒ Types::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.
13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13589 class WriteCampaignRequest < Struct.new( :additional_treatments, :custom_delivery_configuration, :description, :holdout_percent, :hook, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :tags, :template_configuration, :treatment_description, :treatment_name, :priority) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
A custom description of the campaign.
13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13589 class WriteCampaignRequest < Struct.new( :additional_treatments, :custom_delivery_configuration, :description, :holdout_percent, :hook, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :tags, :template_configuration, :treatment_description, :treatment_name, :priority) SENSITIVE = [] include Aws::Structure end |
#holdout_percent ⇒ Integer
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13589 class WriteCampaignRequest < Struct.new( :additional_treatments, :custom_delivery_configuration, :description, :holdout_percent, :hook, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :tags, :template_configuration, :treatment_description, :treatment_name, :priority) SENSITIVE = [] include Aws::Structure end |
#hook ⇒ Types::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.
13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13589 class WriteCampaignRequest < Struct.new( :additional_treatments, :custom_delivery_configuration, :description, :holdout_percent, :hook, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :tags, :template_configuration, :treatment_description, :treatment_name, :priority) SENSITIVE = [] include Aws::Structure end |
#is_paused ⇒ Boolean
Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.
13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13589 class WriteCampaignRequest < Struct.new( :additional_treatments, :custom_delivery_configuration, :description, :holdout_percent, :hook, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :tags, :template_configuration, :treatment_description, :treatment_name, :priority) SENSITIVE = [] include Aws::Structure end |
#limits ⇒ Types::CampaignLimits
The messaging limits for the campaign.
13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13589 class WriteCampaignRequest < Struct.new( :additional_treatments, :custom_delivery_configuration, :description, :holdout_percent, :hook, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :tags, :template_configuration, :treatment_description, :treatment_name, :priority) SENSITIVE = [] include Aws::Structure end |
#message_configuration ⇒ Types::MessageConfiguration
The message configuration settings for the campaign.
13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13589 class WriteCampaignRequest < Struct.new( :additional_treatments, :custom_delivery_configuration, :description, :holdout_percent, :hook, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :tags, :template_configuration, :treatment_description, :treatment_name, :priority) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
A custom name for the campaign.
13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13589 class WriteCampaignRequest < Struct.new( :additional_treatments, :custom_delivery_configuration, :description, :holdout_percent, :hook, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :tags, :template_configuration, :treatment_description, :treatment_name, :priority) SENSITIVE = [] include Aws::Structure end |
#priority ⇒ Integer
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.
13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13589 class WriteCampaignRequest < Struct.new( :additional_treatments, :custom_delivery_configuration, :description, :holdout_percent, :hook, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :tags, :template_configuration, :treatment_description, :treatment_name, :priority) SENSITIVE = [] include Aws::Structure end |
#schedule ⇒ Types::Schedule
The schedule settings for the campaign.
13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13589 class WriteCampaignRequest < Struct.new( :additional_treatments, :custom_delivery_configuration, :description, :holdout_percent, :hook, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :tags, :template_configuration, :treatment_description, :treatment_name, :priority) SENSITIVE = [] include Aws::Structure end |
#segment_id ⇒ String
The unique identifier for the segment to associate with the campaign.
13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13589 class WriteCampaignRequest < Struct.new( :additional_treatments, :custom_delivery_configuration, :description, :holdout_percent, :hook, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :tags, :template_configuration, :treatment_description, :treatment_name, :priority) SENSITIVE = [] include Aws::Structure end |
#segment_version ⇒ Integer
The version of the segment to associate with the campaign.
13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13589 class WriteCampaignRequest < Struct.new( :additional_treatments, :custom_delivery_configuration, :description, :holdout_percent, :hook, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :tags, :template_configuration, :treatment_description, :treatment_name, :priority) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Hash<String,String>
(Deprecated) 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.
13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13589 class WriteCampaignRequest < Struct.new( :additional_treatments, :custom_delivery_configuration, :description, :holdout_percent, :hook, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :tags, :template_configuration, :treatment_description, :treatment_name, :priority) SENSITIVE = [] include Aws::Structure end |
#template_configuration ⇒ Types::TemplateConfiguration
The message template to use for the campaign.
13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13589 class WriteCampaignRequest < Struct.new( :additional_treatments, :custom_delivery_configuration, :description, :holdout_percent, :hook, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :tags, :template_configuration, :treatment_description, :treatment_name, :priority) SENSITIVE = [] include Aws::Structure end |
#treatment_description ⇒ String
A custom description of the default treatment for the campaign.
13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13589 class WriteCampaignRequest < Struct.new( :additional_treatments, :custom_delivery_configuration, :description, :holdout_percent, :hook, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :tags, :template_configuration, :treatment_description, :treatment_name, :priority) SENSITIVE = [] include Aws::Structure end |
#treatment_name ⇒ 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.
13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13589 class WriteCampaignRequest < Struct.new( :additional_treatments, :custom_delivery_configuration, :description, :holdout_percent, :hook, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :tags, :template_configuration, :treatment_description, :treatment_name, :priority) SENSITIVE = [] include Aws::Structure end |