Deletes the specified schedule group. Deleting a schedule group results in EventBridge Scheduler deleting all schedules associated with the group.
When you delete a group, it remains in a DELETING state until all of its associated schedules are deleted.
Schedules associated with the group that are set to run while the schedule group is in the process of being deleted might continue to invoke their targets
until the schedule group and its associated schedules are deleted.
Note
This operation is eventually consistent.
Request Syntax
DELETE /schedule-groups/Name?clientToken=ClientToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- ClientToken
-
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.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9-_]+$ - Name
-
The name of the schedule group to delete.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[0-9a-zA-Z-_.]+$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
Updating or deleting the resource can cause an inconsistent state.
HTTP Status Code: 409
- InternalServerException
-
Unexpected error encountered while processing the request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The request references a resource which does not exist.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
