MWAAServerless / Paginator / ListTaskInstances

ListTaskInstances¶

class MWAAServerless.Paginator.ListTaskInstances¶

paginator = client.get_paginator('list_task_instances')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from MWAAServerless.Client.list_task_instances().

Request Syntax

response_iterator = paginator.paginate(
    WorkflowArn='string',
    RunId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

WorkflowArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the workflow that contains the run.
RunId (string) –
[REQUIRED]

The unique identifier of the workflow run for which you want a list of task instances.
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

{
    'TaskInstances': [
        {
            'WorkflowArn': 'string',
            'WorkflowVersion': 'string',
            'RunId': 'string',
            'TaskInstanceId': 'string',
            'Status': 'QUEUED'|'FAILED'|'SCHEDULED'|'RUNNING'|'SUCCESS'|'UP_FOR_RESCHEDULE'|'UP_FOR_RETRY'|'UPSTREAM_FAILED'|'REMOVED'|'RESTARTING'|'DEFERRED'|'NONE'|'CANCELLED'|'TIMEOUT',
            'DurationInSeconds': 123,
            'OperatorName': 'string'
        },
    ],

}

Response Structure

(dict) –
- TaskInstances (list) –
  
  A list of task instance summaries for the specified workflow run.
  - (dict) –
    
    Summary information about a task instance within a workflow run, including its status and execution details.
    - WorkflowArn (string) –
      
      The Amazon Resource Name (ARN) of the workflow that contains this task instance.
    - WorkflowVersion (string) –
      
      The version of the workflow that contains this task instance.
    - RunId (string) –
      
      The unique identifier of the workflow run that contains this task instance.
    - TaskInstanceId (string) –
      
      The unique identifier of this task instance.
    - Status (string) –
      
      The current status of the task instance.
    - DurationInSeconds (integer) –
      
      The duration of the task instance execution in seconds. This value is null if the task is not complete.
    - OperatorName (string) –
      
      The name of the Apache Airflow operator used for this task instance.