AWS Kinesis · Schema

ScheduleConfig

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.

AnalyticsApache FlinkBig DataData ProcessingReal-TimeStreamingVideo

Properties

Name Type Description
ScheduleExpression object
DurationInSeconds object
View JSON Schema on GitHub

JSON Schema

kinesis-scheduleconfig-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ScheduleConfig",
  "title": "ScheduleConfig",
  "type": "object",
  "required": [
    "ScheduleExpression",
    "DurationInSeconds"
  ],
  "properties": {
    "ScheduleExpression": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ScheduleExpression"
        },
        {
          "description": "<p>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 <code>ScheduleExpression</code> is not provided for the <code>RecorderConfig</code>, then the Edge Agent will always be set to recording mode.</p> <p>For more information about Quartz, refer to the <a href=\"http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html\"> <i>Cron Trigger Tutorial</i> </a> page to understand the valid expressions and its use.</p>"
        }
      ]
    },
    "DurationInSeconds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DurationInSeconds"
        },
        {
          "description": "The total duration to record the media. If the <code>ScheduleExpression</code> attribute is provided, then the <code>DurationInSeconds</code> attribute should also be specified."
        }
      ]
    }
  },
  "description": "<p>This API enables you to specify the duration that the camera, or local media file, should record onto the Edge Agent. The <code>ScheduleConfig</code> consists of the <code>ScheduleExpression</code> and the <code>DurationInMinutes</code> attributes. </p> <p>If the <code>ScheduleExpression</code> is not provided, then the Edge Agent will always be set to recording mode.</p>"
}