Class: Aws::KinesisVideo::Types::ScheduleConfig

Inherits:

Struct

Object
Struct
Aws::KinesisVideo::Types::ScheduleConfig

show all

Defined in:: gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb

Overview

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 ScheduleConfig is not provided in the RecorderConfig, then the Edge Agent will always be set to recording mode.

If the ScheduleConfig is not provided in the UploaderConfig, then the Edge Agent will upload at regular intervals (every 1 hour).

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#duration_in_seconds ⇒ Integer
The total duration to record the media.
#schedule_expression ⇒ String
The Quartz cron expression that takes care of scheduling jobs to record from the camera, or local media file, onto the Edge Agent.

Instance Attribute Details

#duration_in_seconds ⇒ `Integer`

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

Returns:

(Integer)

# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 1564

class ScheduleConfig < Struct.new(
  :schedule_expression,
  :duration_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_expression ⇒ `String`

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.