Step Functions で Lambda 関数を使用して新しい実行を継続する

1. Lambda コンソールを開き、[関数の作成] を選択します。

2. [関数の作成] ページで、[一から作成] を選択します。

3. [ベーシック情報] セクションで、以下のように Lambda 関数を設定します。

   1. [Function name] (関数名) に Iterator と入力します。

   2. [ランタイム] で [Node.js 16.x] を選択します。

   3. ページのデフォルトの選択をすべて維持して、[関数を作成] を選択します。

      Lambda 関数が作成されたら、ページの右上隅に表示されている Amazon リソースネーム (ARN) を記録します。例:

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

4. Lambda 関数の以下のコードを、Lambda コンソールの [イテレーター] ページの [コードソース] セクションにコピーします。

   exports.handler = function iterator (event, context, callback) {
     let index = event.iterator.index;
     let step = event.iterator.step;
     let count = event.iterator.count;
    
     index = index + step;
    
     callback(null, {
       index,
       step,
       count,
       continue: index < count
     })
   }

   このコードは、count、index、step の入力値を受け入れています。index を step の値増分し、それらの値とブール値 continue を返します。index が count 未満の場合、continue の値は true です。

5. [デプロイ] を選択して、コードをデプロイします。

1. [Configure test event] (テストイベントの設定) ダイアログボックスで、[Create new test event] (新規テストイベントを作成) を選択し、[Event name] (イベント名) に TestIterator と入力します。

2. データ例を以下に置き換えます。

   {
     "Comment": "Test my Iterator function",
     "iterator": {
       "count": 10,
       "index": 5,
       "step": 1
     }
   }
   

   これらの値は、反復でステートマシンから返される値を表します。Lambda 関数はインデックスを増分し、continue を true として返します。インデックスが count 以上になると、continue を false として返します。このテストでは、インデックスは既に 5 に増分されています。結果では、index が 6 に増分され、continue が true に設定されます。

3. [Create] (作成) を選択します。

4. Lambda コンソールの [Iterator] (イテレーター) ページで、[TestIterator] が表示されていることを確認し、[Test] (テスト) を選択します。

   テストの結果がページの上部に表示されます。[Details] (詳細) を選択し、結果を確認します。

   {
     "index": 6,
     "step": 1,
     "count": 10,
     "continue": true
   }
   

   注記

   このテストで index を 9 に設定した場合、index が 10 に増分され、continue が false になります。

1. Lambda コンソールを開き、[関数の作成] を選択します。

2. [関数の作成] ページで、[一から作成] を選択します。

3. [ベーシック情報] セクションで、以下のように Lambda 関数を設定します。

   1. [Function name] (関数名) に Restart と入力します。

   2. [ランタイム] で [Node.js 16.x] を選択します。

4. ページのデフォルトの選択をすべて維持して、[関数を作成] を選択します。

   Lambda 関数が作成されたら、ページの右上隅に表示されている Amazon リソースネーム (ARN) を記録します。例:

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

5. Lambda 関数の以下のコードを、Lambda コンソールの [イテレーター] ページの [コードソース] (設定) セクションにコピーします。

   次のコードは、実行回数を減らし、減少した値を含め、ステートマシンの新しい実行をスタートします。

   var aws = require('aws-sdk');
   var sfn = new aws.StepFunctions();
   
   exports.restart = function(event, context, callback) {
   
     let StateMachineArn = event.restart.StateMachineArn;
     event.restart.executionCount -= 1;
     event = JSON.stringify(event);
   
     let params = {
         input: event,
         stateMachineArn: StateMachineArn
     };
   
     sfn.startExecution(params, function(err, data) {
         if (err) callback(err);
         else callback(null,event);
     });
   
   }

6. [デプロイ] を選択して、コードをデプロイします。

ステートマシンを作成するには

1. Step Functions コンソールを開き、[ステートマシンの作成] を選択します。

   重要

   ステートマシンが、前の ステップ 1 と ステップ 2 で作成した Lambda 関数と同じ AWS アカウントおよびリージョンにあることを確認します。

2. [テンプレートを選択] ダイアログボックスで [空白] を選択します。

3. [選択] を選択して、デザインモード で Workflow Studio を開きます。

4. このチュートリアルでは、コードエディタ でステートマシンの Amazon ステートメント言語 (ASL) 定義を記述します。これを行うには、[コード] を選択します。

5. 既存のボイラープレートコードを削除して、次のコードを貼り付けます。このコードの ARN を、作成した Lambda 関数の ARN に置き換えることに注意してください。

   {
       "Comment": "Continue-as-new State Machine Example",
       "StartAt": "ConfigureCount",
       "States": {
           "ConfigureCount": {
               "Type": "Pass",
               "Result": {
                   "count": 100,
                   "index": -1,
                   "step": 1
               },
               "ResultPath": "$.iterator",
               "Next": "Iterator"
           },
           "Iterator": {
               "Type": "Task",
               "Resource": "arn:aws:lambda:us-east-1:123456789012:function:Iterator",
               "ResultPath": "$.iterator",
               "Next": "IsCountReached"
           },
           "IsCountReached": {
               "Type": "Choice",
               "Choices": [
                   {
                       "Variable": "$.iterator.continue",
                       "BooleanEquals": true,
                       "Next": "ExampleWork"
                   }
               ],
               "Default": "ShouldRestart"
           },
           "ExampleWork": {
               "Comment": "Your application logic, to run a specific number of times",
               "Type": "Pass",
               "Result": {
                 "success": true
               },
               "ResultPath": "$.result",
               "Next": "Iterator"
           },
           "ShouldRestart": {
             "Type": "Choice",
             "Choices": [
               {
                 "Variable": "$.restart.executionCount",
                 "NumericGreaterThan": 0,
                 "Next": "Restart"
               }
             ],
             "Default": "Done"
           },
           "Restart": {
             "Type": "Task",
             "Resource": "arn:aws:lambda:us-east-1:123456789012:function:Restart",
             "Next": "Done"
           },
           "Done": {
               "Type": "Pass",
               "End": true 
           }
       }
   }

6. ステートマシンの名前を指定します。これを行うには、MyStateMachine のデフォルトステートマシン名の横にある編集アイコンを選択します。次に、[ステートマシンの設定] の [ステートマシン名] ボックスに名前を指定します。

   このチュートリアルでは、名前として「ContinueAsNew」と入力します。

7. (オプション) [ステートマシンの設定] で、ステートマシンのタイプや実行ロールなど、他のワークフロー設定を指定します。

   このチュートリアルでは、[ステートマシンの設定] のデフォルト設定をすべてそのまま使用します。

   ステートマシンに適切なアクセス許可を持つ IAM ロールを以前に作成していて、そのロールを使用する場合は、[アクセス許可] で [既存のロールを選択] を選択し、一覧からロールを選択します。または、[ロールの ARN を入力] を選択し、その IAM ロールの ARN を指定します。

8. [ロールの作成を確認] ダイアログボックスで、[確認] を選択して続行します。

   [ロールの設定を表示] を選択して [ステートマシンの設定] に戻ることもできます。

   注記

   Step Functions が作成した IAM ロールを削除すると、Step Functions を後で再作成することはできません。同様に、ロールを変更すると (例えば、IAM ポリシーのプリンシパルから Step Functions を削除するなど)、後で Step Functions でそれを元の設定に復元することはできません。

9. このステートマシンの Amazon リソースネーム (ARN) をテキストファイルに保存します。新しい Step Functions の実行を開始するには、Lambda 関数にアクセス許可を与えると同時に ARN を指定する必要があります。

1. [ContinueAsNew] ページで、[実行を開始] を選択します。

   [実行を開始] ダイアログが表示されます。

2. [実行を開始] ダイアログボックスで、以下の操作を行います。

   1. (オプション) 生成されたデフォルトを上書きするカスタム実行名を入力します。

      非 ASCII 名とログ記録

      Step Functions では、ステートマシン、実行、アクティビティ、ラベルに、ASCII 以外の文字を含む名前を使用できます。このような文字は Amazon CloudWatch では機能しないため、CloudWatch でメトリクスを追跡できるように ASCII 文字のみを使用することをお勧めします。

   2. [入力] ボックスに、次の JSON 入力を入力してワークフローを実行します。

      {
        "restart": {
          "StateMachineArn": "arn:aws:states:us-east-1:123456789012:stateMachine:ContinueAsNew",
          "executionCount": 4
        }
      }
              

   3. ContinueAsNew ステートマシンの ARN を使用して、StateMachineArn フィールドを更新します。

   4. [実行のスタート] を選択します。

   5. Step Functions コンソールから実行 ID のタイトルが付いたページが表示されます。このページは、[実行の詳細] ページと呼ばれます。このページでは、実行の進行中または完了後に実行結果を確認できます。

      実行結果を確認するには、[グラフビュー] で個々の状態を選択し、ステップの詳細 ペインの個々のタブを選択すると、入力、出力、定義などの各状態の詳細がそれぞれ表示されます。[実行の詳細] ページに表示できる実行情報の詳細については、「実行の詳細の概要」を参照してください。

      [グラフビュー] に、4 回のうちの最初の実行が表示されます。完了する前に、Restart 状態がそのまま渡され、新しい実行をスタートします。

      

      この実行が完了すると、実行中の次の実行を確認できます。上部にある ContinueAsNew リンクを選択して、実行のリストを確認します。最近終了した実行と、Restart Lambda 関数が開始した進行中の実行の両方が表示されるはずです。

      すべての実行が完了すると、リストに 4 つの成功した実行が表示されます。最初の実行がスタートされると、選択した名前が表示され、その後の実行には生成された名前が付けられます。