Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Pinpoint.Types.Schedule

Description

Synopsis

data Schedule = Schedule' {
- endTime :: Maybe Text
- eventFilter :: Maybe CampaignEventFilter
- frequency :: Maybe Frequency
- isLocalTime :: Maybe Bool
- quietTime :: Maybe QuietTime
- timezone :: Maybe Text
- startTime :: Text
}
newSchedule :: Text -> Schedule
schedule_endTime :: Lens' Schedule (Maybe Text)
schedule_eventFilter :: Lens' Schedule (Maybe CampaignEventFilter)
schedule_frequency :: Lens' Schedule (Maybe Frequency)
schedule_isLocalTime :: Lens' Schedule (Maybe Bool)
schedule_quietTime :: Lens' Schedule (Maybe QuietTime)
schedule_timezone :: Lens' Schedule (Maybe Text)
schedule_startTime :: Lens' Schedule Text

Documentation

data Schedule Source #

Specifies the schedule settings for a campaign.

See: newSchedule smart constructor.

Constructors

Schedule'

Fields

endTime :: Maybe Text
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
eventFilter :: Maybe CampaignEventFilter
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
frequency :: Maybe Frequency
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
isLocalTime :: Maybe Bool
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 :: Maybe 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:
- The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
- The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
- The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
timezone :: Maybe Text
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.
startTime :: Text
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.

Instances

Instances details

FromJSON Schedule Source #
Instance details Defined in Amazonka.Pinpoint.Types.Schedule Methods parseJSON :: Value -> Parser Schedule # parseJSONList :: Value -> Parser [Schedule] #
ToJSON Schedule Source #
Instance details Defined in Amazonka.Pinpoint.Types.Schedule Methods toJSON :: Schedule -> Value # toEncoding :: Schedule -> Encoding # toJSONList :: [Schedule] -> Value # toEncodingList :: [Schedule] -> Encoding #
Generic Schedule Source #
Instance details Defined in Amazonka.Pinpoint.Types.Schedule Associated Types type Rep Schedule :: Type -> Type # Methods from :: Schedule -> Rep Schedule x # to :: Rep Schedule x -> Schedule #
Read Schedule Source #
Instance details Defined in Amazonka.Pinpoint.Types.Schedule Methods readsPrec :: Int -> ReadS Schedule # readList :: ReadS [Schedule] # readPrec :: ReadPrec Schedule # readListPrec :: ReadPrec [Schedule] #
Show Schedule Source #
Instance details Defined in Amazonka.Pinpoint.Types.Schedule Methods showsPrec :: Int -> Schedule -> ShowS # show :: Schedule -> String # showList :: [Schedule] -> ShowS #
NFData Schedule Source #
Instance details Defined in Amazonka.Pinpoint.Types.Schedule Methods rnf :: Schedule -> () #
Eq Schedule Source #
Instance details Defined in Amazonka.Pinpoint.Types.Schedule Methods (==) :: Schedule -> Schedule -> Bool # (/=) :: Schedule -> Schedule -> Bool #
Hashable Schedule Source #
Instance details Defined in Amazonka.Pinpoint.Types.Schedule Methods hashWithSalt :: Int -> Schedule -> Int # hash :: Schedule -> Int #
type Rep Schedule Source #
Instance details Defined in Amazonka.Pinpoint.Types.Schedule type Rep Schedule = D1 ('MetaData "Schedule" "Amazonka.Pinpoint.Types.Schedule" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "Schedule'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "eventFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CampaignEventFilter)) :: S1 ('MetaSel ('Just "frequency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Frequency)))) :: ((S1 ('MetaSel ('Just "isLocalTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "quietTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QuietTime))) :: (S1 ('MetaSel ('Just "timezone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newSchedule Source #

Arguments

:: Text	`$sel:startTime:Schedule'`
-> Schedule

Create a value of Schedule 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:endTime:Schedule', schedule_endTime - The scheduled time, in ISO 8601 format, when the campaign ended or will end.

$sel:eventFilter:Schedule', schedule_eventFilter - The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

$sel:frequency:Schedule', schedule_frequency - Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

$sel:isLocalTime:Schedule', schedule_isLocalTime - 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.

$sel:quietTime:Schedule', schedule_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:

The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

$sel:timezone:Schedule', schedule_timezone - 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.

$sel:startTime:Schedule', schedule_startTime - 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.

schedule_endTime :: Lens' Schedule (Maybe Text) Source #

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

schedule_eventFilter :: Lens' Schedule (Maybe CampaignEventFilter) Source #

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

schedule_frequency :: Lens' Schedule (Maybe Frequency) Source #

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

schedule_isLocalTime :: Lens' Schedule (Maybe Bool) Source #

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.

schedule_quietTime :: Lens' Schedule (Maybe QuietTime) Source #

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:

The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

schedule_timezone :: Lens' Schedule (Maybe Text) Source #

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.

schedule_startTime :: Lens' Schedule Text Source #

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.