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.KinesisVideo.Types.ScheduleConfig

Description

Synopsis

data ScheduleConfig = ScheduleConfig' {
- scheduleExpression :: Text
- durationInSeconds :: Natural
}
newScheduleConfig :: Text -> Natural -> ScheduleConfig
scheduleConfig_scheduleExpression :: Lens' ScheduleConfig Text
scheduleConfig_durationInSeconds :: Lens' ScheduleConfig Natural

Documentation

data ScheduleConfig Source #

This API enables you to specify the duration that the camera, or local media file, should record onto the Edge Agent. The ScheduleConfig consists of the ScheduleExpression and the DurationInMinutes attributes.

If the ScheduleExpression is not provided, then the Edge Agent will always be set to recording mode.

See: newScheduleConfig smart constructor.

Constructors

ScheduleConfig'

Fields

scheduleExpression :: Text
The Quartz cron expression that takes care of scheduling jobs to record from the camera, or local media file, onto the Edge Agent. If the ScheduleExpression is not provided for the RecorderConfig, then the Edge Agent will always be set to recording mode.
For more information about Quartz, refer to the Cron Trigger Tutorial page to understand the valid expressions and its use.
durationInSeconds :: Natural
The total duration to record the media. If the ScheduleExpression attribute is provided, then the DurationInSeconds attribute should also be specified.

Instances

Instances details

FromJSON ScheduleConfig Source #
Instance details Defined in Amazonka.KinesisVideo.Types.ScheduleConfig Methods parseJSON :: Value -> Parser ScheduleConfig # parseJSONList :: Value -> Parser [ScheduleConfig] #
ToJSON ScheduleConfig Source #
Instance details Defined in Amazonka.KinesisVideo.Types.ScheduleConfig Methods toJSON :: ScheduleConfig -> Value # toEncoding :: ScheduleConfig -> Encoding # toJSONList :: [ScheduleConfig] -> Value # toEncodingList :: [ScheduleConfig] -> Encoding #
Generic ScheduleConfig Source #
Instance details Defined in Amazonka.KinesisVideo.Types.ScheduleConfig Associated Types type Rep ScheduleConfig :: Type -> Type # Methods from :: ScheduleConfig -> Rep ScheduleConfig x # to :: Rep ScheduleConfig x -> ScheduleConfig #
Read ScheduleConfig Source #
Instance details Defined in Amazonka.KinesisVideo.Types.ScheduleConfig Methods readsPrec :: Int -> ReadS ScheduleConfig # readList :: ReadS [ScheduleConfig] # readPrec :: ReadPrec ScheduleConfig # readListPrec :: ReadPrec [ScheduleConfig] #
Show ScheduleConfig Source #
Instance details Defined in Amazonka.KinesisVideo.Types.ScheduleConfig Methods showsPrec :: Int -> ScheduleConfig -> ShowS # show :: ScheduleConfig -> String # showList :: [ScheduleConfig] -> ShowS #
NFData ScheduleConfig Source #
Instance details Defined in Amazonka.KinesisVideo.Types.ScheduleConfig Methods rnf :: ScheduleConfig -> () #
Eq ScheduleConfig Source #
Instance details Defined in Amazonka.KinesisVideo.Types.ScheduleConfig Methods (==) :: ScheduleConfig -> ScheduleConfig -> Bool # (/=) :: ScheduleConfig -> ScheduleConfig -> Bool #
Hashable ScheduleConfig Source #
Instance details Defined in Amazonka.KinesisVideo.Types.ScheduleConfig Methods hashWithSalt :: Int -> ScheduleConfig -> Int # hash :: ScheduleConfig -> Int #
type Rep ScheduleConfig Source #
Instance details Defined in Amazonka.KinesisVideo.Types.ScheduleConfig type Rep ScheduleConfig = D1 ('MetaData "ScheduleConfig" "Amazonka.KinesisVideo.Types.ScheduleConfig" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "ScheduleConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "scheduleExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "durationInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))

newScheduleConfig Source #

Arguments

:: Text	`$sel:scheduleExpression:ScheduleConfig'`
-> Natural	`$sel:durationInSeconds:ScheduleConfig'`
-> ScheduleConfig

Create a value of ScheduleConfig 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:scheduleExpression:ScheduleConfig', scheduleConfig_scheduleExpression - The Quartz cron expression that takes care of scheduling jobs to record from the camera, or local media file, onto the Edge Agent. If the ScheduleExpression is not provided for the RecorderConfig, then the Edge Agent will always be set to recording mode.

For more information about Quartz, refer to the Cron Trigger Tutorial page to understand the valid expressions and its use.

$sel:durationInSeconds:ScheduleConfig', scheduleConfig_durationInSeconds - The total duration to record the media. If the ScheduleExpression attribute is provided, then the DurationInSeconds attribute should also be specified.

scheduleConfig_scheduleExpression :: Lens' ScheduleConfig Text Source #

The Quartz cron expression that takes care of scheduling jobs to record from the camera, or local media file, onto the Edge Agent. If the ScheduleExpression is not provided for the RecorderConfig, then the Edge Agent will always be set to recording mode.

For more information about Quartz, refer to the Cron Trigger Tutorial page to understand the valid expressions and its use.

scheduleConfig_durationInSeconds :: Lens' ScheduleConfig Natural Source #

The total duration to record the media. If the ScheduleExpression attribute is provided, then the DurationInSeconds attribute should also be specified.