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

Builder

class Builder

Properties

endTime

var endTime: String?

The scheduled time, in ISO 8601 format, when the campaign ended or will end.

eventFilter

var eventFilter: CampaignEventFilter?

The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

frequency

var frequency: Frequency?

Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

isLocalTime

var isLocalTime: Boolean?

Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

quietTime

var quietTime: QuietTime?

The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

startTime

var startTime: String?

The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.

timezone

var timezone: String?

The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

Functions

eventFilter

fun eventFilter(block: CampaignEventFilter.Builder.() -> Unit)

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

quietTime

fun quietTime(block: QuietTime.Builder.() -> Unit)

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