GetBots - Amazon Lex V1
Syntaxe de la demandeParamètres de demande URICorps de la requêteSyntaxe de la réponseEléments de réponseErreursconsultez aussi

Si vous utilisez Amazon Lex V2, consultez plutôt le guide Amazon Lex V2.

 

Si vous utilisez Amazon Lex V1, nous vous recommandons de mettre à niveau vos robots vers Amazon Lex V2. Nous n'ajoutons plus de nouvelles fonctionnalités à la V1 et recommandons vivement d'utiliser la V2 pour tous les nouveaux robots.

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.

GetBots

Renvoie les informations du bot comme suit :

  • Si vous fournissez le nameContains champ, la réponse inclut des informations sur la $LATEST version de tous les robots dont le nom contient la chaîne spécifiée.

  • Si vous ne spécifiez pas le nameContains champ, l'opération renvoie des informations sur la $LATEST version de tous vos robots.

Cette opération nécessite une autorisation pour l'action lex:GetBots.

Syntaxe de la demande

GET /bots/?maxResults=maxResults&nameContains=nameContains&nextToken=nextToken HTTP/1.1

Paramètres de demande URI

La demande utilise les paramètres URI suivants.

maxResults

Le nombre maximum de robots à renvoyer dans la réponse que la demande renverra. La valeur par défaut est 10.

Plage valide : valeur minimum de 1. Valeur maximum de 50.

nameContains

Sous-chaîne à faire correspondre dans les noms des robots. Un bot sera renvoyé si une partie de son nom correspond à la sous-chaîne. Par exemple, « xyz » correspond à la fois à « xyzabc » et à « abcxyz ».

Contraintes de longueur : longueur minimale de 2. Longueur maximale de 50.

Modèle : ^([A-Za-z]_?)+$

nextToken

Un jeton de pagination qui récupère la page suivante des bots. Si la réponse à cet appel est tronquée, Amazon Lex renvoie un jeton de pagination dans la réponse. Pour récupérer la page suivante de robots, spécifiez le jeton de pagination dans la demande suivante.

Corps de la requête

La demande n’a pas de corps de requête.

Syntaxe de la réponse

HTTP/1.1 200
Content-type: application/json

{
   "bots": [ 
      { 
         "createdDate": number,
         "description": "string",
         "lastUpdatedDate": number,
         "name": "string",
         "status": "string",
         "version": "string"
      }
   ],
   "nextToken": "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.

bots

Un tableau d'botMetadataobjets, avec une entrée pour chaque bot.

Type : tableau d’objets BotMetadata

nextToken

Si la réponse est tronquée, elle inclut un jeton de pagination que vous pouvez spécifier dans votre prochaine demande pour récupérer la page suivante de bots.

Type : chaîne

Erreurs

BadRequestException

La demande n'est pas bien formulée. Par exemple, une valeur n'est pas valide ou un champ obligatoire est manquant. Vérifiez les valeurs des champs, puis réessayez.

Code d’état HTTP : 400

InternalFailureException

Une erreur interne Amazon Lex s'est produite. Réessayez votre demande.

Code d’état HTTP : 500

LimitExceededException

La demande a dépassé une limite. Réessayez votre demande.

Code d’état HTTP : 429

NotFoundException

La ressource spécifiée dans la demande est introuvable. Vérifiez la ressource et réessayez.

Code d’état HTTP : 404

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 :