Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
Synopsis
- data UpdateSchedule = UpdateSchedule' {
- clientToken :: Maybe Text
- description :: Maybe Text
- endDate :: Maybe POSIX
- groupName :: Maybe Text
- kmsKeyArn :: Maybe Text
- scheduleExpressionTimezone :: Maybe Text
- startDate :: Maybe POSIX
- state :: Maybe ScheduleState
- flexibleTimeWindow :: FlexibleTimeWindow
- name :: Text
- scheduleExpression :: Text
- target :: Target
- newUpdateSchedule :: FlexibleTimeWindow -> Text -> Text -> Target -> UpdateSchedule
- updateSchedule_clientToken :: Lens' UpdateSchedule (Maybe Text)
- updateSchedule_description :: Lens' UpdateSchedule (Maybe Text)
- updateSchedule_endDate :: Lens' UpdateSchedule (Maybe UTCTime)
- updateSchedule_groupName :: Lens' UpdateSchedule (Maybe Text)
- updateSchedule_kmsKeyArn :: Lens' UpdateSchedule (Maybe Text)
- updateSchedule_scheduleExpressionTimezone :: Lens' UpdateSchedule (Maybe Text)
- updateSchedule_startDate :: Lens' UpdateSchedule (Maybe UTCTime)
- updateSchedule_state :: Lens' UpdateSchedule (Maybe ScheduleState)
- updateSchedule_flexibleTimeWindow :: Lens' UpdateSchedule FlexibleTimeWindow
- updateSchedule_name :: Lens' UpdateSchedule Text
- updateSchedule_scheduleExpression :: Lens' UpdateSchedule Text
- updateSchedule_target :: Lens' UpdateSchedule Target
- data UpdateScheduleResponse = UpdateScheduleResponse' {
- httpStatus :: Int
- scheduleArn :: Text
- newUpdateScheduleResponse :: Int -> Text -> UpdateScheduleResponse
- updateScheduleResponse_httpStatus :: Lens' UpdateScheduleResponse Int
- updateScheduleResponse_scheduleArn :: Lens' UpdateScheduleResponse Text
Creating a Request
data UpdateSchedule Source #
See: newUpdateSchedule
smart constructor.
UpdateSchedule' | |
|
Instances
:: FlexibleTimeWindow | |
-> Text | |
-> Text | |
-> Target | |
-> UpdateSchedule |
Create a value of UpdateSchedule
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:UpdateSchedule'
, updateSchedule_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.
$sel:description:UpdateSchedule'
, updateSchedule_description
- The description you specify for the schedule.
$sel:endDate:UpdateSchedule'
, updateSchedule_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 EndDate
you specify. EventBridge Scheduler
ignores EndDate
for one-time schedules.
UpdateSchedule
, updateSchedule_groupName
- The name of the schedule group with which the schedule is associated.
You must provide this value in order for EventBridge Scheduler to find
the schedule you want to update. If you omit this value, EventBridge
Scheduler assumes the group is associated to the default group.
$sel:kmsKeyArn:UpdateSchedule'
, updateSchedule_kmsKeyArn
- The ARN for the customer managed KMS key that that you want EventBridge
Scheduler to use to encrypt and decrypt your data.
$sel:scheduleExpressionTimezone:UpdateSchedule'
, updateSchedule_scheduleExpressionTimezone
- The timezone in which the scheduling expression is evaluated.
$sel:startDate:UpdateSchedule'
, updateSchedule_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 StartDate
you specify. EventBridge
Scheduler ignores StartDate
for one-time schedules.
UpdateSchedule
, updateSchedule_state
- Specifies whether the schedule is enabled or disabled.
$sel:flexibleTimeWindow:UpdateSchedule'
, updateSchedule_flexibleTimeWindow
- Allows you to configure a time window during which EventBridge Scheduler
invokes the schedule.
UpdateSchedule
, updateSchedule_name
- The name of the schedule that you are updating.
$sel:scheduleExpression:UpdateSchedule'
, updateSchedule_scheduleExpression
- 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)
.
A rate
expression consists of a value as a positive integer, and a
unit with the following options: minute
| minutes
| hour
|
hours
| day
| days
For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.
UpdateSchedule
, updateSchedule_target
- The schedule target. You can use this operation to change the target
that your schedule invokes.
Request Lenses
updateSchedule_clientToken :: Lens' UpdateSchedule (Maybe Text) Source #
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.
updateSchedule_description :: Lens' UpdateSchedule (Maybe Text) Source #
The description you specify for the schedule.
updateSchedule_endDate :: Lens' UpdateSchedule (Maybe UTCTime) Source #
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.
updateSchedule_groupName :: Lens' UpdateSchedule (Maybe Text) Source #
The name of the schedule group with which the schedule is associated. You must provide this value in order for EventBridge Scheduler to find the schedule you want to update. If you omit this value, EventBridge Scheduler assumes the group is associated to the default group.
updateSchedule_kmsKeyArn :: Lens' UpdateSchedule (Maybe Text) Source #
The ARN for the customer managed KMS key that that you want EventBridge Scheduler to use to encrypt and decrypt your data.
updateSchedule_scheduleExpressionTimezone :: Lens' UpdateSchedule (Maybe Text) Source #
The timezone in which the scheduling expression is evaluated.
updateSchedule_startDate :: Lens' UpdateSchedule (Maybe UTCTime) Source #
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.
updateSchedule_state :: Lens' UpdateSchedule (Maybe ScheduleState) Source #
Specifies whether the schedule is enabled or disabled.
updateSchedule_flexibleTimeWindow :: Lens' UpdateSchedule FlexibleTimeWindow Source #
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
updateSchedule_name :: Lens' UpdateSchedule Text Source #
The name of the schedule that you are updating.
updateSchedule_scheduleExpression :: Lens' UpdateSchedule Text Source #
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)
.
A rate
expression consists of a value as a positive integer, and a
unit with the following options: minute
| minutes
| hour
|
hours
| day
| days
For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.
updateSchedule_target :: Lens' UpdateSchedule Target Source #
The schedule target. You can use this operation to change the target that your schedule invokes.
Destructuring the Response
data UpdateScheduleResponse Source #
See: newUpdateScheduleResponse
smart constructor.
UpdateScheduleResponse' | |
|
Instances
newUpdateScheduleResponse Source #
:: Int | |
-> Text | |
-> UpdateScheduleResponse |
Create a value of UpdateScheduleResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateScheduleResponse'
, updateScheduleResponse_httpStatus
- The response's http status code.
$sel:scheduleArn:UpdateScheduleResponse'
, updateScheduleResponse_scheduleArn
- The Amazon Resource Name (ARN) of the schedule that you updated.
Response Lenses
updateScheduleResponse_httpStatus :: Lens' UpdateScheduleResponse Int Source #
The response's http status code.
updateScheduleResponse_scheduleArn :: Lens' UpdateScheduleResponse Text Source #
The Amazon Resource Name (ARN) of the schedule that you updated.