NovaActService / Paginator / ListWorkflowRuns

ListWorkflowRuns¶

class NovaActService.Paginator.ListWorkflowRuns¶

paginator = client.get_paginator('list_workflow_runs')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from NovaActService.Client.list_workflow_runs().

Request Syntax

response_iterator = paginator.paginate(
    workflowDefinitionName='string',
    sortOrder='Ascending'|'Descending',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

workflowDefinitionName (string) –
[REQUIRED]

The name of the workflow definition to list workflow runs for.
sortOrder (string) – The sort order for the returned workflow runs (ascending or descending).
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

{
    'workflowRunSummaries': [
        {
            'workflowRunArn': 'string',
            'workflowRunId': 'string',
            'status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'DELETING',
            'startedAt': datetime(2015, 1, 1),
            'endedAt': datetime(2015, 1, 1),
            'traceLocation': {
                'locationType': 'S3',
                'location': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- workflowRunSummaries (list) –
  
  A list of summary information for workflow runs.
  - (dict) –
    
    Summary information about a workflow run, including execution status and timing.
    - workflowRunArn (string) –
      
      The Amazon Resource Name (ARN) of the workflow run.
    - workflowRunId (string) –
      
      The unique identifier of the workflow run.
    - status (string) –
      
      The current execution status of the workflow run.
    - startedAt (datetime) –
      
      The timestamp when the workflow run started execution.
    - endedAt (datetime) –
      
      The timestamp when the workflow run completed execution, if applicable.
    - traceLocation (dict) –
      
      The location where trace information for this workflow run is stored.
      - locationType (string) –
        
        The type of storage location for the trace data.
      - location (string) –
        
        The specific location where the trace data is stored.
- NextToken (string) –
  
  A token to resume pagination.