CreateScheduleInput

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-eventbridge-scheduler/refs/heads/main/json-schema/amazon-eventbridge-scheduler-create-schedule-input-schema.json",
  "title": "CreateScheduleInput",
  "description": "CreateScheduleInput schema from Amazon EventBridge Scheduler",
  "type": "object",
  "properties": {
    "ActionAfterCompletion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ActionAfterCompletion"
        },
        {
          "description": "Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target."
        }
      ]
    },
    "ClientToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientToken"
        },
        {
          "description": " Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency. "
        }
      ]
    },
    "Description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Description"
        },
        {
          "description": "The description you specify for the schedule."
        }
      ]
    },
    "EndDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EndDate"
        },
        {
          "description": "The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the <code>EndDate</code> you specify. EventBridge Scheduler ignores <code>EndDate</code> for one-time schedules."
        }
      ]
    },
    "FlexibleTimeWindow": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FlexibleTimeWindow"
        },
        {
          "description": "Allows you to configure a time window during which EventBridge Scheduler invokes the schedule."
        }
      ]
    },
    "GroupName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ScheduleGroupName"
        },
        {
          "description": "The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used."
        }
      ]
    },
    "KmsKeyArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/KmsKeyArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data."
        }
      ]
    },
    "ScheduleExpression": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ScheduleExpression"
        },
        {
          "description": "<p> The expression that defines when the schedule runs. The following formats are supported. </p> <ul> <li> <p> <code>at</code> expression - <code>at(yyyy-mm-ddThh:mm:ss)</code> </p> </li> <li> <p> <code>rate</code> expression - <code>rate(value unit)</code> </p> </li> <li> <p> <code>cron</code> expression - <code>cron(fields)</code> </p> </li> </ul> <p> You can use <code>at</code> expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can use <code>rate</code> and <code>cron</code> expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month. </p> <p> A <code>cron</code> expression consists of six fields separated by white spaces: <code>(minutes hours day_of_month month day_of_week year)</code>. </p> <p> A <code>rate</code> expression consists of a <i>value</i> as a positive integer, and a <i>unit</i> with the following options: <code>minute</code> | <code>minutes</code> | <code>hour</code> | <code>hours</code> | <code>day</code> | <code>days</code> </p> <p> For more information and examples, see <a href=\"https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html\">Schedule types on EventBridge Scheduler</a> in the <i>EventBridge Scheduler User Guide</i>. </p>"
        }
      ]
    },
    "ScheduleExpressionTimezone": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ScheduleExpressionTimezone"
        },
        {
          "description": "The timezone in which the scheduling expression is evaluated."
        }
      ]
    },
    "StartDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StartDate"
        },
        {
          "description": "The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the <code>StartDate</code> you specify. EventBridge Scheduler ignores <code>StartDate</code> for one-time schedules."
        }
      ]
    },
    "State": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ScheduleState"
        },
        {
          "description": "Specifies whether the schedule is enabled or disabled."
        }
      ]
    },
    "Target": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Target"
        },
        {
          "description": "The schedule's target."
        }
      ]
    }
  },
  "required": [
    "FlexibleTimeWindow",
    "ScheduleExpression",
    "Target"
  ]
}