本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
ListJobs
ListJobs 操作會擷取具有選用篩選功能的分頁任務清單。您可以依任務狀態進行篩選,並控制傳回的結果數目。此操作透過下一個權杖支援分頁,可讓您有效率地擷取大型任務清單。
如需詳細資訊,請參閱《Amazon Location Service API 參考》中的 ListJobs。
如需此 API 的請求、回應和 CLI 命令範例,請參閱如何列出任務。
使用案例
-
任務庫存管理:擷取所有任務以稽核處理歷史記錄,並追蹤驗證操作的資源使用率。
-
狀態型監控:依狀態篩選任務,以識別需要注意的執行中任務或準備擷取結果的已完成任務。
-
操作報告:產生任務執行模式、成功率和處理業務分析磁碟區的報告。
-
故障診斷和偵錯:列出失敗的任務,以識別處理錯誤中的模式並診斷系統性問題。
了解請求
ListJobs 請求接受篩選和分頁的選用參數。如果沒有任何參數,操作會傳回具有預設分頁的所有任務。
請求包含下列選用參數:
- 篩選選項
-
用於縮小傳回任務清單的選用參數。
-
Filter:包含篩選條件的物件。-
JobStatus:依任務的目前狀態篩選任務。有效值:Pending、Running、Completed、Cancelling、Failed或Cancelled。
-
-
- 分頁控制項
-
用於控制結果分頁的選用參數。
-
MaxResults:在單一回應中傳回的任務數量上限。使用此值可控制大型結果集的頁面大小。 -
NextToken:上一個ListJobs回應的分頁字符。包含此字符以擷取結果的下一頁。
-
了解回應
ListJobs 回應提供任務摘要的分頁清單,其中包含每個任務的組態和狀態資訊。當有更多結果可用時,請使用下一個字符來擷取其他頁面。
回應包含下列欄位:
- 任務清單
-
符合篩選條件的任務摘要陣列。
-
Entries:任務摘要陣列,包括:-
Action:任務執行的動作。 -
CreatedAt:ISO 8601 格式的任務建立時間戳記。 -
EndedAt:ISO 8601 格式的任務完成時間戳記。僅適用於處於終端狀態 (已完成、失敗或已取消) 的任務。 -
ExecutionRoleArn:用於執行的 IAM 角色。 -
InputOptions:輸入組態物件。 -
JobArn:任務的 Amazon Resource Name (ARN)。 -
JobId:唯一的任務識別符。 -
Name:如果在建立期間提供,則為任務名稱。 -
OutputOptions:輸出組態物件。 -
Status:目前的任務狀態。 -
UpdatedAt:ISO 8601 格式的上次更新時間戳記。 -
ActionOptions:若有其他 功能請求,則為 。
-
-
- 分頁字符
-
用於擷取其他結果的字符。
-
NextToken:要包含在下一個ListJobs請求中的權杖,以擷取結果的下一頁。此欄位只有在有更多結果可用時才存在。缺少此欄位表示您已擷取最後一頁。
-
注意
結果會維持跨頁面的一致排序。在後續請求中使用NextToken每個回應中的 ,逐一查看結果的所有頁面。