の使用 AWS Step Functions - AWS Toolkit for VS Code
前提条件VS Code でのステートマシンの使用ステートマシンのテンプレートを記しますステートマシンのグラフ可視化を記しますコードスニペットコードの補完と検証

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

の使用 AWS Step Functions

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

前提条件

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

  • AWS Explorer を開く前に、認証情報が設定済みであることを確認します。

VS Code でのステートマシンの使用

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

既存のステートマシンの一覧表示

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

  1. AWS Explorer を開きます。

  2. Step Functions 選択

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

    AWS Explorer menu showing regions and services, with LambdaStateMachine highlighted under Step Functions.

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

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

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

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

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

    AWS Explorer menu showing LambdaStateMachine with Download Definition option highlighted.

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

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

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

  2. [ステップ関数に公開] を選択します。

    JSON code snippet showing state machine configuration with FirstState and ChoiceState.

  3. [クイック作成] を選択し、ロールを選択して、ステートマシンに名前を付けます。

    Quick Create option highlighted for creating a state machine with default settings.
    Dropdown menu showing execution role options, with ECSRole highlighted for selection.
    Dialog box prompting user to name their state machine, with input field and instructions.

ステートマシンの更新

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

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

  2. [ステップ関数に公開] を選択します。

    JSON code snippet showing state machine configuration with FirstState and ChoiceState.

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

    Quick Update option highlighted in the Publish to AWS Step Functions menu.
    Dropdown menu showing state machine options for updating in us-east-1 region.

ステートマシンを実行します

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

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

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

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

    AWS Explorer menu showing LambdaStateMachine with Start Execution option highlighted.
    Start Execution interface for LambdaStateMachine with JSON input option and example.

ステートマシンのテンプレートを記します

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

  1. VS Code で コマンドパレット を開きます。

  2. [AWS Toolkit が新しいステップ関数ステートマシンを作成] を選択します。

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

    List of starter templates including Hello world, Retry failure, Wait state, and others.

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

    Dropdown menu showing JSON and YAML options for selecting a template format.

ステートマシンのグラフ可視化を記します

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

注記

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

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

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

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

  3. 可視化を作成するには、右上にある可視化ボタンを使用するか、[AWS グラフをレンダリング を選択します。

    JSON code and graph visualization of Amazon ステートメント言語 with choice state example.

コードスニペット

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

  1. ファイルを開き、JSON 形式に .asl.json 拡張子を付けて、または YAML 形式に .asl.yaml 拡張子を付けて保存します。

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

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

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

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

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

    Code snippet for Lambda Task State with dropdown menu showing various state types.

コードの補完と検証

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

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

  2. [Next]、[StartAt]、[Default] のいずれかのプロパティの後にカーソルを置きます。

  3. キーの組み合わせ Control + Space を使用して、使用可能な補完を一覧表示します。追加のプロパティは、再度 Control + Space を使用してアクセスすることができ、State の Type に基づいて行われます。

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

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

    • 不正な値

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

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

    JSON code snippet showing state machine structure with task, choice, and default states.
    Code snippet showing AWS Lambda function properties with a tooltip describing the Catch property.