回呼模式範例 (Amazon SQS、Amazon SNS、Lambda) - AWS Step Functions

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

回呼模式範例 (Amazon SQS、Amazon SNS、Lambda)

此範例專案示範如何在工作期間 AWS Step Functions 暫停,並等待外部處理序傳回工作開始時產生的工作 Token。

當這個範例專案部署完成且開始執行後,便會發生下列步驟。

  1. Step Functions 會將包含任務權杖的訊息傳遞至 Amazon Simple Queue Service (Amazon SQS) 佇列。

  2. Step Functions 然後暫停,等待返回該令牌。

  3. Amazon SQS 佇列會觸發SendTaskSuccess使用相同任務權杖呼叫的 AWS Lambda 函數。

  4. 當收到該任務字符時,工作流程就會繼續進行。

  5. "Notify Success"任務會發佈 Amazon Simple Notification Service (Amazon SNS) 訊息,表示已收到回呼。

若要瞭解如何在 Step Functions 式中實作回呼模式,請參閱等候傳回任務字符的回呼

如需如何 AWS Step Functions 控制其他 AWS 服務的詳細資訊,請參閱AWS Step Functions 搭配其他服務使用

步驟 1:建立狀態機器並佈建資源

  1. 開啟 Step Functions 主控台,然後選擇建立狀態機器

  2. Callback pattern example在搜尋方塊中輸入,然後從傳回的搜尋結果中選擇「回呼」模式範例

  3. 選擇 Next (下一步) 繼續。

  4. Step Functions 會列出您選取的範例專案中 AWS 服務 使用的項目。它也會顯示範例專案的工作流程圖表。將此項目部署到您的項目中, AWS 帳戶 或將其用作構建自己的項目的起點。根據您想要的進行方式,選擇 [執行示範] 或 [在其上建置]。

    此範例專案會部署下列資源:

    • Amazon SQS 訊息佇列。

    • 呼叫 Step Functions 函數 API 動作的 Lambda 函數SendTaskSuccess

    • Amazon SNS 主題,用於通知任務成功或失敗,指出工作流程是否可以繼續。

    • 一个 AWS Step Functions 状态机

    • 相關的 AWS Identity and Access Management (IAM) 角色

    下圖顯示回呼模式範例專案範例專案的工作流程圖形:

    
            管理批次作業範例專案的工作流程圖。
  5. 選擇「使用範本」繼續進行選取。

  6. 執行以下任意一項:

    • 如果您選取「在其上建置」,「Step Functions」會為您選取的範例專案建立工作流程原型。Step Functions 不會部署工作流程定義中列出的資源。

      在工作流程 Studio 中設計模式,從拖放狀態狀態瀏覽器以繼續建立您的工作流程原型。或者切換到提供類似 VS Code 的整合式程式碼編輯器,以便在 Step Functions 主控台中更新狀態機器的 Amazon States Language (ASL) 定義。程式碼模式如需有關使用工作流程 Studio 建置狀態機器的詳細資訊,請參閱使用工作流程

      重要

      請記得在執行工作流程之前,更新範例專案中使用之資源的預留位置 Amazon 資源名稱 (ARN)。

    • 如果您選取 [執行示範],Step Functions 會建立唯讀範例專案,該專案會使用 AWS CloudFormation 範本將該範本中列出的 AWS 資源部署到您的 AWS 帳戶.

      提示

      若要檢視範例專案的狀態機定義,請選擇 [程式碼]。

      準備就緒後,請選擇 [部署並執行] 以部署範例專案並建立資源。

      建立這些資源和相關 IAM 許可最多可能需要 10 分鐘的時間。部署資源時,您可以開啟 CloudFormation Stack ID 連結以查看正在佈建的資源。

      建立範例專案中的所有資源之後,您可以在 [狀態機器] 頁面上看到列出的新範例專案。

      重要

      CloudFormation 範本中使用的每項服務可能會收取標準費用。

步驟 2:運行狀態機

  1. 在 [狀態電腦] 頁面上,選擇您的範例專案。

  2. 在範例專案頁面上,選擇 [開始執行]。

  3. 在 [開始執行] 對話方塊中,執行下列動作:

    1. (選擇性) 若要識別您的執行項目,您可以在「名稱」(Name) 方塊中指定執行項目的名稱。默認情況下,Step Functions 自動生成一個唯一的執行名稱。

      注意

      Step Functions 可讓您建立狀態機器、執行項目和活動的名稱,以及包含非 ASCII 字元的標籤。這些非 ASCII 名稱不適用於 Amazon CloudWatch。若要確保您可以追蹤 CloudWatch 量度,請選擇僅使用 ASCII 字元的名稱。

    2. (選擇性) 在「入」方塊中,以 JSON 格式輸入輸入值以執行工作流程。

      如果您選擇執行示範,則不需要提供任何執行輸入。

      注意

      如果您部署的示範專案包含預先填入的執行輸入資料,請使用該輸入來執行狀態機器。

    3. 選擇 Start execution (開始執行)

    4. 「Step Functions」主控台會將您引導至標題為執行 ID 的頁面。此頁面稱為「執行詳細資訊」頁面。在此頁面上,您可以在執行進行時或完成之後複查執行結果。

      若要複查執行結果,請在「圖形」檢視中選擇個別狀態,然後選擇步驟詳情窗格上的個別索引標籤,分別檢視每個狀態的詳細資訊,包括輸入、輸出和定義。如需有關可在「執行詳細資訊」頁面檢視之執行資訊的詳細資訊,請參閱執行詳細資訊頁面 — 介面概觀

    例如,若要檢閱 Step Functions 如何在工作流程中進行,並從 Amazon SQS 接收回呼,請檢閱「事件」表中的項目。下圖顯示「通知成功」步驟的執行輸出。它還顯示執行事件歷史記錄中的前五個事件。展開每個事件以檢視有關該事件的更多詳細資料。

    
            在「圖形」檢視中選取之「通知成功」步驟的執行輸出摘錄。此影像也會顯示 Callback 模式範例範例專案之執行事件歷程記錄的摘錄。

Lambda 回調示例

若要查看此範例專案的元件如何協同運作,請參閱您 AWS 帳戶中部署的資源。例如,以下是使用工作權杖呼叫 Step Functions 數的 Lambda 函數。

console.log('Loading function'); const aws = require('aws-sdk'); exports.lambda_handler = (event, context, callback) => { const stepfunctions = new aws.StepFunctions(); for (const record of event.Records) { const messageBody = JSON.parse(record.body); const taskToken = messageBody.TaskToken; const params = { output: "\"Callback task completed successfully.\"", taskToken: taskToken }; console.log(`Calling Step Functions to complete callback task with params ${JSON.stringify(params)}`); stepfunctions.sendTaskSuccess(params, (err, data) => { if (err) { console.error(err.message); callback(err.message); return; } console.log(data); callback(null); }); } };