NovaActService / Client / get_workflow_run

get_workflow_run¶

NovaActService.Client.get_workflow_run(**kwargs)¶

Retrieves the current state, configuration, and execution details of a workflow run.

Request Syntax

response = client.get_workflow_run(
    workflowDefinitionName='string',
    workflowRunId='string'
)

Parameters:

workflowDefinitionName (string) –
[REQUIRED]

The name of the workflow definition containing the workflow run.
workflowRunId (string) –
[REQUIRED]

The unique identifier of the workflow run to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'workflowRunArn': 'string',
    'workflowRunId': 'string',
    'status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'DELETING',
    'startedAt': datetime(2015, 1, 1),
    'endedAt': datetime(2015, 1, 1),
    'modelId': 'string',
    'logGroupName': 'string'
}

Response Structure

(dict) –
- 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.
- modelId (string) –
  
  The ID of the AI model being used for this workflow run.
- logGroupName (string) –
  
  The CloudWatch log group name for this workflow run’s logs.

Exceptions

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