管理批次工作 (AWS Batch、Amazon SNS)

此範例專案示範如何提交 AWS Batch 任務，然後根據任務成功或失敗傳送 Amazon SNS 通知。部署此範例專案將建立 AWS Step Functions 狀態機器、AWS Batch 任務和 Amazon SNS 主題。

在此專案中，Step Functions 會使用狀態機器同步呼叫 AWS Batch 任務。它會等待任務成功或失敗，然後傳送 Amazon SNS 主題，其中包含任務成功或失敗的訊息。

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

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

2. Manage a batch job在搜尋方塊中輸入，然後從傳回的搜尋結果中選擇「管理批次工作」。

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

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

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

   • 一 AWS Batch 份工作

   • Amazon SNS 主題

   • 一个 AWS Step Functions 状态机

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

   下圖顯示「管理批次工作範例專案」的工作流程圖形：

   

5. 選擇「使用範本」繼續進行選取。

6. 執行以下任意一項：

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

     在工作流程 Studio 中設計模式，從拖放狀態狀態瀏覽器以繼續建立您的工作流程原型。或者切換到程式碼模式提供類似 VS 代碼的集成代碼編輯器，用於在 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 的頁面。此頁面稱為「執行詳細資訊」頁面。在此頁面上，您可以在執行進行時或完成之後複查執行結果。

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

範例狀態機器程式碼

此範例專案中的狀態機器會直接將參數傳遞至這些資源，與 AWS Batch 和 Amazon SNS 整合。

瀏覽此範例狀態機器，瞭解 Step Functions 如何透過連線至Resource欄位中的 Amazon 資源名稱 (ARN)，並傳遞至服務 API Parameters 來瞭解步驟函數如何控制 AWS Batch 和 Amazon SNS。

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

{
  "Comment": "An example of the Amazon States Language for notification on an AWS Batch job completion",
  "StartAt": "Submit Batch Job",
  "TimeoutSeconds": 3600,
  "States": {
    "Submit Batch Job": {
      "Type": "Task",
      "Resource": "arn:aws:states:::batch:submitJob.sync",
      "Parameters": {
        "JobName": "BatchJobNotification",
        "JobQueue": "arn:aws:batch:us-east-1:123456789012:job-queue/BatchJobQueue-7049d367474b4dd",
        "JobDefinition": "arn:aws:batch:us-east-1:123456789012:job-definition/BatchJobDefinition-74d55ec34c4643c:1"
      },
      "Next": "Notify Success",
      "Catch": [
          {
            "ErrorEquals": [ "States.ALL" ],
            "Next": "Notify Failure"
          }
      ]
    },
    "Notify Success": {
      "Type": "Task",
      "Resource": "arn:aws:states:::sns:publish",
      "Parameters": {
        "Message": "Batch job submitted through Step Functions succeeded",
        "TopicArn": "arn:aws:sns:us-east-1:123456789012:batchjobnotificatiointemplate-SNSTopic-1J757CVBQ2KHM"
      },
      "End": true
    },
    "Notify Failure": {
      "Type": "Task",
      "Resource": "arn:aws:states:::sns:publish",
      "Parameters": {
        "Message": "Batch job submitted through Step Functions failed",
        "TopicArn": "arn:aws:sns:us-east-1:123456789012:batchjobnotificatiointemplate-SNSTopic-1J757CVBQ2KHM"
      },
      "End": true
    }
  }
}

IAM 範例

範例專案產生的此範例 AWS Identity and Access Management (IAM) 政策包含執行狀態機器及相關資源所需的最低權限。我們建議您僅在 IAM 政策中加入必要的許可。

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Action": [
                "sns:Publish"
            ],
            "Resource": [
                "arn:aws:sns:ap-northeast-1:123456789012:ManageBatchJob-SNSTopic-JHLYYG7AZPZI"
            ],
            "Effect": "Allow"
        },
        {
            "Action": [
                "batch:SubmitJob",
                "batch:DescribeJobs",
                "batch:TerminateJob"
            ],
            "Resource": "*",
            "Effect": "Allow"
        },
        {
            "Action": [
                "events:PutTargets",
                "events:PutRule",
                "events:DescribeRule"
            ],
            "Resource": [
                "arn:aws:events:ap-northeast-1:123456789012:rule/StepFunctionsGetEventsForBatchJobsRule"
            ],
            "Effect": "Allow"
        }
    ]
}

如需將 Step Functions 與其他 AWS 服務搭配使用時如何設定 IAM 的詳細資訊，請參閱整合式服務的 IAM 政策。