翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
ListRobots
このアクションは非推奨になりました。
重要
この API はサポートされなくなりました。詳細については、「サポートポリシー」ページの 2022 年 5 月 2 日の更新をご覧ください。
ロボットのリストを返します。フィルターを指定して特定のロボットを取得することもできます。
リクエストの構文
POST /listRobots HTTP/1.1
Content-type: application/json
{
"filters": [
{
"name": "string",
"values": [ "string" ]
}
],
"maxResults": number,
"nextToken": "string"
}URI リクエストパラメータ
リクエストでは URI パラメータを使用しません。
リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
- filters
-
結果を制限するためのフィルター (オプション)。
サポートされているフィルター名は
statusとfleetNameです。フィルタリングするときは、フィルターされた項目の完全な値を使用する必要があります。最大 3 つのフィルターを使用できますが、それらのフィルターは同じ名前の項目に対して使用する必要があります。例えば、ステータスがRegisteredまたはAvailableである項目を探す場合などです。型: Filter オブジェクトの配列
配列メンバー: 定数は 1 項目です。
必須: いいえ
- maxResults
-
このパラメータを使用すると、
ListRobotsによりmaxResults件の結果とnextTokenレスポンス要素が 1 ページにまとめられます。最初のリクエストの残りの結果は、返されたnextToken値を含む別のListRobotsリクエストを送信することで確認できます。この値は 1～200 の範囲で指定できます。このパラメータを使用しない場合は、ListRobotsにより最大 200 件の結果と、該当する場合はnextToken値が返されます。タイプ: 整数
必須: いいえ
- nextToken
-
前のページ分割されたリクエストにより残りの結果のすべてが返されなかった場合、レスポンスオブジェクトの
nextTokenパラメータ値がトークンに設定されます。次の一連の結果を取得するには、もう一度ListRobotsを呼び出し、そのトークンをリクエストオブジェクトのnextTokenパラメータに割り当ててください。結果が残っていない場合、 NextToken 前のレスポンスオブジェクトのパラメータはnullに設定されます。型: 文字列
長さの制限：最小長は 1 です。最大長は 2,048 です。
パターン:
[a-zA-Z0-9_.\-\/+=]*必須: いいえ
レスポンスの構文
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"robots": [
{
"architecture": "string",
"arn": "string",
"createdAt": number,
"fleetArn": "string",
"greenGrassGroupId": "string",
"lastDeploymentJob": "string",
"lastDeploymentTime": number,
"name": "string",
"status": "string"
}
]
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- nextToken
-
前のページ分割されたリクエストにより残りの結果のすべてが返されなかった場合、レスポンスオブジェクトの
nextTokenパラメータ値がトークンに設定されます。次の一連の結果を取得するには、もう一度ListRobotsを呼び出し、そのトークンをリクエストオブジェクトのnextTokenパラメータに割り当ててください。結果が残っていない場合、 NextToken 前のレスポンスオブジェクトのパラメーターは null に設定されます。型: 文字列
長さの制限：最小長は 1 です。最大長は 2,048 です。
Pattern:
[a-zA-Z0-9_.\-\/+=]* - robots
-
リクエストの条件を満たすロボットのリスト。
タイプ：Robot オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 1000 項目です。
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InternalServerException
-
AWS RoboMaker にサービスの問題が発生しました。もう一度やり直してください。
HTTP ステータスコード：500
- InvalidParameterException
-
リクエストで指定されたパラメータが無効であるか、サポートされていないか、または使用できません。返されたメッセージはエラー値の説明を提供します。
HTTP ステータスコード：400
- ResourceNotFoundException
-
指定されたリソースは存在しません。
HTTP ステータスコード：400
- ThrottlingException
-
AWS RoboMaker は一時的にリクエストを処理できません。もう一度やり直してください。
HTTP ステータスコード：400
その他の参照資料
言語固有の AWS SDK の 1 つでこの API を使用する方法の詳細については、以下を参照してください。
