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 |
Retrieves the specified schedule.
Synopsis
- data GetSchedule = GetSchedule' {}
- newGetSchedule :: Text -> GetSchedule
- getSchedule_groupName :: Lens' GetSchedule (Maybe Text)
- getSchedule_name :: Lens' GetSchedule Text
- data GetScheduleResponse = GetScheduleResponse' {
- arn :: Maybe Text
- creationDate :: Maybe POSIX
- description :: Maybe Text
- endDate :: Maybe POSIX
- flexibleTimeWindow :: Maybe FlexibleTimeWindow
- groupName :: Maybe Text
- kmsKeyArn :: Maybe Text
- lastModificationDate :: Maybe POSIX
- name :: Maybe Text
- scheduleExpression :: Maybe Text
- scheduleExpressionTimezone :: Maybe Text
- startDate :: Maybe POSIX
- state :: Maybe ScheduleState
- target :: Maybe Target
- httpStatus :: Int
- newGetScheduleResponse :: Int -> GetScheduleResponse
- getScheduleResponse_arn :: Lens' GetScheduleResponse (Maybe Text)
- getScheduleResponse_creationDate :: Lens' GetScheduleResponse (Maybe UTCTime)
- getScheduleResponse_description :: Lens' GetScheduleResponse (Maybe Text)
- getScheduleResponse_endDate :: Lens' GetScheduleResponse (Maybe UTCTime)
- getScheduleResponse_flexibleTimeWindow :: Lens' GetScheduleResponse (Maybe FlexibleTimeWindow)
- getScheduleResponse_groupName :: Lens' GetScheduleResponse (Maybe Text)
- getScheduleResponse_kmsKeyArn :: Lens' GetScheduleResponse (Maybe Text)
- getScheduleResponse_lastModificationDate :: Lens' GetScheduleResponse (Maybe UTCTime)
- getScheduleResponse_name :: Lens' GetScheduleResponse (Maybe Text)
- getScheduleResponse_scheduleExpression :: Lens' GetScheduleResponse (Maybe Text)
- getScheduleResponse_scheduleExpressionTimezone :: Lens' GetScheduleResponse (Maybe Text)
- getScheduleResponse_startDate :: Lens' GetScheduleResponse (Maybe UTCTime)
- getScheduleResponse_state :: Lens' GetScheduleResponse (Maybe ScheduleState)
- getScheduleResponse_target :: Lens' GetScheduleResponse (Maybe Target)
- getScheduleResponse_httpStatus :: Lens' GetScheduleResponse Int
Creating a Request
data GetSchedule Source #
See: newGetSchedule
smart constructor.
Instances
Create a value of GetSchedule
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:
GetSchedule
, getSchedule_groupName
- The name of the schedule group associated with this schedule. If you
omit this, EventBridge Scheduler assumes that the schedule is associated
with the default group.
GetSchedule
, getSchedule_name
- The name of the schedule to retrieve.
Request Lenses
getSchedule_groupName :: Lens' GetSchedule (Maybe Text) Source #
The name of the schedule group associated with this schedule. If you omit this, EventBridge Scheduler assumes that the schedule is associated with the default group.
getSchedule_name :: Lens' GetSchedule Text Source #
The name of the schedule to retrieve.
Destructuring the Response
data GetScheduleResponse Source #
See: newGetScheduleResponse
smart constructor.
GetScheduleResponse' | |
|
Instances
newGetScheduleResponse Source #
Create a value of GetScheduleResponse
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:
GetScheduleResponse
, getScheduleResponse_arn
- The Amazon Resource Name (ARN) of the schedule.
GetScheduleResponse
, getScheduleResponse_creationDate
- The time at which the schedule was created.
$sel:description:GetScheduleResponse'
, getScheduleResponse_description
- The description of the schedule.
$sel:endDate:GetScheduleResponse'
, getScheduleResponse_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.
$sel:flexibleTimeWindow:GetScheduleResponse'
, getScheduleResponse_flexibleTimeWindow
- Allows you to configure a time window during which EventBridge Scheduler
invokes the schedule.
GetSchedule
, getScheduleResponse_groupName
- The name of the schedule group associated with this schedule.
$sel:kmsKeyArn:GetScheduleResponse'
, getScheduleResponse_kmsKeyArn
- The ARN for a customer managed KMS Key that is be used to encrypt and
decrypt your data.
GetScheduleResponse
, getScheduleResponse_lastModificationDate
- The time at which the schedule was last modified.
GetSchedule
, getScheduleResponse_name
- The name of the schedule.
$sel:scheduleExpression:GetScheduleResponse'
, getScheduleResponse_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.
$sel:scheduleExpressionTimezone:GetScheduleResponse'
, getScheduleResponse_scheduleExpressionTimezone
- The timezone in which the scheduling expression is evaluated.
$sel:startDate:GetScheduleResponse'
, getScheduleResponse_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.
GetScheduleResponse
, getScheduleResponse_state
- Specifies whether the schedule is enabled or disabled.
GetScheduleResponse
, getScheduleResponse_target
- The schedule target.
$sel:httpStatus:GetScheduleResponse'
, getScheduleResponse_httpStatus
- The response's http status code.
Response Lenses
getScheduleResponse_arn :: Lens' GetScheduleResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the schedule.
getScheduleResponse_creationDate :: Lens' GetScheduleResponse (Maybe UTCTime) Source #
The time at which the schedule was created.
getScheduleResponse_description :: Lens' GetScheduleResponse (Maybe Text) Source #
The description of the schedule.
getScheduleResponse_endDate :: Lens' GetScheduleResponse (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.
getScheduleResponse_flexibleTimeWindow :: Lens' GetScheduleResponse (Maybe FlexibleTimeWindow) Source #
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
getScheduleResponse_groupName :: Lens' GetScheduleResponse (Maybe Text) Source #
The name of the schedule group associated with this schedule.
getScheduleResponse_kmsKeyArn :: Lens' GetScheduleResponse (Maybe Text) Source #
The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.
getScheduleResponse_lastModificationDate :: Lens' GetScheduleResponse (Maybe UTCTime) Source #
The time at which the schedule was last modified.
getScheduleResponse_name :: Lens' GetScheduleResponse (Maybe Text) Source #
The name of the schedule.
getScheduleResponse_scheduleExpression :: Lens' GetScheduleResponse (Maybe 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.
getScheduleResponse_scheduleExpressionTimezone :: Lens' GetScheduleResponse (Maybe Text) Source #
The timezone in which the scheduling expression is evaluated.
getScheduleResponse_startDate :: Lens' GetScheduleResponse (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.
getScheduleResponse_state :: Lens' GetScheduleResponse (Maybe ScheduleState) Source #
Specifies whether the schedule is enabled or disabled.
getScheduleResponse_target :: Lens' GetScheduleResponse (Maybe Target) Source #
The schedule target.
getScheduleResponse_httpStatus :: Lens' GetScheduleResponse Int Source #
The response's http status code.