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.IoT.Types.SchedulingConfig

Description

Documentation

data SchedulingConfig Source #

Specifies the date and time that a job will begin the rollout of the job document to all devices in the target group. Additionally, you can specify the end behavior for each job execution when it reaches the scheduled end time.

See: newSchedulingConfig smart constructor.

Constructors

SchedulingConfig'

Fields

endBehavior :: Maybe JobEndBehavior
Specifies the end behavior for all job executions after a job reaches the selected endTime. If endTime is not selected when creating the job, then endBehavior does not apply.
endTime :: Maybe Text
The time a job will stop rollout of the job document to all devices in the target group for a job. The endTime must take place no later than two years from the current time and be scheduled a minimum of thirty minutes from the current time. The minimum duration between startTime and endTime is thirty minutes. The maximum duration between startTime and endTime is two years.
startTime :: Maybe Text
The time a job will begin rollout of the job document to all devices in the target group for a job. The startTime can be scheduled up to a year in advance and must be scheduled a minimum of thirty minutes from the current time.

Instances

Instances details

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

newSchedulingConfig :: SchedulingConfig Source #

Create a value of SchedulingConfig 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:endBehavior:SchedulingConfig', schedulingConfig_endBehavior - Specifies the end behavior for all job executions after a job reaches the selected endTime. If endTime is not selected when creating the job, then endBehavior does not apply.

$sel:endTime:SchedulingConfig', schedulingConfig_endTime - The time a job will stop rollout of the job document to all devices in the target group for a job. The endTime must take place no later than two years from the current time and be scheduled a minimum of thirty minutes from the current time. The minimum duration between startTime and endTime is thirty minutes. The maximum duration between startTime and endTime is two years.

$sel:startTime:SchedulingConfig', schedulingConfig_startTime - The time a job will begin rollout of the job document to all devices in the target group for a job. The startTime can be scheduled up to a year in advance and must be scheduled a minimum of thirty minutes from the current time.

schedulingConfig_endBehavior :: Lens' SchedulingConfig (Maybe JobEndBehavior) Source #

Specifies the end behavior for all job executions after a job reaches the selected endTime. If endTime is not selected when creating the job, then endBehavior does not apply.

schedulingConfig_endTime :: Lens' SchedulingConfig (Maybe Text) Source #

The time a job will stop rollout of the job document to all devices in the target group for a job. The endTime must take place no later than two years from the current time and be scheduled a minimum of thirty minutes from the current time. The minimum duration between startTime and endTime is thirty minutes. The maximum duration between startTime and endTime is two years.

schedulingConfig_startTime :: Lens' SchedulingConfig (Maybe Text) Source #

The time a job will begin rollout of the job document to all devices in the target group for a job. The startTime can be scheduled up to a year in advance and must be scheduled a minimum of thirty minutes from the current time.