ListSearchJobs
このオペレーションは、アカウントに属する検索ジョブのリストを返します。
リクエストの構文
GET /search-jobs?MaxResults=MaxResults&NextToken=NextToken&Status=ByStatus HTTP/1.1
URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
- ByStatus
-
検索ジョブのステータスでリストを絞り込むには、このパラメータを含めます。
有効な値：
RUNNING | COMPLETED | STOPPING | STOPPED | FAILED - MaxResults
-
返されるリソースリストアイテムの最大数。
有効な範囲: 最小値 は 1 です。最大値は 1000 です。
- NextToken
-
返される検索ジョブの部分的リストに続く次の項目です。
例えば、
MaxResultsで指定した数のバックアップを返すリクエストが行われた場合、NextTokenを使用すると、次のトークンが指す場所から開始してさらにリストの項目を返すことができます。
リクエスト本文
リクエストにリクエスト本文がありません。
レスポンスの構文
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"SearchJobs": [
{
"CompletionTime": number,
"CreationTime": number,
"Name": "string",
"SearchJobArn": "string",
"SearchJobIdentifier": "string",
"SearchScopeSummary": {
"TotalItemsToScanCount": number,
"TotalRecoveryPointsToScanCount": number
},
"Status": "string",
"StatusMessage": "string"
}
]
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- NextToken
-
検索ジョブに含まれる返されたバックアップの部分的なリストに続く次のアイテム。
例えば、
MaxResultsで指定した数のバックアップを返すリクエストが行われた場合、NextTokenを使用すると、次のトークンが指す場所から開始してさらにリストの項目を返すことができます。タイプ: 文字列
- SearchJobs
-
リスト内の検索ジョブと、返された検索ジョブの詳細。
タイプ: SearchJobSummary オブジェクトの配列
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- AccessDeniedException
-
このアクションを実行する十分なアクセス権限がありません。
- message
-
このアクションを実行する十分なアクセス権限がありません。
HTTP ステータスコード: 403
- InternalServerException
-
内部サーバーエラーが発生しました。リクエストを再実行します。
- message
-
リクエストの処理中に予期しないエラーが発生しました。
- retryAfterSeconds
-
秒数後に呼び出しを再試行します。
HTTP ステータスコード: 500
- ThrottlingException
-
リクエストのスロットリングにより、リクエストが拒否されました。
- message
-
リクエストのスロットリングにより、リクエストは失敗しました。
- quotaCode
-
これは、クォータを持つ元のサービスに固有のコードです。
- retryAfterSeconds
-
秒数後に呼び出しを再試行します。
- serviceCode
-
これは、元のサービスに固有のコードです。
HTTP ステータスコード: 429
- ValidationException
-
入力が、サービスで指定された制約を満たしていません。
- message
-
入力が、Amazon サービスで指定された制約を満たしていません。
HTTP ステータスコード: 400
以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
