Documentation

Specifies the configuration and other settings for a campaign.

See: newWriteCampaignRequest smart constructor.

Create a value of WriteCampaignRequest with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:additionalTreatments:WriteCampaignRequest', writeCampaignRequest_additionalTreatments - An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

WriteCampaignRequest, writeCampaignRequest_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.

$sel:description:WriteCampaignRequest', writeCampaignRequest_description - A custom description of the campaign.

$sel:holdoutPercent:WriteCampaignRequest', writeCampaignRequest_holdoutPercent - The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

$sel:hook:WriteCampaignRequest', writeCampaignRequest_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.

$sel:isPaused:WriteCampaignRequest', writeCampaignRequest_isPaused - Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.

$sel:limits:WriteCampaignRequest', writeCampaignRequest_limits - The messaging limits for the campaign.

WriteCampaignRequest, writeCampaignRequest_messageConfiguration - The message configuration settings for the campaign.

$sel:name:WriteCampaignRequest', writeCampaignRequest_name - A custom name for the campaign.

$sel:priority:WriteCampaignRequest', writeCampaignRequest_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.

WriteCampaignRequest, writeCampaignRequest_schedule - The schedule settings for the campaign.

$sel:segmentId:WriteCampaignRequest', writeCampaignRequest_segmentId - The unique identifier for the segment to associate with the campaign.

$sel:segmentVersion:WriteCampaignRequest', writeCampaignRequest_segmentVersion - The version of the segment to associate with the campaign.

WriteCampaignRequest, writeCampaignRequest_templateConfiguration - The message template to use for the campaign.

WriteCampaignRequest, writeCampaignRequest_treatmentDescription - A custom description of the default treatment for the campaign.

WriteCampaignRequest, writeCampaignRequest_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.

$sel:tags:WriteCampaignRequest', writeCampaignRequest_tags - 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.

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.

A custom name for the campaign.

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.

The schedule 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.

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.

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.