openapi: 3.0.0
info:
version: '2021-06-30'
x-release: v4
title: Amazon EventBridge Scheduler Schedule Groups Schedules API
description: ' Amazon EventBridge Scheduler is a serverless scheduler that allows you to create, run, and manage tasks from one central, managed service. EventBridge Scheduler delivers your tasks reliably, with built-in mechanisms that adjust your schedules based on the availability of downstream targets. The following reference lists the available API actions, and data types for EventBridge Scheduler. '
x-logo:
url: https://twitter.com/awscloud/profile_image?size=original
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: scheduler
x-aws-signingName: scheduler
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/scheduler-2021-06-30.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://scheduler.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon EventBridge Scheduler multi-region endpoint
- url: https://scheduler.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon EventBridge Scheduler multi-region endpoint
- url: http://scheduler.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon EventBridge Scheduler endpoint for China (Beijing) and China (Ningxia)
- url: https://scheduler.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon EventBridge Scheduler endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Schedules
paths:
/schedules/{Name}:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateSchedule
description: Creates the specified schedule.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateScheduleOutput'
examples:
CreateSchedule200Example:
summary: Default CreateSchedule 200 response
x-microcks-default: true
value:
ScheduleArn: arn:aws:service:us-east-1:123456789012:resource/example
'480':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
examples:
CreateSchedule480Example:
summary: Default CreateSchedule 480 response
x-microcks-default: true
value: {}
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
CreateSchedule481Example:
summary: Default CreateSchedule 481 response
x-microcks-default: true
value: {}
'482':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
CreateSchedule482Example:
summary: Default CreateSchedule 482 response
x-microcks-default: true
value: {}
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
CreateSchedule483Example:
summary: Default CreateSchedule 483 response
x-microcks-default: true
value: {}
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
CreateSchedule484Example:
summary: Default CreateSchedule 484 response
x-microcks-default: true
value: {}
'485':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
CreateSchedule485Example:
summary: Default CreateSchedule 485 response
x-microcks-default: true
value: {}
parameters:
- name: Name
in: path
required: true
description: The name of the schedule that you are creating.
schema:
type: string
pattern: ^[0-9a-zA-Z-_.]+$
minLength: 1
maxLength: 64
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- FlexibleTimeWindow
- ScheduleExpression
- Target
properties:
ActionAfterCompletion:
description: Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
type: string
enum:
- NONE
- DELETE
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. '
type: string
pattern: ^[a-zA-Z0-9-_]+$
minLength: 1
maxLength: 64
Description:
description: The description you specify for the schedule.
type: string
minLength: 0
maxLength: 512
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.
type: string
format: date-time
FlexibleTimeWindow:
description: Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
type: object
properties:
MaximumWindowInMinutes:
allOf:
- $ref: '#/components/schemas/MaximumWindowInMinutes'
- description: The maximum time window during which a schedule can be invoked.
Mode:
allOf:
- $ref: '#/components/schemas/FlexibleTimeWindowMode'
- description: Determines whether the schedule is invoked within a flexible time window.
GroupName:
description: The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.
type: string
pattern: ^[0-9a-zA-Z-_.]+$
minLength: 1
maxLength: 64
KmsKeyArn:
description: The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
type: string
pattern: ^arn:aws(-[a-z]+)?:kms:[a-z0-9\-]+:\d{12}:(key|alias)\/[0-9a-zA-Z-_]*$
minLength: 1
maxLength: 2048
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>'
type: string
minLength: 1
maxLength: 256
ScheduleExpressionTimezone:
description: The timezone in which the scheduling expression is evaluated.
type: string
minLength: 1
maxLength: 50
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.
type: string
format: date-time
State:
description: Specifies whether the schedule is enabled or disabled.
type: string
enum:
- ENABLED
- DISABLED
Target:
description: The schedule's target. EventBridge Scheduler supports templated target that invoke common API operations, as well as universal targets that you can customize to invoke over 6,000 API operations across more than 270 services. You can only specify one templated or universal target for a schedule.
type: object
properties:
Arn:
allOf:
- $ref: '#/components/schemas/TargetArn'
- description: The Amazon Resource Name (ARN) of the target.
DeadLetterConfig:
allOf:
- $ref: '#/components/schemas/DeadLetterConfig'
- description: An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule. If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.
EcsParameters:
allOf:
- $ref: '#/components/schemas/EcsParameters'
- description: The templated target type for the Amazon ECS <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html"> <code>RunTask</code> </a> API operation.
EventBridgeParameters:
allOf:
- $ref: '#/components/schemas/EventBridgeParameters'
- description: The templated target type for the EventBridge <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html"> <code>PutEvents</code> </a> API operation.
Input:
allOf:
- $ref: '#/components/schemas/TargetInput'
- description: The text, or well-formed JSON, passed to the target. If you are configuring a templated Lambda, AWS Step Functions, or Amazon EventBridge target, the input must be a well-formed JSON. For all other target types, a JSON is not required. If you do not specify anything for this field, EventBridge Scheduler delivers a default notification to the target.
KinesisParameters:
allOf:
- $ref: '#/components/schemas/KinesisParameters'
- description: The templated target type for the Amazon Kinesis <a href="kinesis/latest/APIReference/API_PutRecord.html"> <code>PutRecord</code> </a> API operation.
RetryPolicy:
allOf:
- $ref: '#/components/schemas/RetryPolicy'
- description: A <code>RetryPolicy</code> object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.
RoleArn:
allOf:
- $ref: '#/components/schemas/RoleArn'
- description: The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.
SageMakerPipelineParameters:
allOf:
- $ref: '#/components/schemas/SageMakerPipelineParameters'
- description: The templated target type for the Amazon SageMaker <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html"> <code>StartPipelineExecution</code> </a> API operation.
SqsParameters:
allOf:
- $ref: '#/components/schemas/SqsParameters'
- description: The templated target type for the Amazon SQS <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html"> <code>SendMessage</code> </a> API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html">Using the Amazon SQS message deduplication ID</a> in the <i>Amazon SQS Developer Guide</i>.
examples:
CreateScheduleRequestExample:
summary: Default CreateSchedule request
x-microcks-default: true
value:
ActionAfterCompletion: NONE
ClientToken: example
Description: Example description
EndDate: '2025-01-15T00:00:00Z'
FlexibleTimeWindow: {}
summary: Amazon EventBridge Scheduler CreateSchedule
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Schedules
delete:
operationId: DeleteSchedule
description: Deletes the specified schedule.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteScheduleOutput'
examples:
DeleteSchedule200Example:
summary: Default DeleteSchedule 200 response
x-microcks-default: true
value: {}
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
DeleteSchedule480Example:
summary: Default DeleteSchedule 480 response
x-microcks-default: true
value: {}
'481':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
DeleteSchedule481Example:
summary: Default DeleteSchedule 481 response
x-microcks-default: true
value: {}
'482':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
DeleteSchedule482Example:
summary: Default DeleteSchedule 482 response
x-microcks-default: true
value: {}
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
DeleteSchedule483Example:
summary: Default DeleteSchedule 483 response
x-microcks-default: true
value: {}
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
DeleteSchedule484Example:
summary: Default DeleteSchedule 484 response
x-microcks-default: true
value: {}
parameters:
- name: clientToken
in: query
required: false
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. '
schema:
type: string
pattern: ^[a-zA-Z0-9-_]+$
minLength: 1
maxLength: 64
- name: groupName
in: query
required: false
description: The name of the schedule group associated with this schedule. If you omit this, the default schedule group is used.
schema:
type: string
pattern: ^[0-9a-zA-Z-_.]+$
minLength: 1
maxLength: 64
- name: Name
in: path
required: true
description: The name of the schedule to delete.
schema:
type: string
pattern: ^[0-9a-zA-Z-_.]+$
minLength: 1
maxLength: 64
summary: Amazon EventBridge Scheduler DeleteSchedule
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Schedules
get:
operationId: GetSchedule
description: Retrieves the specified schedule.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetScheduleOutput'
examples:
GetSchedule200Example:
summary: Default GetSchedule 200 response
x-microcks-default: true
value:
ActionAfterCompletion: example
Arn: arn:aws:service:us-east-1:123456789012:resource/example
CreationDate: '2025-01-15T00:00:00Z'
Description: Example description
EndDate: '2025-01-15T00:00:00Z'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
GetSchedule480Example:
summary: Default GetSchedule 480 response
x-microcks-default: true
value: {}
'481':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
GetSchedule481Example:
summary: Default GetSchedule 481 response
x-microcks-default: true
value: {}
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
GetSchedule482Example:
summary: Default GetSchedule 482 response
x-microcks-default: true
value: {}
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
GetSchedule483Example:
summary: Default GetSchedule 483 response
x-microcks-default: true
value: {}
parameters:
- name: groupName
in: query
required: false
description: The name of the schedule group associated with this schedule. If you omit this, EventBridge Scheduler assumes that the schedule is associated with the default group.
schema:
type: string
pattern: ^[0-9a-zA-Z-_.]+$
minLength: 1
maxLength: 64
- name: Name
in: path
required: true
description: The name of the schedule to retrieve.
schema:
type: string
pattern: ^[0-9a-zA-Z-_.]+$
minLength: 1
maxLength: 64
summary: Amazon EventBridge Scheduler GetSchedule
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Schedules
put:
operationId: UpdateSchedule
description: <p> Updates the specified schedule. When you call <code>UpdateSchedule</code>, EventBridge Scheduler uses all values, including empty values, specified in the request and overrides the existing schedule. This is by design. This means that if you do not set an optional field in your request, that field will be set to its system-default value after the update. </p> <p> Before calling this operation, we recommend that you call the <code>GetSchedule</code> API operation and make a note of all optional parameters for your <code>UpdateSchedule</code> call. </p>
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateScheduleOutput'
examples:
UpdateSchedule200Example:
summary: Default UpdateSchedule 200 response
x-microcks-default: true
value:
ScheduleArn: arn:aws:service:us-east-1:123456789012:resource/example
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
UpdateSchedule480Example:
summary: Default UpdateSchedule 480 response
x-microcks-default: true
value: {}
'481':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
UpdateSchedule481Example:
summary: Default UpdateSchedule 481 response
x-microcks-default: true
value: {}
'482':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
UpdateSchedule482Example:
summary: Default UpdateSchedule 482 response
x-microcks-default: true
value: {}
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
UpdateSchedule483Example:
summary: Default UpdateSchedule 483 response
x-microcks-default: true
value: {}
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
UpdateSchedule484Example:
summary: Default UpdateSchedule 484 response
x-microcks-default: true
value: {}
parameters:
- name: Name
in: path
required: true
description: The name of the schedule that you are updating.
schema:
type: string
pattern: ^[0-9a-zA-Z-_.]+$
minLength: 1
maxLength: 64
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- FlexibleTimeWindow
- ScheduleExpression
- Target
properties:
ActionAfterCompletion:
description: Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
type: string
enum:
- NONE
- DELETE
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. '
type: string
pattern: ^[a-zA-Z0-9-_]+$
minLength: 1
maxLength: 64
Description:
description: The description you specify for the schedule.
type: string
minLength: 0
maxLength: 512
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.
type: string
format: date-time
FlexibleTimeWindow:
description: Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
type: object
properties:
MaximumWindowInMinutes:
allOf:
- $ref: '#/components/schemas/MaximumWindowInMinutes'
- description: The maximum time window during which a schedule can be invoked.
Mode:
allOf:
- $ref: '#/components/schemas/FlexibleTimeWindowMode'
- description: Determines whether the schedule is invoked within a flexible time window.
GroupName:
description: The name of the schedule group with which the schedule is associated. You must provide this value in order for EventBridge Scheduler to find the schedule you want to update. If you omit this value, EventBridge Scheduler assumes the group is associated to the default group.
type: string
pattern: ^[0-9a-zA-Z-_.]+$
minLength: 1
maxLength: 64
KmsKeyArn:
description: The ARN for the customer managed KMS key that that you want EventBridge Scheduler to use to encrypt and decrypt your data.
type: string
pattern: ^arn:aws(-[a-z]+)?:kms:[a-z0-9\-]+:\d{12}:(key|alias)\/[0-9a-zA-Z-_]*$
minLength: 1
maxLength: 2048
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>'
type: string
minLength: 1
maxLength: 256
ScheduleExpressionTimezone:
# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-eventbridge-scheduler/refs/heads/main/openapi/amazon-eventbridge-scheduler-schedules-api-openapi.yml