Skip to content

GetMaintenanceWindowResult

Source code in docs_src/capo_ssm/types/get_maintenance_window_result.py
class GetMaintenanceWindowResult(TypedDict, closed=True):
    window_id: NotRequired["capo_ssm.types.maintenance_window_id.MaintenanceWindowId"]
    """<p>The ID of the created maintenance window.</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>The description of the maintenance window.</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 the maintenance window is scheduled to become active. The maintenance window won't run before this specified time.</p>"""
    end_date: NotRequired[
        "capo_ssm.types.maintenance_window_string_date_time.MaintenanceWindowStringDateTime"
    ]
    """<p>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.</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 to run a maintenance window after the scheduled cron expression date and time.</p>"""
    next_execution_time: NotRequired[
        "capo_ssm.types.maintenance_window_string_date_time.MaintenanceWindowStringDateTime"
    ]
    """<p>The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.</p>"""
    duration: NotRequired[
        "capo_ssm.types.maintenance_window_duration_hours.MaintenanceWindowDurationHours"
    ]
    """<p>The duration of the maintenance window in hours.</p>"""
    cutoff: "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: "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: "capo_ssm.types.maintenance_window_enabled.MaintenanceWindowEnabled"
    """<p>Indicates whether the maintenance window is enabled.</p>"""
    created_date: NotRequired["capo_ssm.types.date_time.DateTime"]
    """<p>The date the maintenance window was created.</p>"""
    modified_date: NotRequired["capo_ssm.types.date_time.DateTime"]
    """<p>The date the maintenance window was last modified.</p>"""

allow_unassociated_targets instance-attribute

allow_unassociated_targets: MaintenanceWindowAllowUnassociatedTargets

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

created_date instance-attribute

created_date: NotRequired[DateTime]

The date the maintenance window was created.

cutoff instance-attribute

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]

The description of the maintenance window.

duration instance-attribute

duration: NotRequired[MaintenanceWindowDurationHours]

The duration of the maintenance window in hours.

enabled instance-attribute

Indicates 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 the maintenance window is scheduled to become inactive. The maintenance window won't run after this specified time.

modified_date instance-attribute

modified_date: NotRequired[DateTime]

The date the maintenance window was last modified.

name instance-attribute

name: NotRequired[MaintenanceWindowName]

The name of the maintenance window.

next_execution_time instance-attribute

next_execution_time: NotRequired[MaintenanceWindowStringDateTime]

The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.

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 to run a maintenance window after the scheduled cron expression date and time.

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 the maintenance window is scheduled to become active. The maintenance window won't run before this specified time.

window_id instance-attribute

window_id: NotRequired[MaintenanceWindowId]

The ID of the created maintenance window.