SSM / Paginator / DescribeMaintenanceWindows
DescribeMaintenanceWindows#
- class SSM.Paginator.DescribeMaintenanceWindows#
paginator = client.get_paginator('describe_maintenance_windows')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
SSM.Client.describe_maintenance_windows()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( Filters=[ { 'Key': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
Filters (list) –
Optional filters used to narrow down the scope of the returned maintenance windows. Supported filter keys are
Name
andEnabled
. For example,Name=MyMaintenanceWindow
andEnabled=True
.(dict) –
Filter used in the request. Supported filter keys depend on the API operation that includes the filter. API operations that use
MaintenanceWindowFilter>
include the following:DescribeMaintenanceWindowExecutions
DescribeMaintenanceWindowExecutionTaskInvocations
DescribeMaintenanceWindowExecutionTasks
DescribeMaintenanceWindows
DescribeMaintenanceWindowTargets
DescribeMaintenanceWindowTasks
Key (string) –
The name of the filter.
Values (list) –
The filter values.
(string) –
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'WindowIdentities': [ { 'WindowId': 'string', 'Name': 'string', 'Description': 'string', 'Enabled': True|False, 'Duration': 123, 'Cutoff': 123, 'Schedule': 'string', 'ScheduleTimezone': 'string', 'ScheduleOffset': 123, 'EndDate': 'string', 'StartDate': 'string', 'NextExecutionTime': 'string' }, ], }
Response Structure
(dict) –
WindowIdentities (list) –
Information about the maintenance windows.
(dict) –
Information about the maintenance window.
WindowId (string) –
The ID of the maintenance window.
Name (string) –
The name of the maintenance window.
Description (string) –
A description of the maintenance window.
Enabled (boolean) –
Indicates whether the maintenance window is enabled.
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.
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.
ScheduleOffset (integer) –
The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
EndDate (string) –
The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.
StartDate (string) –
The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active.
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.