workflow_runs

Creates, updates, deletes, gets or lists a workflow_runs resource.

Overview

Name	workflow_runs
Type	Resource
Id	aws.nova_act.workflow_runs

Fields

The following fields are returned by SELECT queries:

get_workflow_run

Name	Datatype	Description
ended_at	string (date-time)	The timestamp when the workflow run completed execution, if applicable.
log_group_name	string	The CloudWatch log group name for this workflow run's logs. (pattern: <code>[a-zA-Z0-9_/.-]+</code>)
model_id	string	The ID of the AI model being used for this workflow run.
started_at	string (date-time)	The timestamp when the workflow run started execution.
status	string	The current execution status of the workflow run. (RUNNING, SUCCEEDED, FAILED, TIMED_OUT, DELETING)
workflow_run_arn	string	The Amazon Resource Name (ARN) of the workflow run. (pattern: <code>arn:(aws|aws-cn|aws-us-gov):nova-act:[a-z0-9-]+:[0-9]{12}:workflow-definition/[a-zA-Z0-9_-]{1,40}/workflow-run/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
workflow_run_id	string	The unique identifier of the workflow run. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)

list_workflow_runs

Name	Datatype	Description
ended_at	string (date-time)	The timestamp when the workflow run completed execution, if applicable.
started_at	string (date-time)	The timestamp when the workflow run started execution.
status	string	The current execution status of the workflow run. (RUNNING, SUCCEEDED, FAILED, TIMED_OUT, DELETING)
trace_location	object	The location where trace information for this workflow run is stored.
workflow_run_arn	string	The Amazon Resource Name (ARN) of the workflow run. (pattern: <code>arn:(aws|aws-cn|aws-us-gov):nova-act:[a-z0-9-]+:[0-9]{12}:workflow-definition/[a-zA-Z0-9_-]{1,40}/workflow-run/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
workflow_run_id	string	The unique identifier of the workflow run. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_workflow_run	select	workflow_definition_name, workflow_run_id, region		Retrieves the current state, configuration, and execution details of a workflow run.
list_workflow_runs	select	workflow_definition_name, region	maxResults, nextToken	Lists all workflow runs for a specific workflow definition with optional filtering and pagination.
create_workflow_run	insert	workflow_definition_name, region, modelId, clientInfo		Creates a new execution instance of a workflow definition with specified parameters.
update_workflow_run	update	workflow_definition_name, workflow_run_id, region, status		Updates the configuration or state of an active workflow run.
delete_workflow_run	delete	workflow_definition_name, workflow_run_id, region		Terminates and cleans up a workflow run, stopping all associated acts and sessions.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
workflow_definition_name	string	The name of the workflow definition containing the workflow run.
workflow_run_id	string	The unique identifier of the workflow run to delete.
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.

SELECT examples

get_workflow_run

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

SELECT
ended_at,
log_group_name,
model_id,
started_at,
status,
workflow_run_arn,
workflow_run_id
FROM aws.nova_act.workflow_runs
WHERE workflow_definition_name = '{{ workflow_definition_name }}' -- required
AND workflow_run_id = '{{ workflow_run_id }}' -- required
AND region = '{{ region }}' -- required
;

list_workflow_runs

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

SELECT
ended_at,
started_at,
status,
trace_location,
workflow_run_arn,
workflow_run_id
FROM aws.nova_act.workflow_runs
WHERE workflow_definition_name = '{{ workflow_definition_name }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_workflow_run

Creates a new execution instance of a workflow definition with specified parameters.

INSERT INTO aws.nova_act.workflow_runs (
modelId,
clientToken,
logGroupName,
clientInfo,
workflow_definition_name,
region
)
SELECT 
'{{ modelId }}' /* required */,
'{{ clientToken }}',
'{{ logGroupName }}',
'{{ clientInfo }}' /* required */,
'{{ workflow_definition_name }}',
'{{ region }}'
RETURNING
status,
workflow_run_id
;

Manifest

# Description fields are for documentation purposes
- name: workflow_runs
props:
  - name: workflow_definition_name
    value: "{{ workflow_definition_name }}"
    description: Required parameter for the workflow_runs resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the workflow_runs resource.
  - name: modelId
    value: "{{ modelId }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: logGroupName
    value: "{{ logGroupName }}"
  - name: clientInfo
    description: |
      Information about the client making API requests, used for compatibility checking.
    value:
      compatibilityVersion: {{ compatibilityVersion }}
      sdkVersion: "{{ sdkVersion }}"

UPDATE examples

update_workflow_run

Updates the configuration or state of an active workflow run.

UPDATE aws.nova_act.workflow_runs
SET 
status = '{{ status }}'
WHERE 
workflow_definition_name = '{{ workflow_definition_name }}' --required
AND workflow_run_id = '{{ workflow_run_id }}' --required
AND region = '{{ region }}' --required
AND status = '{{ status }}' --required;

DELETE examples

delete_workflow_run

Terminates and cleans up a workflow run, stopping all associated acts and sessions.

DELETE FROM aws.nova_act.workflow_runs
WHERE workflow_definition_name = '{{ workflow_definition_name }}' --required
AND workflow_run_id = '{{ workflow_run_id }}' --required
AND region = '{{ region }}' --required
;