「AWS Step Functions」 の使用 - AWS Toolkit for VS Code
Step Functions ステートマシンの表示Step Functions ステートマシンの作成テンプレートからの Step Functions ステートマシンの作成Step Functions ステートマシンのダウンロードStep Functions ステートマシンへの変更の保存Step Functions ステートマシンの実行コードスニペットの使用コード検証

「AWS Step Functions」 の使用

以下のセクションでは、 AWS ツールキットでステートマシン定義を含む AWS Step Functions Amazon State Language (ASL) ファイルを使用する方法について説明します。AWS Step Functions ステートマシンの詳細については、「 AWS Step Functionsデベロッパーガイド」の「Step Functions のステートマシンについて」トピックを参照してください。

Step Functions ステートマシンの表示

AWS ツールキットエクスプローラーでステートマシン定義を含む既存の ASL ファイルを表示するには、次の手順を実行します。

  1. AWS ツールキットエクスプローラーから、表示する ASL ファイルを含むリージョンを展開します。

  2. [Step Functions] の見出しを展開します。

  3. ASL ファイルは AWS エクスプローラーに表示されます。

Step Functions ステートマシンの作成

AWS ツールキットでは、ファイルから新しい Step Functions ステートマシンを作成することも、テンプレートを使用することもできます。次の手順では、 ファイルから Step Functions ステートマシンを作成する方法について説明します。テンプレートから SFN; ステートマシンを作成する方法の詳細については、以下にある本ユーザーガイドトピックの「ステートマシンテンプレート」セクションを参照してください。

注記

VS Code で Step Functions を使用するには、ステートマシン定義を含む Amazon State Language(ASL) ファイルの拡張子が asl.json、asl.yml、または .asl.yaml で終わる必要があります。

デフォルトでは、関連する Step Functions ファイルが Workflow Studio で開きます。AWS ツールキットを介した Workflow Studio の使用の詳細については、本ユーザーガイドの「Workflow Studio の使用」トピックを参照してください。

  1. VS Code のワークスペースから、新しいファイルを作成します。

  2. ファイルに名前を付け、ファイル拡張子を asl.json、asl.yml、または .asl.yaml として指定します。

  3. 作成時に、AWS ツールキットは AWS Step Functions Workflow Studio で新しいファイルを開きます。

  4. Workflow Studio で、ユーティリティメニューから [保存] ボタンを選択して、新しい ASL ファイルを保存します。

テンプレートからの Step Functions ステートマシンの作成

AWS ツールキットでは、テンプレートから Step Functions ステートマシンを作成できます。テンプレートプロセスは、ステートマシン定義を含む ASL ファイルが作成されるため、プロジェクトの開始点とすることができます。次の手順では、 AWS ツールキットでテンプレートから Step Functions ステートマシンを作成する方法について説明します。

  1. AWS ツールキットエクスプローラーから、Step Functions ステートマシンを作成するリージョンを展開します。

  2. [Step Functions] のコンテキストメニューを開き (右クリック）、[新しい Step Functions ステートマシンの作成] を選択して、VS Code で [Select a starter template(1/2)] ウィザードを開きます。

  3. [Select a starter template(1/2)] ウィザードで、Step Functions ステートマシンのテンプレートタイプを選択して続行します。

  4. [Select template format(2/2)] 画面で、テンプレート形式に YAML または JSON を選択します。

  5. ステートマシン定義を含む新しい ASL ファイルが VS Code エディタで開きます。

Step Functions ステートマシンのダウンロード

リモートで保存された Step Functions ステートマシンを VS Code のローカルインスタンスにダウンロードするには、次の手順を実行します。

  1. AWS ツールキットエクスプローラーから、ダウンロードする Step Functions ステートマシンを含むリージョンを展開します。

  2. [Step Functions] を展開し、ダウンロードする Step Functions ステートマシンを右クリックして、定義のダウンロード...] を選択します。

  3. Step Functions ステートマシンをローカルに保存する場所を指定して、続行します。

  4. 手順が完了すると、Step Functions ステートマシンが Workflow Studio で開きます。

Step Functions ステートマシンへの変更の保存

次の手順では、Step Functions ステートマシンに加えた変更を保存する方法について説明します。

注記

Workflow Studio で行われた編集はローカルファイルに同期されますが、VS Code エディタまたは Workflow Studio で作業を保存するまでは保存されません。Workflow Studio が開いているときにローカルファイルが変更および保存され、ASL ファイルにエラーが検出されない場合、保存が完了すると Workflow Studio に [成功] 通知が送信されます。ただし、ローカルファイルに無効な JSON または YAML が含まれている状態で保存しようとすると、ローカルファイルは同期に失敗し、Workflow Studio に [警告] 通知が送信されます。

  1. Workflow Studio のステートマシン定義を含む、開いた状態の ASL ファイルから、ユーティリティボタンに移動します。

  2. [保存] ボタンを選択します。

  3. VS Code は、ファイルが保存されたときに通知します。

Step Functions ステートマシンの実行

次の手順では、 AWS ツールキットで Step Functions ステートマシンを実行する方法について説明します。

  1. AWS ツールキットエクスプローラーから、実行する Step Functions ステートマシンを含むリージョンを展開します。

  2. [Step Functions] を展開し、実行する Step Functions ステートマシンを右クリックします。

  3. コンテキストメニューから、[実行の開始] を選択して起動プロセスを開始します。

  4. 起動のステータスは、VS Code の [AWS Toolkit Output] ウィンドウに表示されます。

コードスニペットの使用

コードスニペットは、使用しているコードに基づいて自動で生成される提案です。ツールキットの Step Functions でコードスニペットを使用するには、次の手順を実行します。

注記

VS Code で Step Functions コードスニペットを使用するには、ステートマシン定義を含む ASL ファイルの拡張子が .asl.json、.asl.yml、または .asl.yaml で終わる必要があります。

デフォルトでは、関連する Step Functions ファイルが Workflow Studio で開きます。

  1. VS Code から、変更する、または新しい ASL ファイルを作成するステートマシン定義を含む ASL ファイルを開きます。

  2. Workflow Studio で、現在が [設計] モードの場合は [コード] モードに切り替えます。

  3. Workflow Studio のコードエディタで、 "States" プロパティにカーソルを置きます。

  4. control + space を押してコードスニペットメニューを開きます。control + space を押すことで、"State" "Type" に基づく追加のプロパティにアクセスできます。

  5. リストから目的のコードスニペットを選択します。

コード検証

Workflow Studio で Step Functions を使用すると、コード検証によってエラーがアクティブに識別され、次の提案が行われます。

  • 不足しているプロパティ

  • 不正な値

  • 非ターミナル状態

  • 存在しない参照先ステート