GetScheduleOutput

import type { GetScheduleOutput } from "https://aws-api.deno.dev/v0.4/services/scheduler.ts?docs=full";

interface GetScheduleOutput {

Arn?: string | null;

CreationDate?: Date | number | null;

Description?: string | null;

EndDate?: Date | number | null;

FlexibleTimeWindow?: FlexibleTimeWindow | null;

GroupName?: string | null;

KmsKeyArn?: string | null;

LastModificationDate?: Date | number | null;

Name?: string | null;

ScheduleExpression?: string | null;

ScheduleExpressionTimezone?: string | null;

StartDate?: Date | number | null;

State?: ScheduleState | null;

Target?: Target | null;

}

§Properties

Arn?: string | null

[src]

The Amazon Resource Name (ARN) of the schedule.

CreationDate?: Date | number | null

[src]

The time at which the schedule was created.

Description?: string | null

[src]

The description of the schedule.

EndDate?: Date | number | null

[src]

The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify. EventBridge Scheduler ignores EndDate for one-time schedules.

FlexibleTimeWindow?: FlexibleTimeWindow | null

[src]

Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.

GroupName?: string | null

[src]

The name of the schedule group associated with this schedule.

KmsKeyArn?: string | null

[src]

The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.

LastModificationDate?: Date | number | null

[src]

The time at which the schedule was last modified.

Name?: string | null

[src]

The name of the schedule.

ScheduleExpression?: string | null

[src]

The expression that defines when the schedule runs. The following formats are supported.

at expression - at(yyyy-mm-ddThh:mm:ss)
rate expression - rate(unit value)
cron expression - cron(fields)

You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month.

A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year).

For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.

ScheduleExpressionTimezone?: string | null

[src]

The timezone in which the scheduling expression is evaluated.

StartDate?: Date | number | null

[src]

The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate you specify. EventBridge Scheduler ignores StartDate for one-time schedules.

State?: ScheduleState | null

[src]

Specifies whether the schedule is enabled or disabled.

Target?: Target | null

[src]

The schedule target.