This sample project demonstrates how to invoke Synchronous Express Workflows through Amazon API Gateway to manage an employee database.
In this project, Step Functions uses API Gateway endpoints to start Step Functions Synchronous Express Workflows. These then use DynamoDB to search for, add, and remove employees in an employee database.
For more information about Step Functions Synchronous Express Workflows, see Synchronous and Asynchronous Express Workflows in Step Functions.
Note
This sample project may incur charges.
For new AWS users, a free usage tier is available. On this tier, services are free below
a certain level of usage. For more information about AWS costs and the Free Tier, see Step Functions Pricing
Step 1: Create the state machine
-
Open the Step Functions console
and choose Create state machine. -
Choose Create from template and find the related starter template. Choose Next to continue.
-
Choose how to use the template:
-
Run a demo – creates a read-only state machine. After review, you can create the workflow and all related resources.
-
Build on it – provides an editable workflow definition that you can review, customize, and deploy with your own resources. (Related resources, such as functions or queues, will not be created automatically.)
-
-
Choose Use template to continue with your selection.
Note
Standard charges apply for services deployed to your account.
Step 2: Run the demo state machine
If you chose the Run a demo option, all related resources will be deployed and ready to run. If you chose the Build on it option, you might need to set placeholder values and create additional resources before you can run your custom workflow.
Choose Deploy and run.
Wait for the AWS CloudFormation stack to deploy. This can take up to 10 minutes.
After the Start execution option appears, review the Input and choose Start execution.
Congratulations!
You should now have a running demo of your state machine. You can choose states in the Graph view to review input, output, variables, definition, and events.
