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.
DescribeWorld
Décrit un monde.
Syntaxe de la demande
POST /describeWorld HTTP/1.1
Content-type: application/json
{
"world": "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.
- world
-
Le nom de ressource Amazon (arn) du monde que vous souhaitez 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",
"createdAt": number,
"generationJob": "string",
"tags": {
"string" : "string"
},
"template": "string",
"worldDescriptionBody": "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 monde.
Type : chaîne
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 1224
Modèle :
arn:.* - createdAt
-
L'heure, en millisecondes, depuis l'époque où le monde a été créé.
Type : Timestamp
- generationJob
-
Le nom de ressource Amazon (arn) de la génération mondiale d'emplois qui a généré le monde.
Type : chaîne
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 1224
Modèle :
arn:.* -
Une carte qui contient des clés de balise et des valeurs de balises associées au monde.
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 modèle du monde.
Type : chaîne
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 1224
Modèle :
arn:.* - worldDescriptionBody
-
Renvoie la chaîne au format JSON qui décrit le contenu de votre monde.
Type : chaîne
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 262 144.
Modèle :
[\S\s]+
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 :
