How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon EventBridge Scheduler Schedules API

The Schedules API from Amazon EventBridge Scheduler — 2 operation(s) for schedules.

Amazon EventBridge Scheduler Schedules API is one of 3 APIs that Amazon EventBridge Scheduler publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Schedules. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, pricing, a JSON-LD context, and 3 JSON Schemas.

This API exposes 5 operations across 2 paths, and defines 85 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 4 base URLs: http://scheduler.{region}.amazonaws.com, https://scheduler.{region}.amazonaws.com, http://scheduler.{region}.amazonaws.com.cn, https://scheduler.{region}.amazonaws.com.cn.

5 operations 2 paths 85 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://scheduler.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon EventBridge Scheduler Schedules API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Schedules 5
POST
/schedules/{Name}
Amazon EventBridge Scheduler CreateSchedule
CreateSchedule 8 params body → 200480481482483484485
DELETE
/schedules/{Name}
Amazon EventBridge Scheduler DeleteSchedule
DeleteSchedule 10 params → 200480481482483484
GET
/schedules/{Name}
Amazon EventBridge Scheduler GetSchedule
GetSchedule 9 params → 200480481482483
PUT
/schedules/{Name}
Amazon EventBridge Scheduler UpdateSchedule
UpdateSchedule 8 params body → 200480481482483484
GET
/schedules
Amazon EventBridge Scheduler ListSchedules
ListSchedules 12 params → 200480481482483

Schemas 85

The contract defines 85 schemas that model the data the API accepts and returns. The most detailed are GetScheduleOutput (15 properties), EcsParameters (14 properties), Target (10 properties), ScheduleSummary (7 properties). Each schema is shown below with its type and property counts.

PlacementStrategyField
string
ThrottlingException
PlacementConstraints
array
Group
string
CapacityProviderStrategyItemWeight
integer
ScheduleArn
string
EnableExecuteCommand
boolean
EndDate
string
MessageGroupId
string
SageMakerPipelineParameterValue
string
Target
object
The schedule's target. EventBridge Scheduler supports templated target that invoke common API operations, as well as universal targets that you can customize t…
10 properties 2 required
SecurityGroups
array
CapacityProviderStrategyItem
object
The details of a capacity provider strategy.
3 properties 1 required
AwsVpcConfiguration
object
This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for E…
3 properties 1 required
InternalServerException
ScheduleExpression
string
UpdateScheduleOutput
object
1 property 1 required
TargetInput
string
TaskCount
integer
KinesisParameters
object
The templated target type for the Amazon Kinesis PutRecord API operation.
1 property 1 required
TargetSummary
object
The details of a target.
1 property 1 required
CreateScheduleOutput
object
1 property 1 required
Name
string
SageMakerPipelineParameterName
string
TaskDefinitionArn
string
PlatformVersion
string
ActionAfterCompletion
string
ListSchedulesOutput
object
2 properties 1 required
SageMakerPipelineParameter
object
The name and value pair of a parameter to use to start execution of a SageMaker Model Building Pipeline.
2 properties 2 required
RetryPolicy
object
A RetryPolicy object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBri…
2 properties
SqsParameters
object
The templated target type for the Amazon SQS SendMessage API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an…
1 property
PlacementStrategyType
string
Description
string
ScheduleState
string
TargetArn
string
CreationDate
string
LastModificationDate
string
Subnet
string
ScheduleGroupName
string
Tags
array
CapacityProviderStrategy
array
TagMap
object
PlacementConstraintExpression
string
FlexibleTimeWindowMode
string
ScheduleList
array
TagValue
string
PropagateTags
string
FlexibleTimeWindow
object
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
2 properties 1 required
CapacityProviderStrategyItemBase
integer
NetworkConfiguration
object
Specifies the network configuration for an ECS task.
1 property
KmsKeyArn
string
Subnets
array
MaximumRetryAttempts
integer
RoleArn
string
DeadLetterConfig
object
An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule. If specified, EventBrid…
1 property
NextToken
string
EnableECSManagedTags
boolean
MaximumWindowInMinutes
integer
ScheduleSummary
object
The details of a schedule.
7 properties
CapacityProvider
string
SageMakerPipelineParameterList
array
ReferenceId
string
SageMakerPipelineParameters
object
The templated target type for the Amazon SageMaker StartPipelineExecution API operation.
1 property
ResourceNotFoundException
PlacementConstraint
object
An object representing a constraint on task placement.
2 properties
ValidationException
EcsParameters
object
The templated target type for the Amazon ECS RunTask API operation.
14 properties 1 required
GetScheduleOutput
object
15 properties
SecurityGroup
string
TargetPartitionKey
string
StartDate
string
PlacementStrategies
array
EventBridgeParameters
object
The templated target type for the EventBridge PutEvents API operation.
2 properties 2 required
ScheduleExpressionTimezone
string
AssignPublicIp
string
ConflictException
PlacementStrategy
object
The task placement strategy for a task or service.
2 properties
Source
string
DeleteScheduleOutput
object
DetailType
string
PlacementConstraintType
string
LaunchType
string
ServiceQuotaExceededException
DeadLetterConfigArnString
string
MaximumEventAgeInSeconds
integer

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-eventbridge-scheduler-schedules-api-openapi.yml Raw ↑

Other APIs Amazon EventBridge Scheduler publishes across the network.

Amazon EventBridge Scheduler Schedule Groups API
Amazon EventBridge Scheduler Tags API
Where this information came from

This is an independent, third-party profile of Amazon EventBridge Scheduler Schedules API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.