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

DescribeWorldGenerationJob

Décrit un emploi d'une génération mondiale.

Syntaxe de la demande

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

{
   "job": "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.

job

Le nom de ressource Amazon (arn) du job de génération mondiale à décrire.

Type : chaîne

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",
   "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" 
   }
}

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

L'Amazon Resource Name (ARN) de l'emploi de la génération mondiale.

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 de la génération mondiale a été créé.

Type : Timestamp

failureCode

Le code d'échec du job World Generation 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.

Type : chaîne

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

failureReason

La raison pour laquelle l'emploi de la génération mondiale a échoué.

Type : chaîne

Contraintes de longueur : longueur minimum de 0. Longueur maximum de 1024.

Modèle : .*

finishedWorldsSummary

Informations récapitulatives sur les mondes finis.

Type : objet FinishedWorldsSummary

status

L'état de la génération d'emplois dans le monde :

En attente

La demande d'emploi de World Generation est en attente.

En cours d'exécution

Le job de la génération mondiale est en marche.

Terminé

Le travail de la génération mondiale est terminé.

Échec

Le job de la génération mondiale a échoué. Pour plus d’informations, consultez failureCode.

PartialFailed

Certains mondes n'ont pas été générés.

Annulé

Le poste de génération mondiale a été annulé.

Annulation

L'emploi de la génération mondiale est supprimé.

Type : chaîne

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

tags

Une carte qui contient les clés de balise et les valeurs de balise associées à l'emploi de World Generation.

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 maximale de 128.

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

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

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

template

Le nom de ressource Amazon (arn) du modèle mondial.

Type : chaîne

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

Modèle : arn:.*

worldCount

Informations sur le décompte mondial.

Type : objet WorldCount

worldTags

Une carte qui contient des clés de balise et des valeurs de balises associées aux mondes générés.

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 maximale de 128.

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

Contraintes de longueur de valeur : longueur minimale de 0. Longueur maximale 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.

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

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 AWS SDK spécifiques au langage, consultez les pages suivantes :