workflow_definitions

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

Overview

Name	workflow_definitions
Type	Resource
Id	aws.nova_act.workflow_definitions

Fields

The following fields are returned by SELECT queries:

get_workflow_definition

Name	Datatype	Description
name	string	The name of the workflow definition. (pattern: <code>[a-zA-Z0-9_-]{1,40}</code>)
arn	string	The Amazon Resource Name (ARN) of the workflow definition. (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}</code>)
created_at	string (date-time)	The timestamp when the workflow definition was created.
description	string	The description of the workflow definition.
export_config	object	Configuration settings for exporting workflow execution data and logs to Amazon Simple Storage Service (Amazon S3).
status	string	The current status of the workflow definition. (ACTIVE, DELETING)

list_workflow_definitions

Name	Datatype	Description
created_at	string (date-time)	The timestamp when the workflow definition was created.
status	string	The current status of the workflow definition. (ACTIVE, DELETING)
workflow_definition_arn	string	The Amazon Resource Name (ARN) of the workflow definition. (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}</code>)
workflow_definition_name	string	The name of the workflow definition. (pattern: <code>[a-zA-Z0-9_-]{1,40}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_workflow_definition	select	workflow_definition_name, region		Retrieves the details and configuration of a specific workflow definition.
list_workflow_definitions	select	region	maxResults, nextToken	Lists all workflow definitions in your account with optional filtering and pagination.
create_workflow_definition	insert	region, name		Creates a new workflow definition template that can be used to execute multiple workflow runs.
delete_workflow_definition	delete	workflow_definition_name, region		Deletes a workflow definition and all associated resources. This operation cannot be undone.

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 to delete.
maxResults	integer	The maximum number of workflow definitions to return in a single response.
nextToken	string	The token for retrieving the next page of results.

SELECT examples

get_workflow_definition

Retrieves the details and configuration of a specific workflow definition.

SELECT
name,
arn,
created_at,
description,
export_config,
status
FROM aws.nova_act.workflow_definitions
WHERE workflow_definition_name = '{{ workflow_definition_name }}' -- required
AND region = '{{ region }}' -- required
;

list_workflow_definitions

Lists all workflow definitions in your account with optional filtering and pagination.

SELECT
created_at,
status,
workflow_definition_arn,
workflow_definition_name
FROM aws.nova_act.workflow_definitions
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_workflow_definition

Creates a new workflow definition template that can be used to execute multiple workflow runs.

INSERT INTO aws.nova_act.workflow_definitions (
name,
description,
exportConfig,
clientToken,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ exportConfig }}',
'{{ clientToken }}',
'{{ region }}'
RETURNING
status
;

Manifest

# Description fields are for documentation purposes
- name: workflow_definitions
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the workflow_definitions resource.
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: exportConfig
    description: |
      Configuration settings for exporting workflow execution data and logs to Amazon Simple Storage Service (Amazon S3).
    value:
      s3BucketName: "{{ s3BucketName }}"
      s3KeyPrefix: "{{ s3KeyPrefix }}"
  - name: clientToken
    value: "{{ clientToken }}"

DELETE examples

delete_workflow_definition

Deletes a workflow definition and all associated resources. This operation cannot be undone.

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