pinpoint/aws.sdk.kotlin.services.pinpoint.model/CampaignResponse/Builder

Builder

Properties

additionalTreatments

var additionalTreatments: List<TreatmentResource>?

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

var applicationId: String?

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

var arn: String?

The Amazon Resource Name (ARN) of the campaign.

var creationDate: String?

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

customDeliveryConfiguration

var customDeliveryConfiguration: CustomDeliveryConfiguration?

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

var defaultState: CampaignState?

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

var description: String?

The custom description of the campaign.

var holdoutPercent: Int?

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

var hook: CampaignHook?

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.

var id: String?

The unique identifier for the campaign.

var isPaused: Boolean?

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

lastModifiedDate

var lastModifiedDate: String?

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

var limits: CampaignLimits?

The messaging limits for the campaign.

messageConfiguration

var messageConfiguration: MessageConfiguration?

The message configuration settings for the campaign.

var name: String?

The name of the campaign.

var priority: Int?

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.

var schedule: Schedule?

The schedule settings for the campaign.

var segmentId: String?

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

var segmentVersion: Int?

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

var state: CampaignState?

The current status of the campaign.

var tags: Map<String, String>?

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.

templateConfiguration

var templateConfiguration: TemplateConfiguration?

The message template that’s used for the campaign.

treatmentDescription

var treatmentDescription: String?

The custom description of the default treatment for the campaign.

var treatmentName: String?

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.

var version: Int?

The version number of the campaign.

Functions

customDeliveryConfiguration

fun customDeliveryConfiguration(block: CustomDeliveryConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.pinpoint.model.CustomDeliveryConfiguration inside the given block

fun defaultState(block: CampaignState.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.pinpoint.model.CampaignState inside the given block

fun hook(block: CampaignHook.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.pinpoint.model.CampaignHook inside the given block

fun limits(block: CampaignLimits.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.pinpoint.model.CampaignLimits inside the given block

messageConfiguration

fun messageConfiguration(block: MessageConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.pinpoint.model.MessageConfiguration inside the given block

fun schedule(block: Schedule.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.pinpoint.model.Schedule inside the given block

fun state(block: CampaignState.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.pinpoint.model.CampaignState inside the given block

templateConfiguration

fun templateConfiguration(block: TemplateConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.pinpoint.model.TemplateConfiguration inside the given block