Manage a batch job with AWS Batch and Amazon SNS

This sample project demonstrates how to submit an AWS Batch job, and then send an Amazon SNS notification based on whether that job succeeds or fails. Deploying this sample project creates an AWS Step Functions state machine, an AWS Batch job, and an Amazon SNS topic.

In this project, Step Functions uses a state machine to call the AWS Batch job synchronously. It then waits for the job to succeed or fail, and it sends an Amazon SNS topic with a message about whether the job succeeded or failed.

Step 1: Create the state machine and provision resources

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

2. Type Manage a batch job in the search box, and then choose Manage a batch job from the search results that are returned.

3. Choose Next to continue.

4. Step Functions lists the AWS services used in the sample project you selected. It also shows a workflow graph for the sample project. Deploy this project to your AWS account or use it as a starting point for building your own projects. Based on how you want to proceed, choose Run a demo or Build on it.

   This sample project deploys the following resources:

   • A AWS Batch job

   • An Amazon SNS topic

   • An AWS Step Functions state machine

   • Related AWS Identity and Access Management (IAM) roles

   The following image shows the workflow graph for the Manage a batch job sample project:

   

5. Choose Use template to continue with your selection.

6. Do one of the following:

   • If you selected Build on it, Step Functions creates the workflow prototype, but does not deploy the resources in the workflow definition, so you can continue building out your workflow prototype.

     In Workflow Studio'sDesign mode, you can can additional states into your workflow protoype. Or, you can switch to the Code mode to use the integrated code editor to edit the Amazon States Language (ASL) definition of your state machine from the Step Functions console.

     Important

     You may need to update the placeholder Amazon Resource Name (ARN) for the resources used in the sample project before you can run your workflow.

   • If you selected Run a demo, Step Functions creates a read-only project which uses an AWS CloudFormation template to deploy the AWS resources in that template to your AWS account. You can view the state machine definition by choosing the Code mode.

     Choose Deploy and run to deploy the project and create the resources.

     Note that deploying can take up to 10 minutes for resources and IAM permissions to be created. While your resources are being deployed, you can open the AWS CloudFormation Stack ID link to see which resources are being provisioned.

     After all the resources have been created, you should see the project on the State machines page in the console.

     Important

     Standard charges may apply for each service used in the CloudFormation template.

Step 2: Run the state machine

1. On the State machines page, choose your sample project.

2. On the sample project page, choose Start execution.

3. In the Start execution dialog box, do the following:

   1. (Optional) To identify your execution, you can specify a name, or use the default generated execution name .

      Note

      Step Functions accepts names for state machines, executions, activities, and labels that contain non-ASCII characters. Because names with non-ASCII characters will not work with Amazon CloudWatch, we recommend using only ASCII charcters so you can track metrics in CloudWatch.

   2. (Optional) In the Input box, enter input values in JSON format to run your workflow.

      If you chose to Run a demo, you need not provide any execution input.

      Note

      If the demo project you deployed contains prepopulated execution input data, use that input to run the state machine.

   3. Choose Start execution.

   4. The Step Functions console directs you to a page that's titled with your execution ID. This page is known as the Execution Details page. On this page, you can review the execution results as the execution progresses or after it's complete.

      To review the execution results, choose individual states on the Graph view, and then choose the individual tabs on the Step details pane to view each state's details including input, output, and definition respectively. For details about the execution information you can view on the Execution Details page, see Execution Details page – Interface overview.

Example State Machine Code

The state machine in this sample project integrates with AWS Batch and Amazon SNS by passing parameters directly to those resources.

Browse through this example state machine to see how Step Functions controls AWS Batch and Amazon SNS by connecting to the Amazon Resource Name (ARN) in the Resource field, and by passing Parameters to the service API.

For more information about how AWS Step Functions can control other AWS services, see Integrating other services with Step Functions.

{
  "Comment": "An example of the Amazon States Language for notification on an AWS Batch job completion",
  "StartAt": "Submit Batch Job",
  "TimeoutSeconds": 3600,
  "States": {
    "Submit Batch Job": {
      "Type": "Task",
      "Resource": "arn:aws:states:::batch:submitJob.sync",
      "Parameters": {
        "JobName": "BatchJobNotification",
        "JobQueue": "arn:aws:batch:us-east-1:123456789012:job-queue/BatchJobQueue-7049d367474b4dd",
        "JobDefinition": "arn:aws:batch:us-east-1:123456789012:job-definition/BatchJobDefinition-74d55ec34c4643c:1"
      },
      "Next": "Notify Success",
      "Catch": [
          {
            "ErrorEquals": [ "States.ALL" ],
            "Next": "Notify Failure"
          }
      ]
    },
    "Notify Success": {
      "Type": "Task",
      "Resource": "arn:aws:states:::sns:publish",
      "Parameters": {
        "Message": "Batch job submitted through Step Functions succeeded",
        "TopicArn": "arn:aws:sns:us-east-1:123456789012:batchjobnotificatiointemplate-SNSTopic-1J757CVBQ2KHM"
      },
      "End": true
    },
    "Notify Failure": {
      "Type": "Task",
      "Resource": "arn:aws:states:::sns:publish",
      "Parameters": {
        "Message": "Batch job submitted through Step Functions failed",
        "TopicArn": "arn:aws:sns:us-east-1:123456789012:batchjobnotificatiointemplate-SNSTopic-1J757CVBQ2KHM"
      },
      "End": true
    }
  }
}

IAM Example

This example AWS Identity and Access Management (IAM) policy generated by the sample project includes the least privilege necessary to execute the state machine and related resources. We recommend that you include only those permissions that are necessary in your IAM policies.

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Action": [
                "sns:Publish"
            ],
            "Resource": [
                "arn:aws:sns:ap-northeast-1:123456789012:ManageBatchJob-SNSTopic-JHLYYG7AZPZI"
            ],
            "Effect": "Allow"
        },
        {
            "Action": [
                "batch:SubmitJob",
                "batch:DescribeJobs",
                "batch:TerminateJob"
            ],
            "Resource": "*",
            "Effect": "Allow"
        },
        {
            "Action": [
                "events:PutTargets",
                "events:PutRule",
                "events:DescribeRule"
            ],
            "Resource": [
                "arn:aws:events:ap-northeast-1:123456789012:rule/StepFunctionsGetEventsForBatchJobsRule"
            ],
            "Effect": "Allow"
        }
    ]
}

For information about how to configure IAM when using Step Functions with other AWS services, see How Step Functions generates IAM policies for integrated services.