View a markdown version of this page

GetJob - Amazon Location Service

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

GetJob

GetJob 操作會擷取特定任務的相關資訊,包括其目前狀態、組態、時間戳記和任何錯誤資訊。使用此操作來監控任務進度並驗證組態詳細資訊。對於已完成的任務,您可以使用此資訊在存取結果之前驗證成功處理。

如需詳細資訊,請參閱《Amazon Location Service API 參考》中的 GetJob

如需此 API 的請求、回應和 CLI 命令範例,請參閱如何監控任務進度

使用案例

  • 任務狀態和進度監控:追蹤任務生命週期進度,直到待定、執行中和完成狀態,以判斷處理完成的時間和結果可供下載。監控工作流程管理和報告的任務狀態。

  • 錯誤診斷:在任務失敗時擷取詳細的錯誤資訊,包括疑難排解處理問題的特定錯誤訊息和失敗原因。

  • 組態驗證:在開始處理之前,確認任務組態詳細資訊,包括輸入/輸出位置、執行角色和請求的功能。

了解請求

GetJob 請求只需要單一參數,即可擷取特定任務的完整資訊。這個簡單的請求結構可讓您輕鬆監控任務狀態,並擷取詳細的組態和處理資訊。

請求包含下列參數:

任務識別

指定要擷取資訊之任務的必要參數。

  • JobId:要擷取之任務的唯一識別符。必須是 1-100 個字元符合模式 [-._\w]+。這是建立任務時, StartJob操作傳回的相同識別符。

了解回應

GetJob 回應提供指定任務的相關資訊,包括其目前狀態、完整組態、處理時間戳記和任何錯誤資訊。您可以使用此回應來監控任務狀態,並對可能發生的任何錯誤進行疑難排解。

回應包含下列欄位:

任務識別

唯一識別符和基本任務資訊。

  • JobId:用於監控和管理操作的唯一任務識別符。

  • JobArn:唯一識別其中任務的 ARN AWS。

  • Name:如果在建立任務期間指定,則為人類可讀取的任務名稱。

任務狀態和生命週期

目前的任務狀態和處理時間軸資訊。

  • Status:指出處理狀態的目前任務狀態 (擱置中、執行中、已完成、失敗、取消或取消)。

  • CreatedAt:ISO 8601 格式的任務建立時間戳記。

  • UpdatedAt:ISO 8601 格式的上次狀態更新時間戳記。

  • EndedAt:ISO 8601 格式的任務完成時間戳記。僅適用於處於終端機狀態的任務。

任務組態

完成建立期間指定的任務組態。

  • Action:正在執行的操作類型 (目前僅ValidateAddress支援 )。

  • ExecutionRoleArn:用於在任務執行期間存取 Amazon S3 儲存貯體的 IAM 角色 ARN。

  • InputOptions:輸入組態,包括 Amazon S3 位置和資料格式。

  • OutputOptions:輸出組態,包括 Amazon S3 目的地和結果格式。

  • ActionOptions:為任務請求的選用其他功能,例如 PositionCountrySpecificAttributes

錯誤資訊

當任務失敗時,回應會包含錯誤詳細資訊,以協助您診斷和解決問題。

  • Error:包含失敗詳細資訊的JobError物件。此物件包含下列欄位:

    • Code:識別失敗類型的錯誤代碼。

    • Messages:人類可讀取訊息的清單,提供其他內容以進行故障診斷。