DescribeWorld - AWS RoboMaker

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.

DescribeWorld

Beschreibt eine Welt.

Anforderungssyntax

POST /describeWorld HTTP/1.1 Content-type: application/json { "world": "string" }

URI-Anfrageparameter

Die Anforderung verwendet keine URI-Parameter.

Anforderungstext

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

world

Der Amazon-Ressourcenname (arn) der Welt, die Sie beschreiben möchten.

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", "createdAt": number, "generationJob": "string", "tags": { "string" : "string" }, "template": "string", "worldDescriptionBody": "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.

arn

Der Amazon-Ressourcenname (ARN) der Welt.

Typ: Zeichenfolge

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

Pattern: arn:.*

createdAt

Die Zeit in Millisekunden seit der Epoche, als die Welt erschaffen wurde.

Typ: Zeitstempel

generationJob

Der Amazon-Ressourcenname (arn) des Jobs zur Weltgenerierung, der die Welt generiert hat.

Typ: Zeichenfolge

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

Pattern: arn:.*

tags

Eine Karte, die Tag-Schlüssel und Tag-Werte enthält, die mit der Welt 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

Die Weltvorlage.

Typ: Zeichenfolge

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

Pattern: arn:.*

worldDescriptionBody

Gibt die Zeichenfolge im JSON-Format zurück, die den Inhalt Ihrer Welt beschreibt.

Typ: Zeichenfolge

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

Pattern: [\S\s]+

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

ResourceNotFoundException

Die angegebene Ressource ist nicht vorhanden.

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: