WriteCampaignRequest

Gets and sets the property AdditionalTreatments.

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

Gets and sets the property 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.

Gets and sets the property Description.

A custom description of the campaign.

Gets and sets the property HoldoutPercent.

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

Gets and sets the property Hook.

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.

Gets and sets the property IsPaused.

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

Gets and sets the property Limits.

The messaging limits for the campaign.

Gets and sets the property MessageConfiguration.

The message configuration settings for the campaign.

Gets and sets the property Name.

A custom name for the campaign.

Gets and sets the property Priority.

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.

Gets and sets the property Schedule.

The schedule settings for the campaign.

Gets and sets the property SegmentId.

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

Gets and sets the property SegmentVersion.

The version of the segment to associate with the campaign.

Gets and sets the property Tags.

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 commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.

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

Gets and sets the property TemplateConfiguration.

The message template to use for the campaign.

Gets and sets the property TreatmentDescription.

A custom description of the default treatment for the campaign.

Gets and sets the property TreatmentName.

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.