{ "opencollection": "1.0.0", "info": { "name": "Amazon EventBridge Scheduler Schedule Groups Schedules API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Schedules", "type": "folder" }, "items": [ { "info": { "name": "Amazon EventBridge Scheduler GetSchedule", "type": "http" }, "http": { "method": "GET", "url": "http://scheduler.{region}.amazonaws.com/schedules/:Name", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "groupName", "value": "", "type": "query", "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." }, { "name": "Name", "value": "", "type": "path", "description": "The name of the schedule to retrieve." } ] }, "docs": "Retrieves the specified schedule." }, { "info": { "name": "Amazon EventBridge Scheduler CreateSchedule", "type": "http" }, "http": { "method": "POST", "url": "http://scheduler.{region}.amazonaws.com/schedules/:Name", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "Name", "value": "", "type": "path", "description": "The name of the schedule that you are creating." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates the specified schedule." }, { "info": { "name": "Amazon EventBridge Scheduler UpdateSchedule", "type": "http" }, "http": { "method": "PUT", "url": "http://scheduler.{region}.amazonaws.com/schedules/:Name", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "Name", "value": "", "type": "path", "description": "The name of the schedule that you are updating." } ], "body": { "type": "json", "data": "{}" } }, "docs": "
Updates the specified schedule. When you call UpdateSchedule, 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.
Before calling this operation, we recommend that you call the GetSchedule API operation and make a note of all option"
},
{
"info": {
"name": "Amazon EventBridge Scheduler DeleteSchedule",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://scheduler.{region}.amazonaws.com/schedules/:Name",
"headers": [
{
"name": "X-Amz-Content-Sha256",
"value": ""
},
{
"name": "X-Amz-Date",
"value": ""
},
{
"name": "X-Amz-Algorithm",
"value": ""
},
{
"name": "X-Amz-Credential",
"value": ""
},
{
"name": "X-Amz-Security-Token",
"value": ""
},
{
"name": "X-Amz-Signature",
"value": ""
},
{
"name": "X-Amz-SignedHeaders",
"value": ""
}
],
"params": [
{
"name": "clientToken",
"value": "",
"type": "query",
"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. "
},
{
"name": "groupName",
"value": "",
"type": "query",
"description": "The name of the schedule group associated with this schedule. If you omit this, the default schedule group is used."
},
{
"name": "Name",
"value": "",
"type": "path",
"description": "The name of the schedule to delete."
}
]
},
"docs": "Deletes the specified schedule."
},
{
"info": {
"name": "Amazon EventBridge Scheduler ListSchedules",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://scheduler.{region}.amazonaws.com/schedules",
"headers": [
{
"name": "X-Amz-Content-Sha256",
"value": ""
},
{
"name": "X-Amz-Date",
"value": ""
},
{
"name": "X-Amz-Algorithm",
"value": ""
},
{
"name": "X-Amz-Credential",
"value": ""
},
{
"name": "X-Amz-Security-Token",
"value": ""
},
{
"name": "X-Amz-Signature",
"value": ""
},
{
"name": "X-Amz-SignedHeaders",
"value": ""
}
],
"params": [
{
"name": "ScheduleGroup",
"value": "",
"type": "query",
"description": "If specified, only lists the schedules whose associated schedule group matches the given filter."
},
{
"name": "MaxResults",
"value": "",
"type": "query",
"description": "If specified, limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results."
},
{
"name": "NamePrefix",
"value": "",
"type": "query",
"description": "Schedule name prefix to return the filtered list of resources."
},
{
"name": "NextToken",
"value": "",
"type": "query",
"description": "The token returned by a previous call to retrieve the next set of results."
},
{
"name": "State",
"value": "",
"type": "query",
"description": "If specified, only lists the schedules whose current state matches the given filter."
}
]
},
"docs": "Returns a paginated list of your EventBridge Scheduler schedules."
}
]
}
],
"bundled": true
}