ListSimulationJobs - AWS RoboMaker
AnforderungssyntaxURI-AnfrageparameterAnforderungstextAntwortsyntaxAntwortelementeFehlerWeitere Informationen finden Sie unter:

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.

ListSimulationJobs

Gibt eine Liste von Simulationsjobs zurück. Sie können optional Filter bereitstellen, um bestimmte Simulationsaufträge abzurufen.

Anforderungssyntax

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

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

URI-Anfrageparameter

Die Anforderung verwendet keine URI-Parameter.

Anforderungstext

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

filters

Optionale Filter zur Einschränkung der Ergebnisse.

Die Filternamen status und simulationApplicationName und robotApplicationName 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 Preparing oder dem Status suchenRunning.

Typ: Array von Filter-Objekten

Array-Mitglieder: Feste Anzahl von 1 Element.

Erforderlich: Nein

maxResults

Wenn dieser Parameter verwendet wird, werden ListSimulationJobs 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 ListSimulationJobs Anfrage mit dem zurückgegebenen nextToken Wert gesendet wird. Dieser Wert kann zwischen 1 und 1000 liegen. Wenn dieser Parameter nicht verwendet wird, werden bis zu 1000 Ergebnisse und gegebenenfalls ein nextToken Wert ListSimulationJobs 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 ListSimulationJobs 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",
   "simulationJobSummaries": [ 
      { 
         "arn": "string",
         "computeType": "string",
         "dataSourceNames": [ "string" ],
         "lastUpdatedAt": number,
         "name": "string",
         "robotApplicationNames": [ "string" ],
         "simulationApplicationNames": [ "string" ],
         "status": "string"
      }
   ]
}

Antwortelemente

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

Die folgenden Daten werden vom Service 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 ListSimulationJobs 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_.\-\/+=]*

simulationJobSummaries

Eine Liste von Zusammenfassungen von Simulationsaufträgen, die den Kriterien der Anforderung entsprechen.

Typ: Array von SimulationJobSummary-Objekten

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

Fehler

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

InternalServerException

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

HTTP Status Code: 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.

HTTP Status Code: 400

ThrottlingException

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

HTTP Status Code: 400

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS SDKs finden Sie im Folgenden: