NovaActService / Client / list_workflow_runs

list_workflow_runs¶

NovaActService.Client.list_workflow_runs(**kwargs)¶

Lists all workflow runs for a specific workflow definition with optional filtering and pagination.

Request Syntax

response = client.list_workflow_runs(
    workflowDefinitionName='string',
    maxResults=123,
    nextToken='string',
    sortOrder='Ascending'|'Descending'
)

Parameters:

workflowDefinitionName (string) –
[REQUIRED]

The name of the workflow definition to list workflow runs for.
maxResults (integer) – The maximum number of workflow runs to return in a single response.
nextToken (string) – The token for retrieving the next page of results.
sortOrder (string) – The sort order for the returned workflow runs (ascending or descending).

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) –
  
  The token for retrieving the next page of results, if available.

Exceptions

NovaActService.Client.exceptions.AccessDeniedException
NovaActService.Client.exceptions.ConflictException
NovaActService.Client.exceptions.ThrottlingException
NovaActService.Client.exceptions.ResourceNotFoundException
NovaActService.Client.exceptions.InternalServerException
NovaActService.Client.exceptions.ValidationException