Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Updates an existing maintenance window. Only specified parameters are modified.
The value you specify for Duration
determines the specific end time
for the maintenance window based on the time it begins. No maintenance
window tasks are permitted to start after the resulting endtime minus
the number of hours you specify for Cutoff
. For example, if the
maintenance window starts at 3 PM, the duration is three hours, and the
value you specify for Cutoff
is one hour, no maintenance window tasks
can start after 5 PM.
Synopsis
- data UpdateMaintenanceWindow = UpdateMaintenanceWindow' {
- replace :: Maybe Bool
- enabled :: Maybe Bool
- schedule :: Maybe Text
- scheduleOffset :: Maybe Natural
- endDate :: Maybe Text
- scheduleTimezone :: Maybe Text
- startDate :: Maybe Text
- name :: Maybe Text
- cutoff :: Maybe Natural
- allowUnassociatedTargets :: Maybe Bool
- description :: Maybe (Sensitive Text)
- duration :: Maybe Natural
- windowId :: Text
- newUpdateMaintenanceWindow :: Text -> UpdateMaintenanceWindow
- updateMaintenanceWindow_replace :: Lens' UpdateMaintenanceWindow (Maybe Bool)
- updateMaintenanceWindow_enabled :: Lens' UpdateMaintenanceWindow (Maybe Bool)
- updateMaintenanceWindow_schedule :: Lens' UpdateMaintenanceWindow (Maybe Text)
- updateMaintenanceWindow_scheduleOffset :: Lens' UpdateMaintenanceWindow (Maybe Natural)
- updateMaintenanceWindow_endDate :: Lens' UpdateMaintenanceWindow (Maybe Text)
- updateMaintenanceWindow_scheduleTimezone :: Lens' UpdateMaintenanceWindow (Maybe Text)
- updateMaintenanceWindow_startDate :: Lens' UpdateMaintenanceWindow (Maybe Text)
- updateMaintenanceWindow_name :: Lens' UpdateMaintenanceWindow (Maybe Text)
- updateMaintenanceWindow_cutoff :: Lens' UpdateMaintenanceWindow (Maybe Natural)
- updateMaintenanceWindow_allowUnassociatedTargets :: Lens' UpdateMaintenanceWindow (Maybe Bool)
- updateMaintenanceWindow_description :: Lens' UpdateMaintenanceWindow (Maybe Text)
- updateMaintenanceWindow_duration :: Lens' UpdateMaintenanceWindow (Maybe Natural)
- updateMaintenanceWindow_windowId :: Lens' UpdateMaintenanceWindow Text
- data UpdateMaintenanceWindowResponse = UpdateMaintenanceWindowResponse' {
- enabled :: Maybe Bool
- schedule :: Maybe Text
- scheduleOffset :: Maybe Natural
- endDate :: Maybe Text
- scheduleTimezone :: Maybe Text
- startDate :: Maybe Text
- name :: Maybe Text
- cutoff :: Maybe Natural
- allowUnassociatedTargets :: Maybe Bool
- description :: Maybe (Sensitive Text)
- duration :: Maybe Natural
- windowId :: Maybe Text
- httpStatus :: Int
- newUpdateMaintenanceWindowResponse :: Int -> UpdateMaintenanceWindowResponse
- updateMaintenanceWindowResponse_enabled :: Lens' UpdateMaintenanceWindowResponse (Maybe Bool)
- updateMaintenanceWindowResponse_schedule :: Lens' UpdateMaintenanceWindowResponse (Maybe Text)
- updateMaintenanceWindowResponse_scheduleOffset :: Lens' UpdateMaintenanceWindowResponse (Maybe Natural)
- updateMaintenanceWindowResponse_endDate :: Lens' UpdateMaintenanceWindowResponse (Maybe Text)
- updateMaintenanceWindowResponse_scheduleTimezone :: Lens' UpdateMaintenanceWindowResponse (Maybe Text)
- updateMaintenanceWindowResponse_startDate :: Lens' UpdateMaintenanceWindowResponse (Maybe Text)
- updateMaintenanceWindowResponse_name :: Lens' UpdateMaintenanceWindowResponse (Maybe Text)
- updateMaintenanceWindowResponse_cutoff :: Lens' UpdateMaintenanceWindowResponse (Maybe Natural)
- updateMaintenanceWindowResponse_allowUnassociatedTargets :: Lens' UpdateMaintenanceWindowResponse (Maybe Bool)
- updateMaintenanceWindowResponse_description :: Lens' UpdateMaintenanceWindowResponse (Maybe Text)
- updateMaintenanceWindowResponse_duration :: Lens' UpdateMaintenanceWindowResponse (Maybe Natural)
- updateMaintenanceWindowResponse_windowId :: Lens' UpdateMaintenanceWindowResponse (Maybe Text)
- updateMaintenanceWindowResponse_httpStatus :: Lens' UpdateMaintenanceWindowResponse Int
Creating a Request
data UpdateMaintenanceWindow Source #
See: newUpdateMaintenanceWindow
smart constructor.
UpdateMaintenanceWindow' | |
|
Instances
newUpdateMaintenanceWindow Source #
Create a value of UpdateMaintenanceWindow
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:replace:UpdateMaintenanceWindow'
, updateMaintenanceWindow_replace
- If True
, then all fields that are required by the
CreateMaintenanceWindow operation are also required for this API
request. Optional fields that aren't specified are set to null.
$sel:enabled:UpdateMaintenanceWindow'
, updateMaintenanceWindow_enabled
- Whether the maintenance window is enabled.
$sel:schedule:UpdateMaintenanceWindow'
, updateMaintenanceWindow_schedule
- The schedule of the maintenance window in the form of a cron or rate
expression.
$sel:scheduleOffset:UpdateMaintenanceWindow'
, updateMaintenanceWindow_scheduleOffset
- The number of days to wait after the date and time specified by a cron
expression before running the maintenance window.
For example, the following cron expression schedules a maintenance window to run the third Tuesday of every month at 11:30 PM.
cron(30 23 ? * TUE#3 *)
If the schedule offset is 2
, the maintenance window won't run until
two days later.
$sel:endDate:UpdateMaintenanceWindow'
, updateMaintenanceWindow_endDate
- The date and time, in ISO-8601 Extended format, for when you want the
maintenance window to become inactive. EndDate
allows you to set a
date and time in the future when the maintenance window will no longer
run.
$sel:scheduleTimezone:UpdateMaintenanceWindow'
, updateMaintenanceWindow_scheduleTimezone
- The time zone that the scheduled maintenance window executions are based
on, in Internet Assigned Numbers Authority (IANA) format. For example:
"America/Los_Angeles", "UTC", or "Asia/Seoul". For more
information, see the
Time Zone Database on the IANA
website.
$sel:startDate:UpdateMaintenanceWindow'
, updateMaintenanceWindow_startDate
- The time zone that the scheduled maintenance window executions are based
on, in Internet Assigned Numbers Authority (IANA) format. For example:
"America/Los_Angeles", "UTC", or "Asia/Seoul". For more
information, see the
Time Zone Database on the IANA
website.
$sel:name:UpdateMaintenanceWindow'
, updateMaintenanceWindow_name
- The name of the maintenance window.
$sel:cutoff:UpdateMaintenanceWindow'
, updateMaintenanceWindow_cutoff
- The number of hours before the end of the maintenance window that Amazon
Web Services Systems Manager stops scheduling new tasks for execution.
$sel:allowUnassociatedTargets:UpdateMaintenanceWindow'
, updateMaintenanceWindow_allowUnassociatedTargets
- Whether targets must be registered with the maintenance window before
tasks can be defined for those targets.
$sel:description:UpdateMaintenanceWindow'
, updateMaintenanceWindow_description
- An optional description for the update request.
$sel:duration:UpdateMaintenanceWindow'
, updateMaintenanceWindow_duration
- The duration of the maintenance window in hours.
$sel:windowId:UpdateMaintenanceWindow'
, updateMaintenanceWindow_windowId
- The ID of the maintenance window to update.
Request Lenses
updateMaintenanceWindow_replace :: Lens' UpdateMaintenanceWindow (Maybe Bool) Source #
If True
, then all fields that are required by the
CreateMaintenanceWindow operation are also required for this API
request. Optional fields that aren't specified are set to null.
updateMaintenanceWindow_enabled :: Lens' UpdateMaintenanceWindow (Maybe Bool) Source #
Whether the maintenance window is enabled.
updateMaintenanceWindow_schedule :: Lens' UpdateMaintenanceWindow (Maybe Text) Source #
The schedule of the maintenance window in the form of a cron or rate expression.
updateMaintenanceWindow_scheduleOffset :: Lens' UpdateMaintenanceWindow (Maybe Natural) Source #
The number of days to wait after the date and time specified by a cron expression before running the maintenance window.
For example, the following cron expression schedules a maintenance window to run the third Tuesday of every month at 11:30 PM.
cron(30 23 ? * TUE#3 *)
If the schedule offset is 2
, the maintenance window won't run until
two days later.
updateMaintenanceWindow_endDate :: Lens' UpdateMaintenanceWindow (Maybe Text) Source #
The date and time, in ISO-8601 Extended format, for when you want the
maintenance window to become inactive. EndDate
allows you to set a
date and time in the future when the maintenance window will no longer
run.
updateMaintenanceWindow_scheduleTimezone :: Lens' UpdateMaintenanceWindow (Maybe Text) Source #
The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.
updateMaintenanceWindow_startDate :: Lens' UpdateMaintenanceWindow (Maybe Text) Source #
The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.
updateMaintenanceWindow_name :: Lens' UpdateMaintenanceWindow (Maybe Text) Source #
The name of the maintenance window.
updateMaintenanceWindow_cutoff :: Lens' UpdateMaintenanceWindow (Maybe Natural) Source #
The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
updateMaintenanceWindow_allowUnassociatedTargets :: Lens' UpdateMaintenanceWindow (Maybe Bool) Source #
Whether targets must be registered with the maintenance window before tasks can be defined for those targets.
updateMaintenanceWindow_description :: Lens' UpdateMaintenanceWindow (Maybe Text) Source #
An optional description for the update request.
updateMaintenanceWindow_duration :: Lens' UpdateMaintenanceWindow (Maybe Natural) Source #
The duration of the maintenance window in hours.
updateMaintenanceWindow_windowId :: Lens' UpdateMaintenanceWindow Text Source #
The ID of the maintenance window to update.
Destructuring the Response
data UpdateMaintenanceWindowResponse Source #
See: newUpdateMaintenanceWindowResponse
smart constructor.
UpdateMaintenanceWindowResponse' | |
|
Instances
newUpdateMaintenanceWindowResponse Source #
Create a value of UpdateMaintenanceWindowResponse
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:enabled:UpdateMaintenanceWindow'
, updateMaintenanceWindowResponse_enabled
- Whether the maintenance window is enabled.
$sel:schedule:UpdateMaintenanceWindow'
, updateMaintenanceWindowResponse_schedule
- The schedule of the maintenance window in the form of a cron or rate
expression.
$sel:scheduleOffset:UpdateMaintenanceWindow'
, updateMaintenanceWindowResponse_scheduleOffset
- The number of days to wait to run a maintenance window after the
scheduled cron expression date and time.
$sel:endDate:UpdateMaintenanceWindow'
, updateMaintenanceWindowResponse_endDate
- The date and time, in ISO-8601 Extended format, for when the maintenance
window is scheduled to become inactive. The maintenance window won't
run after this specified time.
$sel:scheduleTimezone:UpdateMaintenanceWindow'
, updateMaintenanceWindowResponse_scheduleTimezone
- The time zone that the scheduled maintenance window executions are based
on, in Internet Assigned Numbers Authority (IANA) format. For example:
"America/Los_Angeles", "UTC", or "Asia/Seoul". For more
information, see the
Time Zone Database on the IANA
website.
$sel:startDate:UpdateMaintenanceWindow'
, updateMaintenanceWindowResponse_startDate
- The date and time, in ISO-8601 Extended format, for when the maintenance
window is scheduled to become active. The maintenance window won't run
before this specified time.
$sel:name:UpdateMaintenanceWindow'
, updateMaintenanceWindowResponse_name
- The name of the maintenance window.
$sel:cutoff:UpdateMaintenanceWindow'
, updateMaintenanceWindowResponse_cutoff
- The number of hours before the end of the maintenance window that Amazon
Web Services Systems Manager stops scheduling new tasks for execution.
$sel:allowUnassociatedTargets:UpdateMaintenanceWindow'
, updateMaintenanceWindowResponse_allowUnassociatedTargets
- Whether targets must be registered with the maintenance window before
tasks can be defined for those targets.
$sel:description:UpdateMaintenanceWindow'
, updateMaintenanceWindowResponse_description
- An optional description of the update.
$sel:duration:UpdateMaintenanceWindow'
, updateMaintenanceWindowResponse_duration
- The duration of the maintenance window in hours.
$sel:windowId:UpdateMaintenanceWindow'
, updateMaintenanceWindowResponse_windowId
- The ID of the created maintenance window.
$sel:httpStatus:UpdateMaintenanceWindowResponse'
, updateMaintenanceWindowResponse_httpStatus
- The response's http status code.
Response Lenses
updateMaintenanceWindowResponse_enabled :: Lens' UpdateMaintenanceWindowResponse (Maybe Bool) Source #
Whether the maintenance window is enabled.
updateMaintenanceWindowResponse_schedule :: Lens' UpdateMaintenanceWindowResponse (Maybe Text) Source #
The schedule of the maintenance window in the form of a cron or rate expression.
updateMaintenanceWindowResponse_scheduleOffset :: Lens' UpdateMaintenanceWindowResponse (Maybe Natural) Source #
The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
updateMaintenanceWindowResponse_endDate :: Lens' UpdateMaintenanceWindowResponse (Maybe Text) Source #
The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. The maintenance window won't run after this specified time.
updateMaintenanceWindowResponse_scheduleTimezone :: Lens' UpdateMaintenanceWindowResponse (Maybe Text) Source #
The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.
updateMaintenanceWindowResponse_startDate :: Lens' UpdateMaintenanceWindowResponse (Maybe Text) Source #
The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. The maintenance window won't run before this specified time.
updateMaintenanceWindowResponse_name :: Lens' UpdateMaintenanceWindowResponse (Maybe Text) Source #
The name of the maintenance window.
updateMaintenanceWindowResponse_cutoff :: Lens' UpdateMaintenanceWindowResponse (Maybe Natural) Source #
The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
updateMaintenanceWindowResponse_allowUnassociatedTargets :: Lens' UpdateMaintenanceWindowResponse (Maybe Bool) Source #
Whether targets must be registered with the maintenance window before tasks can be defined for those targets.
updateMaintenanceWindowResponse_description :: Lens' UpdateMaintenanceWindowResponse (Maybe Text) Source #
An optional description of the update.
updateMaintenanceWindowResponse_duration :: Lens' UpdateMaintenanceWindowResponse (Maybe Natural) Source #
The duration of the maintenance window in hours.
updateMaintenanceWindowResponse_windowId :: Lens' UpdateMaintenanceWindowResponse (Maybe Text) Source #
The ID of the created maintenance window.
updateMaintenanceWindowResponse_httpStatus :: Lens' UpdateMaintenanceWindowResponse Int Source #
The response's http status code.