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

ListWorlds

Répertorie les mondes.

Syntaxe de la demande

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

{
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "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.

filters

Filtres facultatifs pour limiter les résultats. Tu peux utiliserstatus.

Type : tableau d’objets Filter

Membres du tableau : nombre fixe de 1 élément.

Obligatoire : non

maxResults

Lorsque ce paramètre est utilisé, les maxResults résultats ListWorlds ne sont renvoyés que sur une seule page avec un élément de nextToken réponse. Les résultats restants de la demande initiale peuvent être consultés en envoyant une autre ListWorlds demande avec la nextToken valeur renvoyée. Cette valeur peut être comprise entre 1 et 100. Si ce paramètre n'est pas utilisé, ListWorlds renvoie jusqu'à 100 résultats et une nextToken valeur, le cas échéant.

Type : entier

Obligatoire : non

nextToken

Si la requête paginée précédente n'a pas renvoyé tous les résultats restants, la valeur du nextToken paramètre de l'objet de réponse est définie sur un jeton. Pour récupérer le prochain ensemble de résultats, appelez ListWorlds à nouveau et attribuez ce jeton au nextToken paramètre de l'objet de requête. S'il n'y a aucun résultat restant, le NextToken paramètre de l'objet de réponse précédent est défini sur null.

Type : chaîne

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

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

Obligatoire : non

Syntaxe de la réponse

HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "worldSummaries": [ 
      { 
         "arn": "string",
         "createdAt": number,
         "generationJob": "string",
         "template": "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.

nextToken

Si la requête paginée précédente n'a pas renvoyé tous les résultats restants, la valeur du nextToken paramètre de l'objet de réponse est définie sur un jeton. Pour récupérer le prochain ensemble de résultats, appelez ListWorlds à nouveau et attribuez ce jeton au nextToken paramètre de l'objet de requête. S'il n'y a aucun résultat restant, le NextToken paramètre de l'objet de réponse précédent est défini sur null.

Type : chaîne

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

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

worldSummaries

Informations récapitulatives pour les mondes.

Type : tableau d’objets WorldSummary

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

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 :