DescribeMaintenanceWindowExecutions

class SSM.Paginator.DescribeMaintenanceWindowExecutions

paginator = client.get_paginator('describe_maintenance_window_executions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SSM.Client.describe_maintenance_window_executions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    WindowId='string',
    Filters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

• WindowId (string) --

  [REQUIRED]

  The ID of the maintenance window whose executions should be retrieved.

• Filters (list) --

  Each entry in the array is a structure containing:

  • Key. A string between 1 and 128 characters. Supported keys include ExecutedBefore and ExecutedAfter .
  • Values. An array of strings, each between 1 and 256 characters. Supported values are date/time strings in a valid ISO 8601 date/time format, such as 2021-11-04T05:00:00Z .
  • (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

{
    'WindowExecutions': [
        {
            'WindowId': 'string',
            'WindowExecutionId': 'string',
            'Status': 'PENDING'|'IN_PROGRESS'|'SUCCESS'|'FAILED'|'TIMED_OUT'|'CANCELLING'|'CANCELLED'|'SKIPPED_OVERLAPPING',
            'StatusDetails': 'string',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) --

  • WindowExecutions (list) --

    Information about the maintenance window executions.

    • (dict) --

      Describes the information about an execution of a maintenance window.

      • WindowId (string) --

        The ID of the maintenance window.

      • WindowExecutionId (string) --

        The ID of the maintenance window execution.

      • Status (string) --

        The status of the execution.

      • StatusDetails (string) --

        The details explaining the status. Not available for all status values.

      • StartTime (datetime) --

        The time the execution started.

      • EndTime (datetime) --

        The time the execution finished.