DescribeMaintenanceWindowExecutionTaskInvocations¶

class SSM.Paginator.DescribeMaintenanceWindowExecutionTaskInvocations¶

paginator = client.get_paginator('describe_maintenance_window_execution_task_invocations')

paginate(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

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

Parameters

WindowExecutionId (string) --
[REQUIRED]

The ID of the maintenance window execution the task is part of.
TaskId (string) --
[REQUIRED]

The ID of the specific task in the maintenance window task that should be retrieved.
Filters (list) --
Optional filters used to scope down the returned task invocations. 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

{
    'WindowExecutionTaskInvocationIdentities': [
        {
            'WindowExecutionId': 'string',
            'TaskExecutionId': 'string',
            'InvocationId': 'string',
            'ExecutionId': 'string',
            'TaskType': 'RUN_COMMAND'|'AUTOMATION'|'STEP_FUNCTIONS'|'LAMBDA',
            'Parameters': '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),
            'OwnerInformation': 'string',
            'WindowTargetId': 'string'
        },
    ],

}

Response Structure

(dict) --
- WindowExecutionTaskInvocationIdentities (list) --
  
  Information about the task invocation results per invocation.
  - (dict) --
    
    Describes the information about a task invocation for a particular target as part of 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.
    - InvocationId (string) --
      
      The ID of the task invocation.
    - ExecutionId (string) --
      
      The ID of the action performed in the service that actually handled the task invocation. If the task type is RUN_COMMAND , this value is the command ID.
    - TaskType (string) --
      
      The task type.
    - Parameters (string) --
      
      The parameters that were provided for the invocation when it was run.
    - Status (string) --
      
      The status of the task invocation.
    - StatusDetails (string) --
      
      The details explaining the status of the task invocation. Not available for all status values.
    - StartTime (datetime) --
      
      The time the invocation started.
    - EndTime (datetime) --
      
      The time the invocation finished.
    - OwnerInformation (string) --
      
      User-provided value that was specified when the target was registered with the maintenance window. This was also included in any Amazon CloudWatch Events events raised during the task invocation.
    - WindowTargetId (string) --
      
      The ID of the target definition in this maintenance window the invocation was performed for.

Table Of Contents

DescribeMaintenanceWindowExecutionTaskInvocations¶