ListWorldGenerationJobs - AWS RoboMaker
リクエストの構文URI リクエストパラメータリクエストボディレスポンスの構文レスポンス要素エラーその他の参照資料

AWS RoboMaker は、新規顧客には利用できなくなりました。の既存のお客様 AWS RoboMaker は、通常どおりサービスを引き続き使用できます。 AWS Batch は、コンテナ化されたシミュレーションを実行するのに推奨されるサービスになりました。詳細はこちら。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

ListWorldGenerationJobs

ワールドジェネレータージョブを一覧表示します。

リクエストの構文

POST /listWorldGenerationJobs HTTP/1.1
Content-type: application/json

{
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string"
}

URI リクエストパラメータ

リクエストでは URI パラメータを使用しません。

リクエストボディ

リクエストは以下の JSON 形式のデータを受け入れます。

filters

結果を制限するためのフィルター (オプション)。status と templateId を使用できます。

型: Filter オブジェクトの配列

配列メンバー: 定数は 1 項目です。

必須: いいえ

maxResults

このパラメータを使用すると、ListWorldGeneratorJobs により maxResults 件の結果と nextToken レスポンス要素が 1 ページにまとめられます。最初のリクエストの残りの結果は、返された nextToken 値を含む別の ListWorldGeneratorJobs リクエストを送信することで確認できます。この値は 1～100 の範囲で指定できます。このパラメータを使用しない場合は、ListWorldGeneratorJobs により最大 100 件の結果と、該当する場合は nextToken 値が返されます。

タイプ: 整数

必須: いいえ

nextToken

前のページ分割されたリクエストにより残りの結果のすべてが返されなかった場合、レスポンスオブジェクトの nextToken パラメータ値がトークンに設定されます。次の一連の結果を取得するには、もう一度 ListWorldGenerationJobsRequest を呼び出し、そのトークンをリクエストオブジェクトの nextToken パラメータに割り当ててください。結果が残っていない場合、 NextToken 前のレスポンスオブジェクトのパラメータはnullに設定されます。

型: 文字列

長さの制限：最小長は 1 です。最大長は 2,048 です。

パターン: [a-zA-Z0-9_.\-\/+=]*

必須: いいえ

レスポンスの構文

HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "worldGenerationJobSummaries": [ 
      { 
         "arn": "string",
         "createdAt": number,
         "failedWorldCount": number,
         "status": "string",
         "succeededWorldCount": number,
         "template": "string",
         "worldCount": { 
            "floorplanCount": number,
            "interiorCountPerFloorplan": number
         }
      }
   ]
}

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

nextToken

前のページ分割されたリクエストにより残りの結果のすべてが返されなかった場合、レスポンスオブジェクトの nextToken パラメータ値がトークンに設定されます。次の一連の結果を取得するには、もう一度 ListWorldGeneratorJobsRequest を呼び出し、そのトークンをリクエストオブジェクトの nextToken パラメータに割り当ててください。結果が残っていない場合、 NextToken 前のレスポンスオブジェクトのパラメーターは null に設定されます。

型: 文字列

長さの制限：最小長は 1 です。最大長は 2,048 です。

Pattern: [a-zA-Z0-9_.\-\/+=]*

worldGenerationJobSummaries

ワールドジェネレータージョブの概要情報。

タイプ：WorldGenerationJobSummary オブジェクトの配列

配列メンバー: 最小数は 0 項目です。最大数は 100 項目です。

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

InternalServerException

AWS RoboMaker にサービスの問題が発生しました。もう一度やり直してください。

HTTP ステータスコード：500

InvalidParameterException

リクエストで指定されたパラメータが無効であるか、サポートされていないか、または使用できません。返されたメッセージはエラー値の説明を提供します。​

HTTP ステータスコード：400

ThrottlingException

AWS RoboMaker は一時的にリクエストを処理できません。もう一度やり直してください。

HTTP ステータスコード：400

その他の参照資料

言語固有の AWS SDK の 1 つでこの API を使用する方法の詳細については、以下を参照してください。