Creating a Step Functions State Machine That Uses Lambda

In this tutorial, you create an AWS Step Functions state machine that uses an AWS Lambda function to implement a Task state. A Task state performs a single unit of work.

Lambda is well suited for implementing Task states, because Lambda functions are stateless (they have a predictable input-output relationship), easy to write, and don't require deploying code to a server instance. You can write code in the AWS Management Console or your favorite editor. AWS handles the details of providing a computing environment for your function and running it.

Step 1: Create an IAM Role for Lambda

Both AWS Lambda and AWS Step Functions can execute code and access AWS resources (for example, data stored in Amazon S3 buckets). To maintain security, you must grant Lambda and Step Functions access to these resources.

Lambda requires you to assign an AWS Identity and Access Management (IAM) role when you create a Lambda function, in the same way Step Functions requires you to assign an IAM role when you create a state machine.

You use the IAM console to create a service-linked role.

To create a role (console)

1. Sign in to the AWS Management Console and open the IAM console at https://console.aws.amazon.com/iam/.

2. In the navigation pane of the IAM console, choose Roles. Then choose Create role.

3. Choose the AWS Service role type, and then choose Lambda.

4. Choose the Lambda use case. Use cases are defined by the service to include the trust policy required by the service. Then choose Next: Permissions.

5. Choose one or more permissions policies to attach to the role (for example, AWSLambdaBasicExecutionRole). See AWS Lambda Permissions Model.

   Select the box next to the policy that assigns the permissions that you want the role to have, and then choose Next: Review.

6. Enter a Role name.

7. (Optional) For Role description, edit the description for the new service-linked role.

8. Review the role, and then choose Create role.

Step 2: Create a Lambda Function

Your Lambda function receives input (a name) and returns a greeting that includes the input value.

Important

Ensure that your Lambda function is under the same AWS account and AWS Region as your state machine.

1. Open the Lambda console and choose Create a function.

2. In the Create function section, choose Author from scratch.

3. In the Basic information section, configure your Lambda function:

   1. For Function name, enter HelloFunction.

   2. For Runtime, choose Node.js 12.x.

   3. For Role, select Choose an existing role.

   4. For Existing role, select the Lambda role that you created earlier.

      Note

      If the IAM role that you created doesn't appear in the list, the role might still need a few minutes to propagate to Lambda.

   5. Choose Create function.

      When your Lambda function is created, make a note of its Amazon Resource Name (ARN) in the upper-right corner of the page, as shown in the example.

      arn:aws:lambda:us-east-1:123456789012:function:HelloFunction

4. Copy the following code for the Lambda function into the Function code section of the HelloFunction page.

   exports.handler = (event, context, callback) => {
       callback(null, "Hello, " + event.who + "!");
   };

   This code assembles a greeting using the who field of the input data, which is provided by the event object passed into your function. You add input data for this function later, when you start a new execution. The callback method returns the assembled greeting from your function.

5. Choose Save.

Step 3: Test the Lambda Function

Test your Lambda function to see it in operation.

1. For Select a test event, choose Configure test event. For Event name, enter HelloFunction.

2. Replace the example data with the following.

   {
       "who": "AWS Step Functions"
   }

   The "who" entry corresponds to the event.who field in your Lambda function, completing the greeting. You will use the same input data when running the function as a Step Functions task.

3. Choose Create.

4. On the HelloFunction page, Test your Lambda function using the new data.

   The results of the test are displayed at the top of the page. Expand Details to see the output.

Step 4: Create a State Machine

Use the Step Functions console to create a state machine with a Task state. Add a reference to your Lambda function in the Task state. The Lambda function is invoked when an execution of the state machine reaches the Task state.

1. Open the Step Functions console and choose Create a state machine.

2. On the Define state machine page, choose Author with code snippets. For Type, choose Standard. Enter a Name for your state machine, for example, LambdaStateMachine.

   Note

   State machine, execution, and activity names must be 1–80 characters in length, must be unique for your account and AWS Region, and must not contain any of the following:

   • Whitespace

   • Wildcard characters (? *)

   • Bracket characters (< > { } [ ])

   • Special characters (: ; , \ | ^ ~ $ # % & ` ")

   • Control characters (\\u0000 - \\u001f or \\u007f - \\u009f).

   Step Functions allows you to create state machine, execution, and activity names that contain non-ASCII characters. These non-ASCII names don't work with Amazon CloudWatch. To ensure that you can track CloudWatch metrics, choose a name that uses only ASCII characters.

3. In the State machine definition pane, add the following state machine definition using the ARN of the Lambda function that you created earlier, as shown in the following example.

   {
     "Comment": "A Hello World example of the Amazon States Language using an AWS Lambda function",
     "StartAt": "HelloWorld",
     "States": {
       "HelloWorld": {
         "Type": "Task",
         "Resource": "arn:aws:lambda:us-east-1:123456789012:function:HelloFunction",
         "End": true
       }
     }
   }

   This is a description of your state machine using the Amazon States Language. It defines a single Task state named HelloWorld. For more information, see State Machine Structure.

   Note

   You can also set up a Retry for Task states. As a best practice, ensure production code can handle Lambda service exceptions (Lambda.ServiceException and Lambda.SdkClientException). For more information, see the following:

   • Handle Lambda Service Exceptions

   • Retrying after an Error

   Choose Next.

4. Create or enter an IAM role:

   • To create an IAM role for Step Functions, select Create an IAM role for me, and enter a Name for your role.

   • If you have previously created an IAM role with the correct permissions for your state machine, select Choose an existing IAM role. Select a role from the list, or provide an ARN for that role.

   Note

   If you delete the IAM role that Step Functions creates, Step Functions can't recreate it later. Similarly, if you modify the role (for example, by removing Step Functions from the principals in the IAM policy), Step Functions can't restore its original settings later.

5. Choose Next.

Step 5: Start a New Execution

After you create your state machine, you start an execution.

1. On the LambdaStateMachine page, choose Start execution.

   The New execution page is displayed.

2. (Optional) To help identify your execution, you can specify an ID for it in the Enter an execution name box. If you don't enter an ID, Step Functions generates a unique ID automatically.

   Note

   Step Functions allows you to create state machine, execution, and activity names that contain non-ASCII characters. These non-ASCII names don't work with Amazon CloudWatch. To ensure that you can track CloudWatch metrics, choose a name that uses only ASCII characters.

3. In the execution input area, replace the example data with the following.

   {
       "who" : "AWS Step Functions"
   }

   "who" is the key name that your Lambda function uses to get the name of the person to greet.

4. Choose Start Execution.

   A new execution of your state machine starts, and a new page showing your running execution is displayed.

5. To view the results of your execution, expand the Output section under Execution details.