Manage AWS Batch with Step Functions

Step Functions can control certain AWS services directly from the Amazon States Language. For more information about working with AWS Step Functions and its integrations, see the following:

• Working with other services

• Pass Parameters to a Service API

Supported AWS Batch APIs:

How the Optimized AWS Batch integration is different than the AWS BatchAWS SDK integration

• The Run a Job (.sync) integration pattern is available.

Note that there are no optimizations for the Request Response or Wait for a Callback with the Task Token integration patterns.

Note

Parameters in Step Functions are expressed in PascalCase, even when the native service API is camelCase.

• SubmitJob

  • Request syntax

  • Supported parameters:

    • ArrayProperties

    • ContainerOverrides

    • DependsOn

    • JobDefinition

    • JobName

    • JobQueue

    • Parameters

    • RetryStrategy

    • Timeout

  • Response syntax

The following includes a Task state that submits an AWS Batch job and waits for it to complete.

{
  "StartAt": "BATCH_JOB",
  "States": {
    "BATCH_JOB": {
      "Type": "Task",
      "Resource": "arn:aws:states:::batch:submitJob.sync",
      "Parameters": {
        "JobDefinition": "preprocessing",
        "JobName": "PreprocessingBatchJob",
        "JobQueue": "SecondaryQueue",
        "Parameters.$": "$.batchjob.parameters",
        "ContainerOverrides": {
          "ResourceRequirements": [
            {
              "Type": "VCPU",
              "Value": "4"
            }
          ]
        }
      },
      "End": true
    }
  }
}

For information on how to configure IAM when using Step Functions with other AWS services, see IAM Policies for integrated services.