Anforderungssyntax URIParameter anfordern Anforderungstext Antwortsyntax Antwortelemente Fehler Weitere 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.

DescribeSimulationJob

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.

Beschreibt einen Simulationsjob.

Anforderungssyntax


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

{
   "job": "string"
}

URIParameter anfordern

Die Anfrage verwendet keine URI Parameter.

Anforderungstext

Die Anfrage akzeptiert die folgenden Daten im JSON Format.

job

Der Amazon-Ressourcenname (ARN) des zu beschreibenden Simulationsjobs.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Die maximale Länge beträgt 1224.

Pattern: arn:.*

Erforderlich: Ja

Antwortsyntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "clientRequestToken": "string",
   "compute": { 
      "computeType": "string",
      "gpuUnitLimit": number,
      "simulationUnitLimit": number
   },
   "dataSources": [ 
      { 
         "destination": "string",
         "name": "string",
         "s3Bucket": "string",
         "s3Keys": [ 
            { 
               "etag": "string",
               "s3Key": "string"
            }
         ],
         "type": "string"
      }
   ],
   "failureBehavior": "string",
   "failureCode": "string",
   "failureReason": "string",
   "iamRole": "string",
   "lastStartedAt": number,
   "lastUpdatedAt": number,
   "loggingConfig": { 
      "recordAllRosTopics": boolean
   },
   "maxJobDurationInSeconds": number,
   "name": "string",
   "networkInterface": { 
      "networkInterfaceId": "string",
      "privateIpAddress": "string",
      "publicIpAddress": "string"
   },
   "outputLocation": { 
      "s3Bucket": "string",
      "s3Prefix": "string"
   },
   "robotApplications": [ 
      { 
         "application": "string",
         "applicationVersion": "string",
         "launchConfig": { 
            "command": [ "string" ],
            "environmentVariables": { 
               "string" : "string" 
            },
            "launchFile": "string",
            "packageName": "string",
            "portForwardingConfig": { 
               "portMappings": [ 
                  { 
                     "applicationPort": number,
                     "enableOnPublicIp": boolean,
                     "jobPort": number
                  }
               ]
            },
            "streamUI": boolean
         },
         "tools": [ 
            { 
               "command": "string",
               "exitBehavior": "string",
               "name": "string",
               "streamOutputToCloudWatch": boolean,
               "streamUI": boolean
            }
         ],
         "uploadConfigurations": [ 
            { 
               "name": "string",
               "path": "string",
               "uploadBehavior": "string"
            }
         ],
         "useDefaultTools": boolean,
         "useDefaultUploadConfigurations": boolean
      }
   ],
   "simulationApplications": [ 
      { 
         "application": "string",
         "applicationVersion": "string",
         "launchConfig": { 
            "command": [ "string" ],
            "environmentVariables": { 
               "string" : "string" 
            },
            "launchFile": "string",
            "packageName": "string",
            "portForwardingConfig": { 
               "portMappings": [ 
                  { 
                     "applicationPort": number,
                     "enableOnPublicIp": boolean,
                     "jobPort": number
                  }
               ]
            },
            "streamUI": boolean
         },
         "tools": [ 
            { 
               "command": "string",
               "exitBehavior": "string",
               "name": "string",
               "streamOutputToCloudWatch": boolean,
               "streamUI": boolean
            }
         ],
         "uploadConfigurations": [ 
            { 
               "name": "string",
               "path": "string",
               "uploadBehavior": "string"
            }
         ],
         "useDefaultTools": boolean,
         "useDefaultUploadConfigurations": boolean,
         "worldConfigs": [ 
            { 
               "world": "string"
            }
         ]
      }
   ],
   "simulationTimeMillis": number,
   "status": "string",
   "tags": { 
      "string" : "string" 
   },
   "vpcConfig": { 
      "assignPublicIp": boolean,
      "securityGroups": [ "string" ],
      "subnets": [ "string" ],
      "vpcId": "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.

arn

Der Amazon-Ressourcenname (ARN) des Simulationsjobs.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Die maximale Länge beträgt 1224.

Pattern: arn:.*

clientRequestToken

Eindeutiger Bezeichner mit Berücksichtigung von Groß- und Kleinschreibung, den Sie angeben, um die Idempotenz der Anfrage sicherzustellen.

Typ: Zeichenfolge

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

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

compute

Berechne die Informationen für den Simulationsjob.

Typ: ComputeResponse Objekt

dataSources

Die Datenquellen für den Simulationsjob.

Typ: Array von DataSource-Objekten

failureBehavior

Das Fehlerverhalten für den Simulationsjob.

Typ: Zeichenfolge

Zulässige Werte: Fail | Continue

failureCode

Der Fehlercode des Simulationsjobs, falls er fehlgeschlagen ist:

InternalServiceError: Interner Dienstfehler.
RobotApplicationCrash: Die Roboteranwendung wurde ungewöhnlich beendet.
SimulationApplicationCrash: Die Simulationsanwendung wurde ungewöhnlich beendet.
BadPermissionsRobotApplication: Das Robot-Anwendungspaket konnte nicht heruntergeladen werden.
BadPermissionsSimulationApplication: Das Simulationsanwendungspaket konnte nicht heruntergeladen werden.
BadPermissionsS3-Ausgabe: Die Ausgaben konnten nicht im vom Kunden bereitgestellten S3-Bucket veröffentlicht werden.
BadPermissionsCloudwatchLogs: Die Protokolle konnten nicht in der vom Kunden bereitgestellten CloudWatch Protokollressource veröffentlicht werden.
SubnetIpLimitExceeded: Das Subnetz-IP-Limit wurde überschritten.
ENILimitExceeded: ENILimit überschritten.
BadPermissionsUserCredentials: Die angegebene Rolle kann nicht verwendet werden.
InvalidBundleRobotApplication: Das Roboterpaket kann nicht extrahiert werden (ungültiges Format, Bündelungsfehler oder anderes Problem).
InvalidBundleSimulationApplication: Das Simulationspaket kann nicht extrahiert werden (ungültiges Format, Bündelungsfehler oder anderes Problem).
RobotApplicationVersionMismatchedEtag: Etag for RobotApplication stimmt bei der Versionserstellung nicht mit dem Wert überein.
SimulationApplicationVersionMismatchedEtag: Etag for entspricht SimulationApplication nicht dem Wert bei der Versionserstellung.

Typ: Zeichenfolge

failureReason

Details darüber, warum der Simulationsjob fehlgeschlagen ist. Weitere Informationen zur Problembehandlung finden Sie unter Problembehandlung.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 1024 Zeichen.

Pattern: .*

iamRole

Die IAM Rolle, die es der Simulationsinstanz ermöglicht AWSAPIs, die in den zugehörigen Richtlinien angegebenen Werte in Ihrem Namen aufzurufen.

Typ: Zeichenfolge

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

Pattern: arn:aws:iam::\w+:role/.*

lastStartedAt

Die Zeit in Millisekunden seit der Epoche, zu der der Simulationsjob zuletzt gestartet wurde.

Typ: Zeitstempel

lastUpdatedAt

Die Zeit in Millisekunden seit der Epoche, zu der der Simulationsjob zuletzt aktualisiert wurde.

Typ: Zeitstempel

loggingConfig

Die Protokollierungskonfiguration.

Typ: LoggingConfig Objekt

maxJobDurationInSeconds

Die maximale Auftragsdauer in Sekunden. Der Wert muss 8 Tage (691.200 Sekunden) oder weniger betragen.

Type: Long

name

Der Name des Simulationsjobs.

Typ: Zeichenfolge

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

Pattern: [a-zA-Z0-9_\-]*

networkInterface

Die Netzwerkschnittstelleninformationen für den Simulationsjob.

Typ: NetworkInterface Objekt

outputLocation

Speicherort für die vom Simulationsjob generierten Ausgabedateien.

Typ: OutputLocation Objekt

robotApplications

Eine Liste von Roboteranwendungen.

Typ: Array von RobotApplicationConfig-Objekten

Array-Mitglieder: Feste Anzahl von 1 Element.

simulationApplications

Eine Liste von Simulationsanwendungen.

Typ: Array von SimulationApplicationConfig-Objekten

Array-Mitglieder: Feste Anzahl von 1 Element.

simulationTimeMillis

Die Ausführungsdauer des Simulationsauftrags in Millisekunden.

Type: Long

status

Der Status des Simulationsjobs.

Typ: Zeichenfolge

tags

Die Liste aller Tags, die dem angegebenen Simulationsjob hinzugefügt wurden.

Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge

Karteneinträge: Mindestanzahl von 0 Elementen. Die maximale Anzahl beträgt 50 Elemente.

Schlüssel-Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 128 Zeichen.

Schlüssel-Muster: [a-zA-Z0-9 _.\-\/+=:]*

Längenbeschränkungen für Werte: Mindestlänge von 0. Maximale Länge beträgt 256 Zeichen.

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

vpcConfig

Die VPC Konfiguration.

Typ: VPCConfigResponse Objekt

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:

Warnung JavaScript ist in Ihrem Browser nicht verfügbar oder deaktiviert.

Zur Nutzung der AWS-Dokumentation muss JavaScript aktiviert sein. Weitere Informationen finden auf den Hilfe-Seiten Ihres Browsers.

Dokumentkonventionen

DescribeSimulationApplication

DescribeSimulationJobBatch