AWS Step Functions Connector 1.0.0.0

The AWS Step Functions Connector lets you list, import, and run State Machines from AWS Step Functions.

Note: In AWS Step Functions, there are two types of state machines: Standard and Express. This Connector supports only Standard State Machines. If you try to run an Express State Machine, the Job will fail.

Prerequisites

Contents

Object Type Name Description
Folder GLOBAL.Redwood.REDWOOD.AWS.REDWOOD.StepFunctions Integration connector with AWS Step Functions (1.0.0.0)
Constraint Definition REDWOOD.Redwood_AWS_StepFunctionsConstraint Constraint for AWS Step Functions State Machines in the specified region
Job Definition REDWOOD.Redwood_AWS_StepFunctions_ImportStateMachines Imports AWS Step Functions State Machines
Job Definition REDWOOD.Redwood_AWS_StepFunctions_ListStateMachines List AWS Step Functions State Machines
Job Definition REDWOOD.Redwood_AWS_StepFunctions_RunStateMachine Run an AWS Step Functions State Machine
Job Definition REDWOOD.Redwood_AWS_StepFunctions_RunStateMachine_Template Template definition to run AWS Step Functions State Machines
Job Definition Type REDWOOD.Redwood_AWS_StepFunctions AWS Step Functions Definition Type
Library REDWOOD.Redwood_AWS_StepFunctions Library for AWS Step Functions connector

Setup

To install the AWS Step Functions Connector:

  1. Click its tile in the Catalog, select the version you want, and then click Install <version number>.

  2. Create an AWS Connection.

Job Definitions

Redwood_AWS_StepFunctions_ImportStateMachines

Lets you import AWS Step Functions State Machines.

Parameters

Tab Name Description Documentation Data Type Direction Default Expression Values
Parameters connection Connection The AWS Connection to use for importing Step Functions State Machines. String In

 

 
Parameters region Region The name of the AWS region that the AWS Step Functions State Machines are located in. String In

 

 
Parameters stateMachineNameFilter State Machine Name Filter The filter that specifies which State Machines should be included. By default (if no input is provided), we will import all available state machines. Wildcards * and ? are supported. String In

 

 
Generation Settings overwrite Overwrite Existing Definition When set to Y, if a definition with the same business key already exists, it will be overwritten by the import. When set to N, the import will be skipped if the definition already exists. String In N Y=Yes, N=No
Generation Settings partition Partition The Partition to create the new Job Definitions in. String In

 

 QueryFilter:User.Redwood System.Partition.Partition%2e;all
Generation Settings application Application The Application to create the new Job Definitions in. String In

 

 
Generation Settings defaultQueue Default Queue The Queue to assign to the imported Job Definitions. String In

 

 
Generation Settings prefix Prefix Prefix to prepend to the imported Job Definition names. String In CUS_AWSSF_

 

Redwood_AWS_StepFunctions_ListStateMachines

Lets youlist AWS Step Functions State Machines.

Parameters

Tab Name Description Documentation Data Type Direction Default Expression Values
Parameters connection Connection Connection that will be used for listing the AWS Step Functions State Machines. String In

 

 
Parameters region Region The name of the AWS region. String In

 

 
Parameters stateMachineNameFilter State Machine Name Filter Supports filtering down the list based on State Machine Name. Supports ? and * wildcards with glob semantics. By default (if no input is provided) the job will list all available state machines. String In

 

 
Parameters Listing Listing Pointer to RTX file generated. If there was no RTX file generated, this is left empty. Table Out

 

 

Redwood_AWS_StepFunctions_RunStateMachine

Run an AWS Step Functions State Machine.

Parameters

Tab Name Description Documentation Data Type Direction Default Expression Values
Parameters connection Connection Connection that will be used for AWS Step Functions Job execution. String In

 

 
Parameters region Region The name of the AWS region. String In

 

 
Parameters stateMachineArn State Machine ARN ARN of the State Machine to Start. String In

 

 
Parameters executionArn State Machine Execution ARN ARN of the State Machine Execution Started by this Job. String Out

 

 

Redwood_AWS_StepFunctions_RunStateMachine_Template

Template definition that lets you run AWS Step Functions State Machines.

Parameters

Tab Name Description Documentation Data Type Direction Default Expression Values
Parameters connection Connection Connection that will be used for AWS Step Functions Job execution. String In

 

 
Parameters region Region The name of the AWS region. String In

 

 
Parameters stateMachineArn State Machine ARN ARN of the State Machine to Start. String In

 

 
Parameters executionArn State Machine Execution ARN ARN of the State Machine Execution Started by this Job. String Out

 

 

Procedures

Listing AWS Step Functions State Machines

You can use the Redwood_AWS_StepFunctions_ListStateMachines Job Definition to query for AWS Step Functions State Machines. This Job Definition returns the list of AWS Step Functions State Machines in RTX format, so that you can use it in a Workflow Definition.

To list AWS Step Functions State Machines:

  1. In the Redwood > AWS > StepFunctions Folder, run the Redwood_AWS_StepFunctions_ListStateMachines Job Definition.

  2. Choose the Connection.

  3. Choose the Region the AWS Step Functions State Machines are in.

  4. Optionally, to limit the results, enter a State Machine Name Filter. You can use the wildcard characters ? and *.

  5. Run the Job Definition.

  6. In the Monitor screen, select the Job, then look at the Detail View. Under Files, the listing.rtx file contains the response (if any).

Importing AWS Step Functions State Machines

To import AWS Step Functions State Machines as Job Definitions:

  1. In the Redwood > AWS > StepFunctions Folder, run the Redwood_AWS_StepFunctions_ImportStateMachines Job Definition.

  2. Choose the Connection.

  3. Choose the Region the AWS Step Functions State Machines are in.

  4. Optionally, to limit the results, enter a State Machine Name Filter. You can use the wildcard characters ? and *.

  5. Switch to the Generation Settings tab.

  6. To indicate whether to overwrite any matching AWS Step Function State Machine Job Definitions you've already imported, choose an option from the Overwrite Existing Definition dropdown list.
  7. Optionally specify a Partition, Default Queue, and Application.
  8. To specify a prefix to be applied to the names of the imported AWS Step Functions State Machine Job Definitions, enter a value in the Prefix field.

  9. Run the Job Definition.

Running an AWS Step Functions State Machine

To run an AWS Step Functions State Machine:

  1. In the Redwood > AWS > StepFunctions Folder, run the Redwood_AWS_StepFunctions_RunStateMachine Job Definition.

  2. Choose the Connection.

  3. Choose the Region the AWS Step Functions State Machine is in.

  4. Choose the AWS Step Functions State Machine ARN.

  5. Run the Job Definition.

Running an AWS Step Functions State Machine with a Template

To create a customized Job Definition, optionally with default values, for running an AWS Step Functions State Machine:

  1. Right-click the Redwood_AWS_StepFunctions_RunStateMachine_Template Job Definition and choose New (from Template) from the context menu. The New Job Definition screen displays.

  2. Choose a Partition.

  3. Enter a Name.

  4. Delete the default Folder value (if any) and substitute your own Folder name if desired.

  5. In the Source field, enter any JSON you want to be passed as the input to the State Machine. You can use Parameter values here, with the syntax ${paramName}.

  6. In the Parameters tab, enter any Default Expressions you want to use.

    • When specifying the Connection value, use the format EXTCONNECTION:<partition>.<connection name>.

  7. Save and then run the new Job Definition.