MWAAServerless / Client / get_workflow_run

get_workflow_run¶

MWAAServerless.Client.get_workflow_run(**kwargs)¶

Retrieves detailed information about a specific workflow run, including its status, execution details, and task instances.

Request Syntax

response = client.get_workflow_run(
    WorkflowArn='string',
    RunId='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 to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'WorkflowArn': 'string',
    'WorkflowVersion': 'string',
    'RunId': 'string',
    'RunType': 'ON_DEMAND'|'SCHEDULED',
    'OverrideParameters': {
        'string': {...}|[...]|123|123.4|'string'|True|None
    },
    'RunDetail': {
        'WorkflowArn': 'string',
        'WorkflowVersion': 'string',
        'RunId': 'string',
        'RunType': 'ON_DEMAND'|'SCHEDULED',
        'StartedOn': datetime(2015, 1, 1),
        'CreatedAt': datetime(2015, 1, 1),
        'CompletedOn': datetime(2015, 1, 1),
        'ModifiedAt': datetime(2015, 1, 1),
        'Duration': 123,
        'ErrorMessage': 'string',
        'TaskInstances': [
            'string',
        ],
        'RunState': 'STARTING'|'QUEUED'|'RUNNING'|'SUCCESS'|'FAILED'|'TIMEOUT'|'STOPPING'|'STOPPED'
    }
}

Response Structure

(dict) –
- WorkflowArn (string) –
  
  The Amazon Resource Name (ARN) of the workflow that contains this run.
- WorkflowVersion (string) –
  
  The version of the workflow that is used for this run.
- RunId (string) –
  
  The unique identifier of this workflow run.
- RunType (string) –
  
  The type of workflow run. Values are ON_DEMAND (manually triggered) or SCHEDULED (automatically triggered by schedule).
- OverrideParameters (dict) –
  
  Parameters that were overridden for this specific workflow run.
  - (string) –
    - (document) –
- RunDetail (dict) –
  
  Detailed information about the workflow run execution, including timing, status, and task instances.
  - 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.
  - RunId (string) –
    
    The unique identifier of this workflow run.
  - RunType (string) –
    
    The type of workflow run.
  - StartedOn (datetime) –
    
    The timestamp when the workflow run started execution, in ISO 8601 date-time format.
  - CreatedAt (datetime) –
    
    The timestamp when the workflow run was created, in ISO 8601 date-time format.
  - CompletedOn (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.
  - ModifiedAt (datetime) –
    
    The timestamp when the workflow run was last modified, in ISO 8601 date-time format.
  - Duration (integer) –
    
    The total duration of the workflow run execution in seconds. This value is null if the run is not complete.
  - ErrorMessage (string) –
    
    The error message if the workflow run failed. This value is null if the run completed successfully.
  - TaskInstances (list) –
    
    A list of task instance IDs that are part of this workflow run.
    - (string) –
  - RunState (string) –
    
    The current execution state of the workflow run.

Exceptions

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