Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Scheduler

import { Scheduler } from "https://aws-api.deno.dev/v0.4/services/scheduler.ts?docs=full";
class Scheduler {
constructor(apiFactory: client.ApiFactory);
async createSchedule(params: CreateScheduleInput, opts?: client.RequestOptions): Promise<CreateScheduleOutput>;
async createScheduleGroup(params: CreateScheduleGroupInput, opts?: client.RequestOptions): Promise<CreateScheduleGroupOutput>;
async deleteSchedule(params: DeleteScheduleInput, opts?: client.RequestOptions): Promise<void>;
async deleteScheduleGroup(params: DeleteScheduleGroupInput, opts?: client.RequestOptions): Promise<void>;
async getSchedule(params: GetScheduleInput, opts?: client.RequestOptions): Promise<GetScheduleOutput>;
async getScheduleGroup(params: GetScheduleGroupInput, opts?: client.RequestOptions): Promise<GetScheduleGroupOutput>;
async listScheduleGroups(params?: ListScheduleGroupsInput, opts?: client.RequestOptions): Promise<ListScheduleGroupsOutput>;
async listSchedules(params?: ListSchedulesInput, opts?: client.RequestOptions): Promise<ListSchedulesOutput>;
async listTagsForResource(params: ListTagsForResourceInput, opts?: client.RequestOptions): Promise<ListTagsForResourceOutput>;
async tagResource(params: TagResourceInput, opts?: client.RequestOptions): Promise<void>;
async untagResource(params: UntagResourceInput, opts?: client.RequestOptions): Promise<void>;
async updateSchedule(params: UpdateScheduleInput, opts?: client.RequestOptions): Promise<UpdateScheduleOutput>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new Scheduler(apiFactory: client.ApiFactory)
[src]

§Methods

§
createSchedule(params: CreateScheduleInput, opts?: client.RequestOptions): Promise<CreateScheduleOutput>
[src]

Creates the specified schedule.

§
createScheduleGroup(params: CreateScheduleGroupInput, opts?: client.RequestOptions): Promise<CreateScheduleGroupOutput>
[src]

Creates the specified schedule group.

§
deleteSchedule(params: DeleteScheduleInput, opts?: client.RequestOptions): Promise<void>
[src]

Deletes the specified schedule.

§
deleteScheduleGroup(params: DeleteScheduleGroupInput, opts?: client.RequestOptions): Promise<void>
[src]

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.

§
getSchedule(params: GetScheduleInput, opts?: client.RequestOptions): Promise<GetScheduleOutput>
[src]

Retrieves the specified schedule.

§
getScheduleGroup(params: GetScheduleGroupInput, opts?: client.RequestOptions): Promise<GetScheduleGroupOutput>
[src]

Retrieves the specified schedule group.

§
listScheduleGroups(params?: ListScheduleGroupsInput, opts?: client.RequestOptions): Promise<ListScheduleGroupsOutput>
[src]

Returns a paginated list of your schedule groups.

§
listSchedules(params?: ListSchedulesInput, opts?: client.RequestOptions): Promise<ListSchedulesOutput>
[src]

Returns a paginated list of your EventBridge Scheduler schedules.

§
listTagsForResource(params: ListTagsForResourceInput, opts?: client.RequestOptions): Promise<ListTagsForResourceOutput>
[src]

Lists the tags associated with the Scheduler resource.

§
tagResource(params: TagResourceInput, opts?: client.RequestOptions): Promise<void>
[src]

Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource. You can only assign tags to schedule groups.

§
untagResource(params: UntagResourceInput, opts?: client.RequestOptions): Promise<void>
[src]

Removes one or more tags from the specified EventBridge Scheduler schedule group.

§
updateSchedule(params: UpdateScheduleInput, opts?: client.RequestOptions): Promise<UpdateScheduleOutput>
[src]

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 optional parameters for your UpdateSchedule call.

§Static Properties