ListRobots - AWS RoboMaker
請求語法URI 請求參數請求主體回應語法回應元素錯誤另請參閱

支援終止通知：在 2025 年 9 月 10 日， AWS 將停止對 的支援 AWS RoboMaker。2025 年 9 月 10 日後，您將無法再存取 AWS RoboMaker 主控台或 AWS RoboMaker 資源。如需有關轉換至 AWS Batch 以協助執行容器化模擬的詳細資訊，請造訪此部落格文章 。

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

ListRobots

此動作已被取代。

重要

支援終止通知：在 2025 年 9 月 10 日， AWS 將停止對 的支援 AWS RoboMaker。2025 年 9 月 10 日後，您將無法再存取 AWS RoboMaker 主控台或 AWS RoboMaker 資源。如需有關轉換至 AWS Batch 以協助執行容器化模擬的詳細資訊，請造訪此部落格文章 。

重要

已不再支援此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

限制結果的選用篩選條件。

支援篩選名稱 fleetName status和 。篩選時，您必須使用已篩選項目的完整值。您最多可以使用三個篩選條件，但它們必須用於相同的具名項目。例如，如果您正在尋找狀態為 Registered或狀態為 的項目Available。

類型：Filter 物件陣列

陣列成員：固定項目數為 1。

必要：否

maxResults

使用此參數時，ListRobots只會傳回單一頁面maxResults的結果以及nextToken回應元素。傳送另一個具有傳回nextToken值的ListRobots請求，即可查看初始請求的其餘結果。此值可以介於 1 到 200 之間。如果未使用此參數，則最多ListRobots傳回 200 個結果和一個nextToken值，如果適用。

類型：整數

必要：否

nextToken

如果先前的分頁請求未傳回所有剩餘的結果，回應物件的nextToken參數值會設定為權杖。若要擷取下一組結果，請ListRobots再次呼叫 ，並將該權杖指派給請求物件的 nextToken 參數。如果沒有剩餘的結果，則先前的回應物件 NextToken 參數會設定為 null。

類型：字串

長度限制：長度下限為 1。長度上限為 2048。

模式：[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"
      }
   ]
}

回應元素

如果動作成功，服務會傳回 200 HTTP 個回應。

服務會以 JSON 格式傳回下列資料。

nextToken

如果先前的分頁請求未傳回所有剩餘的結果，回應物件的nextToken參數值會設定為權杖。若要擷取下一組結果，請ListRobots再次呼叫 ，並將該權杖指派給請求物件的 nextToken 參數。如果沒有剩餘的結果，則先前的回應物件 NextToken 參數會設定為 null。

類型：字串

長度限制：長度下限為 1。長度上限為 2048。

模式：[a-zA-Z0-9_.\-\/+=]*

robots

符合請求條件的機器人清單。

類型：Robot 物件陣列

陣列成員：項目數下限為 0。項目數上限為 1000。

錯誤

如需所有動作常見錯誤的資訊，請參閱常見錯誤。

InternalServerException

AWS RoboMaker 發生服務問題。請再次嘗試呼叫。

HTTP 狀態碼：500

InvalidParameterException

在請求中指定的一個參數無效、未支援或無法使用。傳回之訊息會提供錯誤值的說明。

HTTP 狀態碼：400

ResourceNotFoundException

指定的資源不存在。

HTTP 狀態碼：400

ThrottlingException

AWS RoboMaker 暫時無法處理請求。請再次嘗試呼叫。

HTTP 狀態碼：400

另請參閱

如需在其中一種語言特定的 API中使用此功能的詳細資訊 AWS SDKs，請參閱下列內容：