EventBridgeScheduler / Client / delete_schedule_group

delete_schedule_group#

EventBridgeScheduler.Client.delete_schedule_group(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_schedule_group(
    ClientToken='string',
    Name='string'
)
Parameters:

  • ClientToken (string) –

    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.

    This field is autopopulated if not provided.

  • Name (string) –

    [REQUIRED]

    The name of the schedule group to delete.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • EventBridgeScheduler.Client.exceptions.ValidationException

  • EventBridgeScheduler.Client.exceptions.InternalServerException

  • EventBridgeScheduler.Client.exceptions.ConflictException

  • EventBridgeScheduler.Client.exceptions.ResourceNotFoundException

  • EventBridgeScheduler.Client.exceptions.ThrottlingException