Task ワークフロー状態

Task 状態 ("Type": "Task") は、ステートマシンによって実行される単一の作業単位を表します。タスクは、アクティビティや AWS Lambda 関数を使用して、サポート対象 AWS のサービス と統合して、または Stripe のような HTTPS API を呼び出すことにより、処理を実行します。

Amazon States Language は、ステートのタイプを Task に設定し、タスクにアクティビティ、Lambda 関数、または HTTPS API エンドポイントの Amazon リソースネーム (ARN) を指定することによりタスクを表します。

JSONata の Arguments を使用して関数を呼び出す

次の Task ステート定義 (JSONata) は、priceWatcher という名前の Lambda 関数を呼び出します。

Arguments で使用する入力データや、assign フィールドで使用するタスクの結果を取得するために、JSONata 式を使用している点に注目してください。

"Get Current Price": {
  "Type": "Task",
  "QueryLanguage" : "JSONata",
  "Resource": "arn:aws:states:::lambda:invoke",
  "Next": "Check Price",
  "Arguments": {
    "Payload": {
    "product": "{% $states.context.Execution.Input.product %}"
    },
    "FunctionName": "arn:aws:lambda:<region>:account-id:function:priceWatcher:$LATEST"
  },
  "Assign": {
    "currentPrice": "{% $states.result.Payload.current_price %}"
  }
}

JSONPath パラメータを使用して関数を呼び出す

次の Task ステート定義 (JSONPath) は、HelloFunction という名前の Lambda 関数を呼び出します。

"Lambda Invoke": {
  "Type": "Task",
  "Resource": "arn:aws:states:::lambda:invoke",
  "Parameters": {
    "Payload.$": "$",
    "FunctionName": "arn:aws:lambda:region:account-id:function:HelloFunction:$LATEST"
  },
  "End": true
}

タスクタイプ

Step Functions では、Task 状態定義内で指定できる次のタスクタイプをサポートしています。

タスクタイプを指定するには、タスク状態定義の Resource フィールドに ARN を指定します。次の例は、Resource フィールドの構文を示しています。HTTPS API を呼び出すタスクタイプを除くすべてのタスクタイプは、次の構文を使用します。HTTP 構文の詳細については、「Step Functions ワークフローで HTTPS API を呼び出す」を参照してください。

タスク状態定義で、次の構文のイタリック体のテキストを、AWS リソース固有の情報に置き換えます。

arn:partition:service:region:account:task_type:name

次のリストでは、この構文の個々のコンポーネントについて説明します。

次のセクションでは、各タスクタイプの詳細を示します。

アクティビティ

アクティビティは、お客様によって実装およびホストされ、特定のタスクを実行するワーカー (プロセスまたはスレッド) を示します。標準ワークフローでのみサポートされ、Express ワークフローではサポートされません。

アクティビティ Resource ARN は以下の構文を使用します。

arn:partition:states:region:account:activity:name

アクティビティの作成とワーカーの実装の詳細については、アクティビティを参照してください。

Lambda 関数

Lambda タスクでは AWS Lambda を使用して関数を実行します。Lambda 関数を指定するには、Resource フィールドの Lambda 関数の ARN を使用します。

Lambda 関数の Resource フィールドの形式は統合のタイプによって異なります。

標準 AWS SDK 統合で Lambda 関数を使用する場合、Resource フィールドには次の値を指定します。

"arn:aws:states:::aws-sdk:lambda:invoke"

Lambda 関数には最適化統合を使用することをお勧めします。Resource フィールドには次の値を指定します。

"arn:aws:states:::lambda:invoke"

次の Task ステート定義は、HelloWorld という名前の Lambda 関数との JSONata を使用した最適化統合の例です。

"Optimized call to Lambda function (JSONata)": {
      "Type": "Task",
      "Resource": "arn:aws:states:::lambda:invoke",
      "Output": "{% $states.result.Payload %}",
      "Arguments": {
        "FunctionName": "arn:aws:lambda:region:account-id:function:HelloWorld:$LATEST",
        "Payload": {
          "key": "{% $states.input.myKey %}"
        }
      },
  "Next": "NextState"
}

サポート対象の AWS のサービス

接続されたリソースをリファレンスすると、Step Functions によって、サポートされたサービスの API アクションが直接呼び出されます。Resource フィールドでサービスとアクションを指定します。

接続されたサービス Resource ARN では以下の構文を使用します。

arn:partition:states:region:account-id:servicename:APIname

例:

{
 "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",
       "RetryStrategy": {
          "attempts": 5
        }
     },
     "End": true
    }
  }
}

タスク状態フィールド

[common state fields] (共通状態フィールド) に加えて、Task 状態には次のフィールドがあります。

Task 状態は、その状態で実行が終了する場合は End フィールドが true に設定されている必要があります。または、Next フィールドに、Task 状態が完了した際に実行される状態を指定する必要があります。

タスク状態定義の例

次の例は、要件に基づいてタスク状態定義を指定する方法を示しています。

タスク状態のタイムアウトとハートビート間隔

長時間実行されるアクティビティでは、タイムアウト値とハートビート間隔を設定することをお勧めします。これは、タイムアウトとハートビート値を指定するか、動的に設定することによって実行できます。

静的タイムアウトとハートビート通知の例

HelloWorld が完了すると、次の状態 (ここでは NextState と呼ばれます) が実行されます。

このタスクが 300 秒以内に完了しなかった場合、または 60 秒間隔のハートビート通知を送信しなかった場合、タスクは failed とマークされます。

"ActivityState": {
  "Type": "Task",
  "Resource": "arn:aws:states:region:123456789012:activity:HelloWorld",
  "TimeoutSeconds": 300,
  "HeartbeatSeconds": 60,
  "Next": "NextState"
}

動的タスクタイムアウトとハートビート通知の例

この例では、AWS Glue ジョブが完了すると、次の状態が実行されます。

このタスクが、AWS Glue ジョブによって動的に設定された間隔内に完了しなかった場合、タスクは failed としてマークされます。

"GlueJobTask": {
  "Type": "Task",
  "Resource": "arn:aws:states:::glue:startJobRun.sync",
  "Parameters": {
    "JobName": "myGlueJob"
  },
  "TimeoutSecondsPath": "$.params.maxTime",
  "Next": "NextState"
}

タスク状態の認証情報フィールドの例

ハードコーディングされた IAM ロール ARN の指定

次の例では、ステートマシンの実行ロールが Echo という名前のクロスアカウント Lambda 関数にアクセスするために継承する必要がある、ターゲット IAM ロールを指定します。この例では、ターゲットロールの ARN はハードコードされた値として指定されています。

{
  "StartAt": "Cross-account call",
  "States": {
    "Cross-account call": {
      "Type": "Task",
      "Resource": "arn:aws:states:::lambda:invoke",
      "Credentials": {
        "RoleArn": "arn:aws:iam::111122223333:role/LambdaRole"
      },
      "Parameters": {
        "FunctionName": "arn:aws:lambda:us-east-2:111122223333:function:Echo"
      },
      "End": true
    }
  }
}

IAM ロール ARN として JSONPath を指定

次の例では、実行時に IAM ロール ARN を解決する JSONPath 値を指定します。

{
  "StartAt": "Lambda",
  "States": {
    "Lambda": {
      "Type": "Task",
      "Resource": "arn:aws:states:::lambda:invoke",
      "Credentials": {
        "RoleArn.$": "$.roleArn"
      },
      ...
    }
  }
}

組み込み関数を IAM ロール ARN として指定する

次の例では、実行時に IAM ロール ARN を解決する、States.Format 組み込み関数を使用しています。

{
  "StartAt": "Lambda",
  "States": {
    "Lambda": {
      "Type": "Task",
      "Resource": "arn:aws:states:::lambda:invoke",
      "Credentials": {
        "RoleArn.$": "States.Format('arn:aws:iam::{}:role/ROLENAME', $.accountId)"
      },
      ...
    }
  }
}