Setting Up Step Functions Local (Downloadable Version) - AWS Step Functions

Setting Up Step Functions Local (Downloadable Version)

The downloadable version of AWS Step Functions is provided as an executable .jar file, and as a Docker image. The Java application runs on Windows, Linux, macOS, and other platforms that support Java. In addition to Java, you need to install the AWS Command Line Interface (AWS CLI). For information about installing and configuring the AWS CLI, see the AWS Command Line Interface User Guide.

Warning

The downloadable version of AWS Step Functions is intended to be used only for testing and shouldn't be used to process sensitive information.

To set up and run Step Functions on your computer

  1. Download Step Functions using the following links.

    Download Links Checksum
    .tar.gz 8672b951e4dad1e354598898b56f3bf0
    .zip c3c0956a1f9b1bfcab539665602523ba
  2. Extract the .zip file.

  3. Test the download and view version information.

    $ java -jar StepFunctionsLocal.jar -v Step Function Local Version: 1.0.0 Build: 2019-01-21
  4. (Optional) View a listing of available commands.

    $ java -jar StepFunctionsLocal.jar -h
  5. To start Step Functions on your computer, open a command prompt window, navigate to the directory where you extracted StepFunctionsLocal.jar, and enter the following command.

    java -jar StepFunctionsLocal.jar
  6. To access Step Functions running locally, use the --endpoint-url parameter. For example, using the AWS CLI, you would specify Step Functions commands as follows.

    aws stepfunctions --endpoint-url http://localhost:8083 command
Note

By default, Step Functions Local uses a fake account and credentials, and the AWS Region is set to US East (N. Virginia). To use Step Functions Local with AWS Lambda, or other supported services, you must configure your credentials and Region.

If you use Express workflows with Step Functions Local, the execution history will be stored in a log file, not logged to CloudWatch Logs. The log file path will be based on the CloudWatch Logs log group ARN provided when you create the local state machine. The log file will be stored in /aws/states/log-group-name/${execution_arn}.log relative to the location where you are running Step Functions Local. For example, if the execution ARN is:

arn:aws:states:us-east-1:123456789012:express:test:example-ExpressLogGroup-wJalrXUtnFEMI

the log file will be:

aws/states/log-group-name/arn:aws:states:us-east-1:123456789012:express:test:example-ExpressLogGroup-wJalrXUtnFEMI.log

To configure and run Step Functions Local to work with AWS Lambda, AWS Serverless Application Model(AWS SAM) CLI Local, or other supported services, see the following topics.