CreateWorldExportJob - AWS RoboMaker
Syntaxe de la demandeParamètres de demande URICorps de la demandeSyntaxe de la réponseEléments de réponseErreursconsultez aussi

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

CreateWorldExportJob

Crée un emploi à l'exportation dans le monde entier.

Syntaxe de la demande

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

{
   "clientRequestToken": "string",
   "iamRole": "string",
   "outputLocation": { 
      "s3Bucket": "string",
      "s3Prefix": "string"
   },
   "tags": { 
      "string" : "string" 
   },
   "worlds": [ "string" ]
}

Paramètres de demande URI

La demande n’utilise pas de paramètres URI.

Corps de la demande

Cette demande accepte les données suivantes au format JSON.

clientRequestToken

Identifiant unique distinguant majuscules et minuscules que vous fournissez pour garantir l'idempuissance de la demande.

Type : chaîne

Contraintes de longueur : longueur minimum de 1. Longueur maximale de 64.

Modèle : [a-zA-Z0-9_\-=]*

Obligatoire : non

iamRole

Rôle IAM utilisé par le processus d'exportation mondial pour accéder au compartiment Amazon S3 et effectuer l'exportation.

Type : chaîne

Contraintes de longueur : longueur minimum de 1. Longueur maximale de 255.

Modèle : arn:aws:iam::\w+:role/.*

Obligatoire : oui

outputLocation

Emplacement de la sortie.

Type : objet OutputLocation

Obligatoire : oui

tags

Une carte contenant les clés de balise et les valeurs de balise associées à la tâche d'exportation mondiale.

Type : mappage chaîne/chaîne

Entrées cartographiques : nombre minimum de 0 éléments. Nombre maximal de 50 éléments.

Contraintes de longueur de clé : longueur minimale de 1. Longueur maximum de 128.

Modèle de clé :[a-zA-Z0-9 _.\-\/+=:]*

Contraintes de longueur de valeur : longueur minimale de 0. Longueur maximum de 256.

Modèle de valeur : [a-zA-Z0-9 _.\-\/+=:]*

Obligatoire : non

worlds

Liste des noms de ressources Amazon (arns) correspondant aux mondes à exporter.

Type : tableau de chaînes

Membres du tableau : Nombre minimum de 1 élément. Nombre maximal de 100 éléments.

Contraintes de longueur : longueur minimum de 1. Longueur maximale de 1224.

Modèle : arn:.*

Obligatoire : oui

Syntaxe de la réponse

HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "clientRequestToken": "string",
   "createdAt": number,
   "failureCode": "string",
   "iamRole": "string",
   "outputLocation": { 
      "s3Bucket": "string",
      "s3Prefix": "string"
   },
   "status": "string",
   "tags": { 
      "string" : "string" 
   }
}

Eléments de réponse

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

arn

Le nom de ressource Amazon (ARN) du poste d'exportation mondial.

Type : chaîne

Contraintes de longueur : longueur minimum de 1. Longueur maximale de 1224.

Modèle : arn:.*

clientRequestToken

Identifiant unique distinguant majuscules et minuscules que vous fournissez pour garantir l'idempuissance de la demande.

Type : chaîne

Contraintes de longueur : longueur minimum de 1. Longueur maximale de 64.

Modèle : [a-zA-Z0-9_\-=]*

createdAt

L'heure, en millisecondes, depuis l'époque, où l'emploi d'exportateur mondial a été créé.

Type : Timestamp

failureCode

Le code d'échec de la tâche d'exportation mondiale en cas d'échec :

InternalServiceError

Erreur de service interne.

LimitExceeded

La ressource demandée dépasse le nombre maximum autorisé, ou le nombre de demandes de flux simultanées dépasse le nombre maximum autorisé.

ResourceNotFound

La ressource spécifiée est introuvable.

RequestThrottled

La demande a été limitée.

InvalidInput

Un paramètre d'entrée de la demande n'est pas valide.

AllWorldGenerationFailed

Tous les emplois de la génération mondiale ont échoué. Cela peut se produire si votre worldCount valeur est supérieure à 50 ou inférieure à 1.

Pour plus d'informations sur le dépannage WorldForge, consultez la section Simulation de résolution des problèmes WorldForge.

Type : chaîne

Valeurs valides : InternalServiceError | LimitExceeded | ResourceNotFound | RequestThrottled | InvalidInput | AccessDenied

iamRole

Rôle IAM utilisé par le processus d'exportation mondial pour accéder au compartiment Amazon S3 et effectuer l'exportation.

Type : chaîne

Contraintes de longueur : longueur minimum de 1. Longueur maximale de 255.

Modèle : arn:aws:iam::\w+:role/.*

outputLocation

Emplacement de la sortie.

Type : objet OutputLocation

status

L'état de l'emploi dans le secteur de l'exportation dans le monde.

En suspens

La demande d'emploi pour l'exportation mondiale est en attente.

En cours d'exécution

Le marché de l'exportation mondiale est en cours.

Terminé

Le travail d'exportation mondiale est terminé.

Échec

L'exportation mondiale a échoué. Pour plus d'informatons, consultez failureCode.

Annulé

Le poste d'exportation mondial a été annulé.

Annulation

Le poste d'exportation mondial est annulé.

Type : chaîne

Valeurs valides : Pending | Running | Completed | Failed | Canceling | Canceled

tags

Une carte contenant les clés de balise et les valeurs de balise associées à la tâche d'exportation mondiale.

Type : mappage chaîne/chaîne

Entrées cartographiques : nombre minimum de 0 éléments. Nombre maximal de 50 éléments.

Contraintes de longueur de clé : longueur minimale de 1. Longueur maximum de 128.

Modèle de clé :[a-zA-Z0-9 _.\-\/+=:]*

Contraintes de longueur de valeur : longueur minimale de 0. Longueur maximum de 256.

Modèle de valeur : [a-zA-Z0-9 _.\-\/+=:]*

Erreurs

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.

IdempotentParameterMismatchException

La demande utilise le même jeton client qu'une demande précédente non identique. Vous ne devez pas réutiliser de jeton client avec des demandes différentes, sauf si les demandes sont identiques.

Code d’état HTTP : 400

InternalServerException

AWS a RoboMaker rencontré un problème de service. Renouvelez votre appel.

Code d’état HTTP : 500

InvalidParameterException

Un paramètre spécifié dans une demande n'est pas valide, n'est pas pris en charge ou ne peut pas être utilisé. Le message renvoyé fournit une explication de la valeur d'erreur.

Code d’état HTTP : 400

ResourceNotFoundException

La ressource spécifiée n'existe pas.

Code d’état HTTP : 400

ServiceUnavailableException

La requête a échoué en raison d'une défaillance temporaire du serveur.

HTTP Status Code: 503

ThrottlingException

AWS RoboMaker est temporairement incapable de traiter la demande. Renouvelez votre appel.

Code d’état HTTP : 400

consultez aussi

Pour plus d’informations sur l’utilisation de cette API dans l’un des kits SDK AWS spécifiques au langage, consultez les ressources suivantes :