Class: Aws::Pinpoint::Types::WriteCampaignRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-pinpoint/types.rb

Overview

Specifies the configuration and other settings for a campaign.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#additional_treatmentsArray<Types::WriteTreatmentResource>

An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

Returns:



13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
# File 'lib/aws-sdk-pinpoint/types.rb', line 13800

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_configurationTypes::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.



13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
# File 'lib/aws-sdk-pinpoint/types.rb', line 13800

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

#descriptionString

A custom description of the campaign.

Returns:

  • (String)


13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
# File 'lib/aws-sdk-pinpoint/types.rb', line 13800

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_percentInteger

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

Returns:

  • (Integer)


13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
# File 'lib/aws-sdk-pinpoint/types.rb', line 13800

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

#hookTypes::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.

Returns:



13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
# File 'lib/aws-sdk-pinpoint/types.rb', line 13800

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_pausedBoolean

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

Returns:

  • (Boolean)


13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
# File 'lib/aws-sdk-pinpoint/types.rb', line 13800

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

#limitsTypes::CampaignLimits

The messaging limits for the campaign.



13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
# File 'lib/aws-sdk-pinpoint/types.rb', line 13800

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_configurationTypes::MessageConfiguration

The message configuration settings for the campaign.



13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
# File 'lib/aws-sdk-pinpoint/types.rb', line 13800

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

#nameString

A custom name for the campaign.

Returns:

  • (String)


13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
# File 'lib/aws-sdk-pinpoint/types.rb', line 13800

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

#priorityInteger

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.

Returns:

  • (Integer)


13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
# File 'lib/aws-sdk-pinpoint/types.rb', line 13800

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

#scheduleTypes::Schedule

The schedule settings for the campaign.

Returns:



13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
# File 'lib/aws-sdk-pinpoint/types.rb', line 13800

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_idString

The unique identifier for the segment to associate with the campaign.

Returns:

  • (String)


13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
# File 'lib/aws-sdk-pinpoint/types.rb', line 13800

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_versionInteger

The version of the segment to associate with the campaign.

Returns:

  • (Integer)


13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
# File 'lib/aws-sdk-pinpoint/types.rb', line 13800

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

#tagsHash<String,String>

<note markdown=“1”>As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either [Tags] in the *API Reference for Amazon Pinpoint*,

resourcegroupstaggingapi][2

commands in the *AWS Command Line

Interface Documentation* or [resourcegroupstaggingapi] in the *AWS SDK*.

</note>

(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.

[1]: docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html [2]: docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html [3]: sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html

Returns:

  • (Hash<String,String>)


13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
# File 'lib/aws-sdk-pinpoint/types.rb', line 13800

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_configurationTypes::TemplateConfiguration

The message template to use for the campaign.



13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
# File 'lib/aws-sdk-pinpoint/types.rb', line 13800

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_descriptionString

A custom description of the default treatment for the campaign.

Returns:

  • (String)


13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
# File 'lib/aws-sdk-pinpoint/types.rb', line 13800

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_nameString

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.

Returns:

  • (String)


13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
# File 'lib/aws-sdk-pinpoint/types.rb', line 13800

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