DescribeWorldGenerationJob - 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.

DescribeWorldGenerationJob

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 Job der Weltgeneration.

Anforderungssyntax

POST /describeWorldGenerationJob 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 Jobs der Weltgeneration.

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",
   "createdAt": number,
   "failureCode": "string",
   "failureReason": "string",
   "finishedWorldsSummary": { 
      "failureSummary": { 
         "failures": [ 
            { 
               "failureCode": "string",
               "failureCount": number,
               "sampleFailureReason": "string"
            }
         ],
         "totalFailureCount": number
      },
      "finishedCount": number,
      "succeededWorlds": [ "string" ]
   },
   "status": "string",
   "tags": { 
      "string" : "string" 
   },
   "template": "string",
   "worldCount": { 
      "floorplanCount": number,
      "interiorCountPerFloorplan": number
   },
   "worldTags": { 
      "string" : "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 Jobs der Weltgeneration.

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_\-=]*

createdAt

Die Zeit, in Millisekunden, seit der Zeit, als der Arbeitsplatz für die Weltgeneration geschaffen wurde.

Typ: Zeitstempel

failureCode

Der Fehlercode des World Generation Jobs, falls er ausgefallen ist:

InternalServiceError

Interner Dienstfehler.

LimitExceeded

Die angeforderte Ressource überschreitet die maximal zulässige Anzahl, oder die Anzahl gleichzeitiger Stream-Anfragen überschreitet die zulässige Höchstzahl.

ResourceNotFound

Die angegebene Ressource konnte nicht gefunden werden.

RequestThrottled

Die Anforderung wurde gedrosselt.

InvalidInput

Ein Eingabeparameter in der Anfrage ist nicht gültig.

Typ: Zeichenfolge

Zulässige Werte: InternalServiceError | LimitExceeded | ResourceNotFound | RequestThrottled | InvalidInput | AllWorldGenerationFailed

failureReason

Der Grund, warum der World Generation-Job gescheitert ist.

Typ: Zeichenfolge

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

Pattern: .*

finishedWorldsSummary

Zusammenfassende Informationen über fertige Welten.

Typ: FinishedWorldsSummary Objekt

status

Der Status des Weltgenerationsjobs:

Ausstehend

Die Stellenanfrage der Weltgeneration steht noch aus.

In Ausführung

Der Job zur weltweiten Generierung wird ausgeführt.

Completed

Der Job der Weltgeneration ist abgeschlossen.

Fehlgeschlagen

Der Job der Weltgeneration ist gescheitert. Weitere Informationen finden Sie unter failureCode.

PartialFailed

Manche Welten sind nicht entstanden.

Canceled

Der Job bei World Generation wurde gestrichen.

Stornieren

Der Job bei World Generation wird gestrichen.

Typ: Zeichenfolge

Zulässige Werte: Pending | Running | Completed | Failed | PartialFailed | Canceling | Canceled

tags

Eine Map, die Tag-Schlüssel und Tag-Werte enthält, die mit dem World Generation-Job verknüpft sind.

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 _.\-\/+=:]*

template

Der Amazon-Ressourcenname (arn) der Weltvorlage.

Typ: Zeichenfolge

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

Pattern: arn:.*

worldCount

Informationen über die Welt zählen.

Typ: WorldCount Objekt

worldTags

Eine Karte, die Tag-Schlüssel und Tag-Werte enthält, die den generierten Welten zugeordnet sind.

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 _.\-\/+=:]*

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: