DescribeMaintenanceWindowExecutionTasks¶

class SSM.Paginator.DescribeMaintenanceWindowExecutionTasks¶

paginator = client.get_paginator('describe_maintenance_window_execution_tasks')

paginate(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

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

Parameters

WindowExecutionId (string) --
[REQUIRED]

The ID of the maintenance window execution whose task executions should be retrieved.
Filters (list) --
Optional filters used to scope down the returned tasks. The supported filter key is STATUS with the corresponding values PENDING , IN_PROGRESS , SUCCESS , FAILED , TIMED_OUT , CANCELLING , and CANCELLED .
- (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

{
    'WindowExecutionTaskIdentities': [
        {
            'WindowExecutionId': 'string',
            'TaskExecutionId': '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),
            'TaskArn': 'string',
            'TaskType': 'RUN_COMMAND'|'AUTOMATION'|'STEP_FUNCTIONS'|'LAMBDA',
            'AlarmConfiguration': {
                'IgnorePollAlarmFailure': True|False,
                'Alarms': [
                    {
                        'Name': 'string'
                    },
                ]
            },
            'TriggeredAlarms': [
                {
                    'Name': 'string',
                    'State': 'UNKNOWN'|'ALARM'
                },
            ]
        },
    ],

}

Response Structure

(dict) --
- WindowExecutionTaskIdentities (list) --
  
  Information about the task executions.
  - (dict) --
    
    Information about a task execution performed as part of a maintenance window execution.
    - WindowExecutionId (string) --
      
      The ID of the maintenance window execution that ran the task.
    - TaskExecutionId (string) --
      
      The ID of the specific task execution in the maintenance window execution.
    - Status (string) --
      
      The status of the task execution.
    - StatusDetails (string) --
      
      The details explaining the status of the task execution. Not available for all status values.
    - StartTime (datetime) --
      
      The time the task execution started.
    - EndTime (datetime) --
      
      The time the task execution finished.
    - TaskArn (string) --
      
      The Amazon Resource Name (ARN) of the task that ran.
    - TaskType (string) --
      
      The type of task that ran.
    - AlarmConfiguration (dict) --
      
      The details for the CloudWatch alarm applied to your maintenance window task.
      - IgnorePollAlarmFailure (boolean) --
        
        When this value is true , your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false .
      - Alarms (list) --
        
        The name of the CloudWatch alarm specified in the configuration.
        
        (dict) --
        
        A CloudWatch alarm you apply to an automation or command.
        
        Name (string) --
        
        The name of your CloudWatch alarm.
    - TriggeredAlarms (list) --
      
      The CloudWatch alarm that was invoked by the maintenance window task.
      - (dict) --
        
        The details about the state of your CloudWatch alarm.
        
        Name (string) --
        
        The name of your CloudWatch alarm.
        
        State (string) --
        
        The state of your CloudWatch alarm.

Table Of Contents

DescribeMaintenanceWindowExecutionTasks¶