ListRobots - AWS RoboMaker
AnforderungssyntaxURIParameter anfordernAnforderungstextAntwortsyntaxAntwortelementeFehlerWeitere Informationen finden Sie unter:

Ende des Supporthinweises: Am 10. September 2025 AWS wird der Support für AWS RoboMaker eingestellt. Nach dem 10. September 2025 können Sie nicht mehr auf die AWS RoboMaker Konsole oder die AWS RoboMaker Ressourcen zugreifen. Weitere Informationen AWS Batch zur Umstellung auf containerisierte Simulationen finden Sie in diesem Blogbeitrag.

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

ListRobots

Diese Aktion ist veraltet.

Wichtig

Hinweis zum Ende des Supports: Am 10. September 2025 AWS wird der Support für AWS RoboMaker eingestellt. Nach dem 10. September 2025 können Sie nicht mehr auf die AWS RoboMaker Konsole oder die AWS RoboMaker Ressourcen zugreifen. Weitere Informationen AWS Batch zur Umstellung auf containerisierte Simulationen finden Sie in diesem Blogbeitrag.

Wichtig

Dies API wird nicht mehr unterstützt. Weitere Informationen finden Sie im Update vom 2. Mai 2022 auf der Seite mit den Support-Richtlinien.

Gibt eine Liste von Robotern zurück. Sie können optional Filter bereitstellen, um bestimmte Roboter abzurufen.

Anforderungssyntax

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

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

URIParameter anfordern

Die Anfrage verwendet keine URI Parameter.

Anforderungstext

Die Anfrage akzeptiert die folgenden Daten im JSON Format.

filters

Optionale Filter zur Einschränkung der Ergebnisse.

Die Filternamen status und fleetName werden unterstützt. Beim Filtern müssen Sie den vollständigen Wert des gefilterten Elements verwenden. Sie können bis zu drei Filter verwenden, diese müssen sich jedoch auf dasselbe benannte Element beziehen. Zum Beispiel, wenn Sie nach Elementen mit dem Status Registered oder dem Status suchenAvailable.

Typ: Array von Filter-Objekten

Array-Mitglieder: Feste Anzahl von 1 Element.

Erforderlich: Nein

maxResults

Wenn dieser Parameter verwendet wird, werden ListRobots nur maxResults Ergebnisse auf einer einzelnen Seite zusammen mit einem nextToken Antwortelement zurückgegeben. Die verbleibenden Ergebnisse der ersten Anfrage können angezeigt werden, indem eine weitere ListRobots Anfrage mit dem zurückgegebenen nextToken Wert gesendet wird. Dieser Wert kann zwischen 1 und 200 liegen. Wenn dieser Parameter nicht verwendet wird, werden bis zu 200 Ergebnisse und gegebenenfalls ein nextToken Wert ListRobots zurückgegeben.

Typ: Ganzzahl

Erforderlich: Nein

nextToken

Wenn die vorherige paginierte Anfrage nicht alle verbleibenden Ergebnisse zurückgegeben hat, wird der nextToken Parameterwert des Antwortobjekts auf ein Token gesetzt. Um die nächsten Ergebnisse abzurufen, rufen Sie ListRobots erneut auf und weisen Sie dieses Token dem nextToken Parameter des Anforderungsobjekts zu. Wenn es keine verbleibenden Ergebnisse gibt, wird der NextToken Parameter des vorherigen Antwortobjekts auf Null gesetzt.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 2048 Zeichen.

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

Erforderlich: Nein

Antwortsyntax

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"
      }
   ]
}

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Dienst eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Dienst im JSON Format zurückgegeben.

nextToken

Wenn die vorherige paginierte Anfrage nicht alle verbleibenden Ergebnisse zurückgegeben hat, wird der nextToken Parameterwert des Antwortobjekts auf ein Token gesetzt. Um die nächsten Ergebnisse abzurufen, rufen Sie ListRobots erneut auf und weisen Sie dieses Token dem nextToken Parameter des Anforderungsobjekts zu. Wenn es keine verbleibenden Ergebnisse gibt, wird der NextToken Parameter des vorherigen Antwortobjekts auf Null gesetzt.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 2048 Zeichen.

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

robots

Eine Liste von Robotern, die die Kriterien der Anfrage erfüllen.

Typ: Array von Robot-Objekten

Array-Mitglieder: Die Mindestanzahl beträgt 0 Elemente. Die maximale Anzahl beträgt 1000 Elemente.

Fehler

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter Häufige Fehler.

InternalServerException

AWS RoboMaker es ist ein Serviceproblem aufgetreten. Wiederholen Sie den Aufruf.

HTTPStatuscode: 500

InvalidParameterException

Ein Parameter in einer Anforderung ist nicht gültig, wird nicht unterstützt oder kann nicht verwendet werden. Die zurückgegebene Nachricht enthält eine Erläuterung des Fehlers.

HTTPStatuscode: 400

ResourceNotFoundException

Die angegebene Ressource ist nicht vorhanden.

HTTPStatuscode: 400

ThrottlingException

AWS RoboMaker kann die Anfrage vorübergehend nicht bearbeiten. Wiederholen Sie den Aufruf.

HTTPStatuscode: 400

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden: