eventbridgescheduler_create_schedule {paws.application.integration} | R Documentation |
Creates the specified schedule
Description
Creates the specified schedule.
See https://www.paws-r-sdk.com/docs/eventbridgescheduler_create_schedule/ for full documentation.
Usage
eventbridgescheduler_create_schedule(
ActionAfterCompletion = NULL,
ClientToken = NULL,
Description = NULL,
EndDate = NULL,
FlexibleTimeWindow,
GroupName = NULL,
KmsKeyArn = NULL,
Name,
ScheduleExpression,
ScheduleExpressionTimezone = NULL,
StartDate = NULL,
State = NULL,
Target
)
Arguments
ActionAfterCompletion |
Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target. |
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. |
Description |
The description you specify for the schedule. |
EndDate |
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 |
FlexibleTimeWindow |
[required] Allows you to configure a time window during which EventBridge Scheduler invokes the schedule. |
GroupName |
The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used. |
KmsKeyArn |
The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data. |
Name |
[required] The name of the schedule that you are creating. |
ScheduleExpression |
[required] The expression that defines when the schedule runs. The following formats are supported.
You can use A A For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide. |
ScheduleExpressionTimezone |
The timezone in which the scheduling expression is evaluated. |
StartDate |
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 |
State |
Specifies whether the schedule is enabled or disabled. |
Target |
[required] The schedule's target. |