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

DescribeWorldExportJob

Beschreibt einen Weltexportjob.

Anforderungssyntax

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

{
   "job": "string"
}

URI-Anfrageparameter

Die Anforderung verwendet keine URI-Parameter.

Anforderungstext

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

job

Der Amazon-Ressourcenname (arn) des zu beschreibenden Weltexportauftrags.

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",
   "iamRole": "string",
   "outputLocation": { 
      "s3Bucket": "string",
      "s3Prefix": "string"
   },
   "status": "string",
   "tags": { 
      "string" : "string" 
   },
   "worlds": [ "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) des Weltexportauftrags.

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 Epoche, als der Weltexportjob geschaffen wurde.

Typ: Zeitstempel

failureCode

Der Fehlercode des Weltexportauftrags, falls er fehlgeschlagen 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 | AccessDenied

failureReason

Der Grund, warum der Weltexportauftrag fehlgeschlagen ist.

Typ: Zeichenfolge

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

Pattern: .*

iamRole

Die IAM-Rolle, die der Weltexportprozess verwendet, um auf den Amazon S3 S3-Bucket zuzugreifen und den Export durchzuführen.

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/.*

outputLocation

Der Ausgabeort.

Typ: OutputLocation Objekt

status

Der Status des Weltexportauftrags.

Ausstehend

Die Anfrage für den Weltexportauftrag steht noch aus.

In Ausführung

Der Weltexportauftrag wird ausgeführt.

Completed

Der Weltexportauftrag ist abgeschlossen.

Fehlgeschlagen

Der Weltexportauftrag ist fehlgeschlagen. Weitere Informationen finden Sie unter failureCode und failureReason.

Canceled

Der Weltexportauftrag wurde storniert.

Wird storniert

Der Weltexportauftrag wird storniert.

Typ: Zeichenfolge

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

tags

Eine Map, die Tag-Schlüssel und Tag-Werte enthält, die mit dem Weltexportauftrag 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 _.\-\/+=:]*

worlds

Eine Liste von Amazon-Ressourcennamen (ARNS), die Welten entsprechen, die exportiert werden sollen.

Typ: Zeichenfolgen-Array

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

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

Pattern: arn:.*

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: