Documentation

Provides information about the status, configuration, and other settings for a campaign.

See: newCampaignResponse smart constructor.

Create a value of CampaignResponse 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:CampaignResponse', campaignResponse_additionalTreatments - An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.

CampaignResponse, campaignResponse_customDeliveryConfiguration - The delivery configuration settings for sending the campaign through a custom channel.

$sel:defaultState:CampaignResponse', campaignResponse_defaultState - The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.

$sel:description:CampaignResponse', campaignResponse_description - The custom description of the campaign.

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

$sel:hook:CampaignResponse', campaignResponse_hook - The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

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

$sel:limits:CampaignResponse', campaignResponse_limits - The messaging limits for the campaign.

CampaignResponse, campaignResponse_messageConfiguration - The message configuration settings for the campaign.

$sel:name:CampaignResponse', campaignResponse_name - The name of the campaign.

$sel:priority:CampaignResponse', campaignResponse_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.

CampaignResponse, campaignResponse_schedule - The schedule settings for the campaign.

CampaignResponse, campaignResponse_state - The current status of the campaign.

CampaignResponse, campaignResponse_templateConfiguration - The message template that’s used for the campaign.

CampaignResponse, campaignResponse_treatmentDescription - The custom description of the default treatment for the campaign.

CampaignResponse, campaignResponse_treatmentName - The 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:version:CampaignResponse', campaignResponse_version - The version number of the campaign.

$sel:tags:CampaignResponse', campaignResponse_tags - A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.

$sel:lastModifiedDate:CampaignResponse', campaignResponse_lastModifiedDate - The date, in ISO 8601 format, when the campaign was last modified.

$sel:creationDate:CampaignResponse', campaignResponse_creationDate - The date, in ISO 8601 format, when the campaign was created.

$sel:segmentId:CampaignResponse', campaignResponse_segmentId - The unique identifier for the segment that's associated with the campaign.

$sel:segmentVersion:CampaignResponse', campaignResponse_segmentVersion - The version number of the segment that's associated with the campaign.

CampaignResponse, campaignResponse_id - The unique identifier for the campaign.

$sel:arn:CampaignResponse', campaignResponse_arn - The Amazon Resource Name (ARN) of the campaign.

$sel:applicationId:CampaignResponse', campaignResponse_applicationId - The unique identifier for the application that the campaign applies to.

An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.

The delivery configuration settings for sending the campaign through a custom channel.

The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.

The 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 use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

Specifies whether the campaign is paused. 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 name of 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 current status of the campaign.

The message template that’s used for the campaign.

The custom description of the default treatment for the campaign.

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

The version number of the campaign.

A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.

The date, in ISO 8601 format, when the campaign was last modified.

The date, in ISO 8601 format, when the campaign was created.

The unique identifier for the segment that's associated with the campaign.

The version number of the segment that's associated with the campaign.

The unique identifier for the campaign.

The Amazon Resource Name (ARN) of the campaign.

The unique identifier for the application that the campaign applies to.