get_maintenance_window

get_maintenance_window(**kwargs)

Retrieves a maintenance window.

See also: AWS API Documentation

Request Syntax

response = client.get_maintenance_window(
    WindowId='string'
)

Parameters

WindowId (string) --

[REQUIRED]

The ID of the maintenance window for which you want to retrieve information.

Return type

dict

Returns

Response Syntax

{
    'WindowId': 'string',
    'Name': 'string',
    'Description': 'string',
    'StartDate': 'string',
    'EndDate': 'string',
    'Schedule': 'string',
    'ScheduleTimezone': 'string',
    'ScheduleOffset': 123,
    'NextExecutionTime': 'string',
    'Duration': 123,
    'Cutoff': 123,
    'AllowUnassociatedTargets': True|False,
    'Enabled': True|False,
    'CreatedDate': datetime(2015, 1, 1),
    'ModifiedDate': datetime(2015, 1, 1)
}

Response Structure

• (dict) --
  • WindowId (string) --

    The ID of the created maintenance window.

  • Name (string) --

    The name of the maintenance window.

  • Description (string) --

    The description of the maintenance window.

  • StartDate (string) --

    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.

  • EndDate (string) --

    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.

  • Schedule (string) --

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

  • ScheduleTimezone (string) --

    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.

  • ScheduleOffset (integer) --

    The number of days to wait to run a maintenance window after the scheduled cron expression date and time.

  • NextExecutionTime (string) --

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

  • Duration (integer) --

    The duration of the maintenance window in hours.

  • Cutoff (integer) --

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

  • AllowUnassociatedTargets (boolean) --

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

  • Enabled (boolean) --

    Indicates whether the maintenance window is enabled.

  • CreatedDate (datetime) --

    The date the maintenance window was created.

  • ModifiedDate (datetime) --

    The date the maintenance window was last modified.

Exceptions

• SSM.Client.exceptions.DoesNotExistException
• SSM.Client.exceptions.InternalServerError