Skip to content

UpdateMaintenanceWindowRequest

Source code in docs_src/capo_ssm/types/update_maintenance_window_request.py
class UpdateMaintenanceWindowRequest(TypedDict, closed=True):
    window_id: "capo_ssm.types.maintenance_window_id.MaintenanceWindowId"
    """<p>The ID of the maintenance window to update.</p>"""
    name: NotRequired["capo_ssm.types.maintenance_window_name.MaintenanceWindowName"]
    """<p>The name of the maintenance window.</p>"""
    description: NotRequired[
        "capo_ssm.types.maintenance_window_description.MaintenanceWindowDescription"
    ]
    """<p>An optional description for the update request.</p>"""
    start_date: NotRequired[
        "capo_ssm.types.maintenance_window_string_date_time.MaintenanceWindowStringDateTime"
    ]
    """<p>The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. <code>StartDate</code> allows you to delay activation of the maintenance window until the specified future date.</p> <note> <p>When using a rate schedule, if you provide a start date that occurs in the past, the current date and time are used as the start date. </p> </note>"""
    end_date: NotRequired[
        "capo_ssm.types.maintenance_window_string_date_time.MaintenanceWindowStringDateTime"
    ]
    """<p>The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. <code>EndDate</code> allows you to set a date and time in the future when the maintenance window will no longer run.</p>"""
    schedule: NotRequired[
        "capo_ssm.types.maintenance_window_schedule.MaintenanceWindowSchedule"
    ]
    """<p>The schedule of the maintenance window in the form of a cron or rate expression.</p>"""
    schedule_timezone: NotRequired[
        "capo_ssm.types.maintenance_window_timezone.MaintenanceWindowTimezone"
    ]
    """<p>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 <a href="https://www.iana.org/time-zones">Time Zone Database</a> on the IANA website.</p>"""
    schedule_offset: NotRequired[
        "capo_ssm.types.maintenance_window_offset.MaintenanceWindowOffset"
    ]
    """<p>The number of days to wait after the date and time specified by a cron expression before running the maintenance window.</p> <p>For example, the following cron expression schedules a maintenance window to run the third Tuesday of every month at 11:30 PM.</p> <p> <code>cron(30 23 ? * TUE#3 *)</code> </p> <p>If the schedule offset is <code>2</code>, the maintenance window won't run until two days later.</p>"""
    duration: NotRequired[
        "capo_ssm.types.maintenance_window_duration_hours.MaintenanceWindowDurationHours"
    ]
    """<p>The duration of the maintenance window in hours.</p>"""
    cutoff: NotRequired[
        "capo_ssm.types.maintenance_window_cutoff.MaintenanceWindowCutoff"
    ]
    """<p>The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.</p>"""
    allow_unassociated_targets: NotRequired[
        "capo_ssm.types.maintenance_window_allow_unassociated_targets.MaintenanceWindowAllowUnassociatedTargets"
    ]
    """<p>Whether targets must be registered with the maintenance window before tasks can be defined for those targets.</p>"""
    enabled: NotRequired[
        "capo_ssm.types.maintenance_window_enabled.MaintenanceWindowEnabled"
    ]
    """<p>Whether the maintenance window is enabled.</p>"""
    replace: NotRequired["capo_ssm.types.boolean.Boolean"]
    """<p>If <code>True</code>, then all fields that are required by the <a>CreateMaintenanceWindow</a> operation are also required for this API request. Optional fields that aren't specified are set to null. </p>"""

allow_unassociated_targets instance-attribute

allow_unassociated_targets: NotRequired[MaintenanceWindowAllowUnassociatedTargets]

Whether targets must be registered with the maintenance window before tasks can be defined for those targets.

cutoff instance-attribute

cutoff: NotRequired[MaintenanceWindowCutoff]

The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.

description instance-attribute

description: NotRequired[MaintenanceWindowDescription]

An optional description for the update request.

duration instance-attribute

duration: NotRequired[MaintenanceWindowDurationHours]

The duration of the maintenance window in hours.

enabled instance-attribute

enabled: NotRequired[MaintenanceWindowEnabled]

Whether the maintenance window is enabled.

end_date instance-attribute

end_date: NotRequired[MaintenanceWindowStringDateTime]

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.

name instance-attribute

name: NotRequired[MaintenanceWindowName]

The name of the maintenance window.

replace instance-attribute

replace: NotRequired[Boolean]

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.

schedule instance-attribute

schedule: NotRequired[MaintenanceWindowSchedule]

The schedule of the maintenance window in the form of a cron or rate expression.

schedule_offset instance-attribute

schedule_offset: NotRequired[MaintenanceWindowOffset]

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.

schedule_timezone instance-attribute

schedule_timezone: NotRequired[MaintenanceWindowTimezone]

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.

start_date instance-attribute

start_date: NotRequired[MaintenanceWindowStringDateTime]

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.

When using a rate schedule, if you provide a start date that occurs in the past, the current date and time are used as the start date.

window_id instance-attribute

The ID of the maintenance window to update.