翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
ListJobs
ListJobs オペレーションは、オプションのフィルタリング機能を備えたジョブのページ分割されたリストを取得します。ジョブのステータスでフィルタリングし、返される結果の数を制御できます。オペレーションは、次のトークンを介したページ分割をサポートしているため、大規模なジョブリストを効率的に取得できます。
詳細については、Amazon Location Service API リファレンスのListJobs」を参照してください。
この API のリクエスト、レスポンス、CLI コマンドの例については、「ジョブを一覧表示する方法」を参照してください。
ユースケース
-
ジョブインベントリ管理: すべてのジョブを取得して処理履歴を監査し、検証オペレーション全体のリソース使用率を追跡します。
-
ステータスベースのモニタリング: ジョブをステータスでフィルタリングして、注意が必要な実行中のジョブまたは結果を取得する準備が整った完了したジョブを特定します。
-
運用レポート: ビジネス分析用のジョブ実行パターン、成功率、処理ボリュームに関するレポートを生成します。
-
トラブルシューティングとデバッグ: 失敗したジョブを一覧表示して、処理エラーのパターンを特定し、体系的な問題を診断します。
リクエストを理解する
ListJobs リクエストは、フィルタリングとページ分割のオプションパラメータを受け入れます。パラメータがない場合、オペレーションはデフォルトのページ分割を持つすべてのジョブを返します。
リクエストには、次のオプションパラメータが含まれます。
- フィルタリングオプション
-
返されるジョブのリストを絞り込むオプションのパラメータ。
-
Filter: フィルター条件を含むオブジェクト。-
JobStatus: 現在のステータスでジョブをフィルタリングします。有効な値:Pending、Running、Completed、Failed、Cancelling、またはCancelled。
-
-
- ページ分割コントロール
-
結果のページ分割を制御するオプションのパラメータ。
-
MaxResults: 1 回のレスポンスで返されるジョブの最大数。これを使用して、大きな結果セットのページサイズを制御します。 -
NextToken: 前のListJobsレスポンスからのページ分割トークン。このトークンを含めて、結果の次のページを取得します。
-
レスポンスを理解する
ListJobs レスポンスは、各ジョブの設定とステータス情報を含むジョブ概要のページ分割されたリストを提供します。次のトークンを使用して、より多くの結果が利用可能になったときに追加のページを取得します。
レスポンスには、次のフィールドが含まれます。
- ジョブリスト
-
フィルター条件に一致するジョブ概要の配列。
-
Entries: 以下を含むジョブ概要の配列。-
Action: ジョブによって実行されるアクション。 -
CreatedAt: ISO 8601 形式のジョブ作成タイムスタンプ。 -
EndedAt: ISO 8601 形式のジョブ完了タイムスタンプ。終了状態 (完了、失敗、またはキャンセル) のジョブにのみ存在します。 -
ExecutionRoleArn: 実行に使用される IAM ロール。 -
InputOptions: 入力設定オブジェクト。 -
JobArn: ジョブの Amazon リソースネーム (ARN)。 -
JobId: 一意のジョブ識別子。 -
Name: 作成時に指定された場合はジョブ名。 -
OutputOptions: 出力設定オブジェクト。 -
Status: 現在のジョブステータス。 -
UpdatedAt: ISO 8601 形式の最終更新タイムスタンプ。 -
ActionOptions: リクエストされた追加機能がある場合。
-
-
- ページ分割トークン
-
追加の結果を取得するためのトークン。
-
NextToken: 結果の次のページを取得するための次のListJobsリクエストに含めるトークン。このフィールドは、より多くの結果が利用可能な場合にのみ表示されます。このフィールドがない場合、最後のページが取得されたことを示します。
-
注記
結果は、ページ間で一貫した順序を維持します。後続のリクエストで各レスポンスNextTokenの を使用して、結果のすべてのページを反復処理します。
