CampaignResponse

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

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
val arn: String?

The Amazon Resource Name (ARN) of the campaign.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The custom description of the campaign.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
val id: String?

The unique identifier for the campaign.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The messaging limits for the campaign.

Link copied to clipboard

The message configuration settings for the campaign.

Link copied to clipboard
val name: String?

The name of the campaign.

Link copied to clipboard

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.

Link copied to clipboard

The schedule settings for the campaign.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The current status of the campaign.

Link copied to clipboard

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.

Link copied to clipboard

The message template that’s used for the campaign.

Link copied to clipboard

The custom description of the default treatment for the campaign.

Link copied to clipboard

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.

Link copied to clipboard
val version: Int?

The version number of the campaign.

Functions

Link copied to clipboard
inline fun copy(block: CampaignResponse.Builder.() -> Unit = {}): CampaignResponse
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String