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

ListRobots

Cette action a été dépréciée.

Important

Cette API n'est plus prise en charge. Pour plus d'informations, consultez la mise à jour du 2 mai 2022 sur la page Politique de support.

Renvoie une liste de robots. Vous pouvez éventuellement fournir des filtres pour récupérer des robots spécifiques.

Syntaxe de la demande

POST /listRobots 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.

Les noms des status filtres fleetName sont pris en charge. Lors du filtrage, vous devez utiliser la valeur complète de l'élément filtré. Vous pouvez utiliser jusqu'à trois filtres, mais ils doivent porter sur le même élément portant le même nom. Par exemple, si vous recherchez des articles ayant le statut Registered ou le statutAvailable.

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 ListRobots 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 ListRobots demande avec la nextToken valeur renvoyée. Cette valeur peut être comprise entre 1 et 200. Si ce paramètre n'est pas utilisé, ListRobots renvoie jusqu'à 200 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 ListRobots à nouveau et attribuez ce jeton au nextToken paramètre de l'objet de la 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",
   "robots": [ 
      { 
         "architecture": "string",
         "arn": "string",
         "createdAt": number,
         "fleetArn": "string",
         "greenGrassGroupId": "string",
         "lastDeploymentJob": "string",
         "lastDeploymentTime": number,
         "name": "string",
         "status": "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 ListRobots à nouveau et attribuez ce jeton au nextToken paramètre de l'objet de la 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_.\-\/+=]*

robots

Liste des robots répondant aux critères de la demande.

Type : tableau d’objets Robot

Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 1 000 éléments.

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 :