MWAAServerless / Client / list_workflow_runs

list_workflow_runs¶

MWAAServerless.Client.list_workflow_runs(**kwargs)¶

Lists all runs for a specified workflow, with optional pagination and filtering support.

Request Syntax

response = client.list_workflow_runs(
    MaxResults=123,
    NextToken='string',
    WorkflowArn='string',
    WorkflowVersion='string'
)

Parameters:

MaxResults (integer) – The maximum number of workflow runs to return in a single response.
NextToken (string) – The pagination token you need to use to retrieve the next set of results. This value is returned from a previous call to ListWorkflowRuns.
WorkflowArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the workflow for which you want a list of runs.
WorkflowVersion (string) – Optional. The specific version of the workflow for which you want a list of runs. If not specified, runs for all versions are returned.

Return type:

dict

Returns:

Response Syntax

{
    'WorkflowRuns': [
        {
            'RunId': 'string',
            'WorkflowArn': 'string',
            'WorkflowVersion': 'string',
            'RunType': 'ON_DEMAND'|'SCHEDULED',
            'RunDetailSummary': {
                'Status': 'STARTING'|'QUEUED'|'RUNNING'|'SUCCESS'|'FAILED'|'TIMEOUT'|'STOPPING'|'STOPPED',
                'CreatedOn': datetime(2015, 1, 1),
                'StartedAt': datetime(2015, 1, 1),
                'EndedAt': datetime(2015, 1, 1)
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- WorkflowRuns (list) –
  
  A list of workflow run summaries for the specified workflow.
  - (dict) –
    
    Summary information about a workflow run, including basic identification and status information.
    - RunId (string) –
      
      The unique identifier of the workflow run.
    - WorkflowArn (string) –
      
      The Amazon Resource Name (ARN) of the workflow that contains this run.
    - WorkflowVersion (string) –
      
      The version of the workflow used for this run.
    - RunType (string) –
      
      The type of workflow run.
    - RunDetailSummary (dict) –
      
      Summary details about the workflow run execution.
      - Status (string) –
        
        The current status of the workflow run.
      - CreatedOn (datetime) –
        
        The timestamp when the workflow run was created, in ISO 8601 date-time format.
      - StartedAt (datetime) –
        
        The timestamp when the workflow run started execution, in ISO 8601 date-time format.
      - EndedAt (datetime) –
        
        The timestamp when the workflow run completed execution, in ISO 8601 date-time format. This value is null if the run is not complete.
- NextToken (string) –
  
  The pagination token you need to use to retrieve the next set of results. This value is null if there are no more results.

Exceptions

MWAAServerless.Client.exceptions.ThrottlingException
MWAAServerless.Client.exceptions.ValidationException
MWAAServerless.Client.exceptions.AccessDeniedException
MWAAServerless.Client.exceptions.InternalServerException
MWAAServerless.Client.exceptions.OperationTimeoutException