Skip to content

Delete Schedule

eventbridgescheduler_delete_schedule R Documentation

Deletes the specified schedule

Description

Deletes the specified schedule.

Usage

eventbridgescheduler_delete_schedule(ClientToken, GroupName, Name)

Arguments

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.

GroupName

The name of the schedule group associated with this schedule. If you omit this, the default schedule group is used.

Name

[required] The name of the schedule to delete.

Value

An empty list.

Request syntax

svc$delete_schedule(
  ClientToken = "string",
  GroupName = "string",
  Name = "string"
)