EventBridgeScheduler / Client / delete_schedule

delete_schedule#

EventBridgeScheduler.Client.delete_schedule(**kwargs)#

Deletes the specified schedule.

See also: AWS API Documentation

Request Syntax

response = client.delete_schedule(
    ClientToken='string',
    GroupName='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.

  • GroupName (string) – The name of the schedule group associated with this schedule. If you omit this, the default schedule group is used.

  • Name (string) –

    [REQUIRED]

    The name of the schedule to delete.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions