Skip to content

Latest commit

 

History

History
 
 

step-functions-api-gateway-cdk-typescript

README.md

AWS API Gateway with Step Functions

This workflow demonstrates how to use Step Functions to make a call to an API in AWS API Gateway then check if the call was successful or not. Deploying this sample project will create an AWS Step Functions state machine, an API in AWS API Gateway, required IAM roles and Cloudwatch logs.

Important: this application uses various AWS services and there are costs associated with these services after the Free Tier usage - please see the AWS Pricing page for details. You are responsible for any AWS costs incurred. No warranty is implied in this example.

Requirements

Deployment Instructions

  1. If this is your first time using AWS CDK, bootstrap your environment.

    cdk bootstrap aws://{your-aws-account-number}/{your-aws-region}

  2. Create a new directory, navigate to that directory in a terminal and clone the GitHub repository:

    git clone https://github.com/aws-samples/step-functions-workflows-collection

  3. Change directory to the pattern directory:

    cd step-functions-api-gateway-cdk-typescript

  4. From the command line, use CDK to deploy the AWS resources for the workflow :

    cdk deploy --all

  5. During the prompts:

    • Do you wish to deploy these changes (y/n)? Y

  6. Note the outputs from the cdk deployment process. The State Machine Name and ARN are outputted for testing.

How it works

The first step of this workflow makes an API call to the Pet Store API in your AWS account to add a new pet. The next step checks the status returned from the call. If successful, the next step submits a get request to the API to fetch the pet details. If unsuccesful, the step functions goes to fail state and ends.

Image

image

Testing

Manually trigger the workflow via the Console or the AWS CLI. The state machine ARN can be found as the StateMachineArn output and the state machine name can be found as StateMachineName in the output.

To trigger the workflow in the console, navigate to Step Functions and then click the step function name from the list of State Machines. In the Executions panel, click Start Execution. Click Start Execution again in the popup. Provide the follow sample input :

{ "id": 1, "type": "dog", "price": 249.99 }

Once the step function completes, inspect the output of the Pet was Added Successfully? state. The output will look similiar to this, but your input value may be different.

{ { "id": 1, "type": "dog", "price": 249.99 } "message" : "Success" }

Next, inspect the Input of the Retrieve the Pet state. This shows the result of passing the prior state's output to the input of the next state. Your input will match the output from the prior state and the output will display the pet you added:

{ "id": 1, "type": "dog", "price": 249.99 }

Cleanup

  1. Delete the stack 
    cdk destroy
  2. During the prompts: 
        Are you sure you want to delete: StepFunctionsApiGatewayCdkTypescriptStack (y/n)? Y

Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: MIT-0