Skip to main content

schedule

Gets an individual schedule resource

Overview

Nameschedule
TypeResource
Descriptionschedule
Idawscc.scheduler.schedule

Fields

NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the schedule.
descriptionstringThe description of the schedule.
end_datestringThe 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.
flexible_time_windowobject
group_namestringThe name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.
kms_key_arnstringThe ARN for a KMS Key that will be used to encrypt customer data.
namestring
schedule_expressionstringThe scheduling expression.
schedule_expression_timezonestringThe timezone in which the scheduling expression is evaluated.
start_datestringThe 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.
statestring
targetobject
regionstringAWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
arn,
description,
end_date,
flexible_time_window,
group_name,
kms_key_arn,
name,
schedule_expression,
schedule_expression_timezone,
start_date,
state,
target
FROM awscc.scheduler.schedule
WHERE data__Identifier = '<Name>';

Permissions

To operate on the schedule resource, the following permissions are required:

Read

scheduler:GetSchedule

Update

scheduler:UpdateSchedule,
scheduler:GetSchedule,
iam:PassRole

Delete

scheduler:DeleteSchedule,
scheduler:GetSchedule