ListJobs
指定された長さの JobListEntry オブジェクトの配列を返します。各 JobListEntry オブジェクトには、ジョブの状態、ジョブの ID、およびエクスポートジョブの場合にジョブがジョブパートであるかどうかを示す値が含まれます。米国リージョンのいずれかでこの API アクションを呼び出すと、すべての米国リージョンのこのアカウントに関連付けられているすべてのジョブのリストからジョブが返されます。
リクエストの構文
{
"MaxResults": number,
"NextToken": "string"
}リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下の JSON 形式のデータを受け入れます。
- MaxResults
-
返される
JobListEntryオブジェクトの数。型: 整数
有効な範囲: 最小値 は 0 です。最大値は 100 です。
必須: いいえ
- NextToken
-
HTTP リクエストはステートレスです。
JobListEntryオブジェクトのリストで「次」になるオブジェクトを特定するには、返されたリストの開始点としてNextTokenを指定するオプションがあります。型: 文字列
長さの制限: 最小長は 1 です。最大長は 1,024 です。
パターン:
.*必須: いいえ
レスポンスの構文
{
"JobListEntries": [
{
"CreationDate": number,
"Description": "string",
"IsMaster": boolean,
"JobId": "string",
"JobState": "string",
"JobType": "string",
"SnowballType": "string"
}
],
"NextToken": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- JobListEntries
-
各
JobListEntryオブジェクトには、ジョブの状態、ジョブの ID、およびエクスポートジョブの場合にジョブがジョブパートであるかどうかを示す値が含まれます。型: JobListEntry オブジェクトの配列
- NextToken
-
HTTP リクエストはステートレスです。自動生成された
NextToken値を次のListJobsの呼び出しに使用する場合、返されるJobListEntryオブジェクトは、配列内のこの時点から開始されます。型: 文字列
長さの制限: 最小長は 1 です。最大長は 1,024 です。
パターン:
.*
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InvalidNextTokenException
-
NextToken文字列が予期せず変更され、操作が停止しました。NextToken文字列を変更せずに操作を実行し、再度お試しください。HTTP ステータスコード：400
以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
