フロー実行を使用して Amazon Bedrock フローを非同期で実行する

フロー実行を開始する

フロー実行を実行するには、Amazon Bedrock エージェントのランタイムエンドポイントを使用して StartFlowExecution リクエストを送信します。リクエストで、実行するフローのフロー ID とフローエイリアス ID を指定します。以下を指定することもできます。

{
    "inputs": [{
        "nodeName": "FlowInputNode",
        "nodeOutputName": "document",
        "content": {
            "document": "Test"
        }
    }],
    "name": "MyExecution"
}

レスポンスは、フロー実行の Amazon リソースネーム (ARN) です。フローの実行が終了したときや条件ノードが条件を評価するときなどに、executionArn を使用してフローの現在の状態をポーリングできます。

{
      "executionArn": "arn:aws:bedrock:us-west-2:111122223333:flow/FLOWID/alias/TSTALIASID/execution/MyExecution"
}

フロー実行の進行状況を追跡する

GetFlowExecution オペレーションを使用して、実行 ARN で識別したフローの現在のステータスを取得します。フローステータスは、Running、Succeeded、Failed、TimedOut、または Aborted のいずれかです。

{
      "endedAt": null,
      "errors": null,
      "executionArn": "arn:aws:bedrock:us-west-2:111122223333:flow/FLOWID/alias/TSTALIASID/execution/MyExecution",
      "flowAliasIdentifier": "TSTALIASID",
      "flowIdentifier": "FLOWID",
      "flowVersion": "DRAFT",
      "startedAt": "2025-03-20T23:32:28.899221162Z",
      "status": "Running"
}

エラー (タイムアウトする Lambda ノードなど) は、次の例のように errors 配列で返されます。

"errors": [{
    "nodeName": "LambdaNode1",
    "errorType": "ExecutionTimedOut",
    "message": "Call to lambda function timed out"
}],

フロー実行の結果を取得する

Amazon Bedrock は、フローの出力をフローの出力ノードに書き込みます。フローが完了時、またはフローの実行中に (ユースケースに応じて)、出力を取得できます。

最初にフローを完了させる場合は、GetFlowExecution を呼び出し、レスポンスの status フィールドの値が Succeeded であることを確認します。

フロー実行から出力イベントのリストを取得するには、ListFlowExecutionEvents を呼び出します。レスポンスで、flowExecutionEvents の flowOutputEvent オブジェクトを確認します。例えば、content フィールドでフローの出力を取得できます。

{
      "flowOutputEvent": {
        "content": {
          "document": "The model response."
        },
        "nodeName": "FlowOutputNode"
      }
}

eventType クエリパラメータを Flow に設定することで、ListFlowExecutions からの出力を入力ノードと出力ノードのみに制限できます。

イベントの表示

フロー実行のデバッグに役立つように、ListFlowExecutionEvents オペレーションを使用して、フローの実行中にノードが生成するイベントを表示できます。eventType クエリパラメータを Node に設定すると、次の例のようなレスポンスのすべてのノード (中間ノードを含む) の入力と出力が表示されます。

{
    "flowExecutionEvents": [{
            "nodeOutputEvent": {
                "fields": [{
                    "content": {
                        "document": "History book"
                    },
                    "name": "document"
                }],
                "nodeName": "FlowInputNode",
                "timestamp": "2025-05-05T18:38:56.637867516Z"
            }
        },
        {
            "nodeInputEvent": {
                "fields": [{
                    "content": {
                        "document": "History book"
                    },
                    "name": "book"
                }],
                "nodeName": "Prompt_1",
                "timestamp": "2025-05-05T18:38:57.434600163Z"
            }
        },
        {
            "nodeOutputEvent": {
                "fields": [{
                    "content": {
                        "document": "Here's a summary of the history book."
                    },
                    "name": "modelCompletion"
                }],
                "nodeName": "Prompt_1",
                "timestamp": "2025-05-05T18:39:06.034157077Z"
            }
        },
        {
            "nodeInputEvent": {
                "fields": [{
                    "content": {
                        "document": "Here's a summary of the history book."
                    },
                    "name": "document"
                }],
                "nodeName": "FlowOutputNode",
                "timestamp": "2025-05-05T18:39:06.453128251Z"
            }
        }
    ]
}

フロー実行のスナップショットを取得する

Amazon Bedrock は、フロー実行が開始されると、フロー定義とメタデータのスナップショットを自動的に作成します。これは、フローが非同期で実行中に更新できるため便利です。このスナップショットを取得するには、GetExecutionFlowSnapshot オペレーションを呼び出します。レスポンスには、以下のフローフィールドが含まれます。

{
      "customerEncryptionKeyArn": null,
      "definition": "{flow-definition}",
      "executionRoleArn": "arn:aws:iam::111122223333:role/name",
      "flowAliasIdentifier": "TSTALIASID",
      "flowIdentifier": "FLOWID",
      "flowVersion": "DRAFT"
}

フロー実行を一覧表示する

ListFlowExecutions オペレーションを呼び出すことで、フロー実行のリストを取得できます。レスポンスには、フローまたはフローエイリアスの現在の AWS リージョン の各フロー実行に関する情報を含む flowExecutionSummaries 配列が含まれます。各要素には、実行 ARN、開始時刻、フローの現在のステータスなどの情報が含まれます。

{
    "flowExecutionSummaries": [{
        "createdAt": "2025-03-11T23:21:02.875598966Z",
        "endedAt": null,
        "executionArn": "arn:aws:bedrock:us-west-2:111122223333:flow/FLOWID/alias/TSTALIASID/execution/MyExecution",
        "flowAliasIdentifier": "TSTALIASID",
        "flowIdentifier": "FLOWID",
        "flowVersion": "DRAFT",
        "status": "Running"
    }]
}

実行中のフロー実行を停止する

実行中のフロー実行を停止する必要がある場合は、StopFlowExecution オペレーションを呼び出し、停止する実行のフロー ID、フローエイリアス ID、およびフロー実行 ID を渡します。