Amazon Web Services, Inc.

Amazon EventBridge Scheduler

Amazon EventBridge Scheduler is a serverless scheduler that allows you to create, run, and manage tasks from one central, managed service. EventBridge…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Endpoints 12

Schedule

  • GETGet schedule/schedules/:Name?groupName=stringRetrieves the specified schedule.
  • PUTUpdate schedule/schedules/:NameUpdates the specified schedule. When you call UpdateSchedule , EventBridge Scheduler uses all values, including empty values, specified in the request and…
  • POSTCreate schedule/schedules/:NameCreates the specified schedule.
  • DELETEDelete schedule/schedules/:Name?groupName=string&clientToken=stringDeletes the specified schedule.
  • GETList schedules/schedules?ScheduleGroup=string&NamePrefix=string&State=string&NextToken=string&MaxResults=0Returns a paginated list of your EventBridge Scheduler schedules.

Schedule group

  • GETGet schedule group/schedule-groups/:NameRetrieves the specified schedule group.
  • POSTCreate schedule group/schedule-groups/:NameCreates the specified schedule group.
  • DELETEDelete schedule group/schedule-groups/:Name?clientToken=stringDeletes the specified schedule group. Deleting a schedule group results in EventBridge Scheduler deleting all schedules associated with the group. When you…
  • GETList schedule groups/schedule-groups?NamePrefix=string&NextToken=string&MaxResults=0Returns a paginated list of your schedule groups.
  • GETList tags for resource/tags/:ResourceArnLists the tags associated with the Scheduler resource.
  • POSTTag resource/tags/:ResourceArnAssigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource. You can only assign tags to schedule groups.
  • DELETEUntag resource/tags/:ResourceArn?TagKeys=Removes one or more tags from the specified EventBridge Scheduler schedule group.

API details

Base URL
https://scheduler.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
12 operations on 5 pathsGET 5POST 3DELETE 3PUT 1
Main resources
Schedule 5Schedule group 4
Description format
AWS Smithy model, API version 2021-06-30

How to test the Amazon EventBridge Scheduler in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon EventBridge Scheduler collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get schedule” (GET /schedules/:Name?groupName=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon EventBridge Scheduler?

Amazon EventBridge Scheduler is a serverless scheduler that allows you to create, run, and manage tasks from one central, managed service. EventBridge… It is listed under Developer tools and has 12 endpoints.

Who publishes the Amazon EventBridge Scheduler?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon EventBridge Scheduler?

Requests go to https://scheduler.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon EventBridge Scheduler?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon EventBridge Scheduler have?

12 operations on 5 paths (5 GET, 3 POST, 3 DELETE, 1 PUT). The largest groups are Schedule, Schedule group.

Is forking the Amazon EventBridge Scheduler free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.