AWS Step Functions の使用 - AWSToolkit for VS Code

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

AWS Step Functions の使用

♪ AWS Toolkit for Visual Studio Code (VS Code) でさまざまなオペレーションを実行しますステートマシン

Prerequisites

  • システムが「」で指定されている前提条件を満たしていることを確認してください。VS Code Toolkit for をインストールするをクリックし、ツールキットをインストールします。

  • を開く前に、クレデンシャルが設定済みであることを確認します。AWSExplorer

VS Code でステートマシンを操作する

VS コードを使用して、リモートステートマシンとやり取りし、JSON または YAML 形式でローカルでステートマシンを開発できます。ステートマシンの作成または更新、既存のステートマシンの一覧表示、実行、およびダウンロードを行うことができます。VS Code を使用して、テンプレートから新しいステートマシンを作成したり、ステートマシンを可視化したり、コードスニペット、コード補完、コード検証を行ったりすることもできます。

既存のステートマシンをリストする

作成済みのステートマシンがある場合は、それらを一覧表示できます。

  1. を開くAWSExplorer

  2. Step Functions 選択

  3. アカウント内のすべてのステートマシンが一覧表示されていることを確認します。

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

ステートマシンをダウンロードするには

  1. AWSExplorerで、ダウンロードするステートマシンを右クリックします。

  2. [Download] を選択し、ステートマシンのダウンロード先を選択します。

  3. 正常にダウンロードされたことを確認します。

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

新しいステートマシンは、自分で作成するか、テンプレートを使用して作成できます。テンプレートからステートマシンを作成する方法の詳細については、「ステートマシンのテンプレート」セクションを参照してください。新しいステートマシンを作成するには

  1. ステートマシン定義を含む新しい Amazon ステート言語 (ASL) ファイルを作成します。右下のメニューを使用して、それを Amazon ステート言語として設定します。

  2. [Publish to Step Functions] を選択します。

  3. [Quick Create] を選択し、ロールを選択して、ステートマシンに名前を付けます。

ステートマシンの更新

ステートマシンを更新するには

  1. ステートマシン定義を含む ASL ファイルを編集します。

  2. [Publish to Step Functions] を選択します。

  3. [Quick Update] を選択し、更新するステートマシンを選択します。

ステートマシンを実行する。

ステートマシンを実行するには

  1. AWSExplorerで、実行するステートマシンを右クリックします。

  2. ステートマシンの入力を指定します。ファイルからの入力と、テキストボックスへの入力の両方を試すことができます。

  3. ステートマシンを起動し、正常に実行されていることを確認します。

ステートマシンのテンプレート

ステートマシンを作成する場合、テンプレートから作成することを選択できます。テンプレートには、よく使用されるいくつかのステートが設定されたサンプルのステートマシン定義が含まれており、ここから作成を開始できます。ステートマシンテンプレートを使用するには

  1. を開くコマンドパレットVSコードで。

  2. SelectAWS: Step Functions ステートマシンを新規作成します

  3. 使用するテンプレートを選択します。

  4. JSON または YAML テンプレート形式のどちらを使用するかを選択します。

ステートマシングラフの可視化

グラフ可視化を使用すると、ステートマシンの外観をグラフ形式で確認できます。グラフ可視化を作成すると、別のタブが開いて、ステートマシン JSON または YAML の可視化が表示されます。記述しているステートマシンの定義を、その可視化と並行して比較できます。ステートマシン定義を変更すると、可視化が更新されます。

注記

ステートマシン定義の可視化を作成するには、その定義をアクティブなエディタで開いておく必要があります。定義ファイルを閉じたり、名前を変更したりすると、可視化が閉じます。

ステートマシンのグラフ可視化を作成するには

  1. ステートマシンを定義します。

  2. を開くコマンドパレットVSコードで。

  3. ビジュアライゼーションを作成するには、右上隅にあるビジュアライゼーションボタンを使用するか、AWSステートマシンのグラフのプレビュー

コードスニペット

コードスニペットを使用すると、コードの短いセクションを挿入できます。コードスニペットを使用するには

  1. ファイルを開き、拡張子を付けて保存します。.asl.jsonJSON 形式の場合、または.asl.yamlYAML 形式の場合。

  2. States プロパティを使用して新しいステートマシンを作成します。

  3. [States] 内にカーソルを置きます。

  4. キーの組み合わせ Control + Space を使用して、必要なコードスニペットを選択します。

  5. Tab を使用して、コードスニペットの変数とパラメータをスキャンします。

  6. 関連するステート内にカーソルを置いて、Retry スニペットと Catch スニペットをテストします。

コードの補完と検証

コード補完の動作を確認するには

  1. 複数のステートを作成します。

  2. NextStartAtDefault のいずれかのプロパティの後にカーソルを置きます。

  3. キーの組み合わせ Control + Space を使用して、使用可能な補完を一覧表示します。その他のプロパティにアクセスするには、Control + Space を再び使用します。StateType 別にアクセスできます。

  4. 作業を進めるに従って、以下に関するコード検証が実行されます。

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

    • 不正な値

    • 存在しない最終ステート

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