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

GetBotChannelAssociations

Renvoie une liste de tous les canaux associés au bot spécifié.

L'GetBotChannelAssociationsopération nécessite des autorisations pour l'lex:GetBotChannelAssociationsaction.

Syntaxe de la demande

GET /bots/botName/aliases/aliasName/channels/?maxResults=maxResults&nameContains=nameContains&nextToken=nextToken HTTP/1.1

Paramètres de demande URI

La demande utilise les paramètres URI suivants.

aliasName

Alias pointant vers la version spécifique du bot Amazon Lex avec laquelle cette association est établie.

Contraintes de longueur : longueur minimum de 1. Longueur maximum de 100.

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

Obligatoire : oui

botName

Nom du bot Amazon Lex dans l'association.

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

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

Obligatoire : oui

maxResults

Le nombre maximum d'associations à renvoyer dans la réponse. La valeur par défaut est 50.

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

nameContains

Sous-chaîne à associer aux noms des associations de canaux. Une association sera renvoyée si une partie de son nom correspond à la sous-chaîne. Par exemple, « xyz » correspond à la fois à « xyzabc » et à « abcxyz ». Pour renvoyer toutes les associations de canaux du bot, utilisez un trait d'union (« - ») comme nameContains paramètre.

Contraintes de longueur : longueur minimum de 1. Longueur maximum de 100.

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

nextToken

Un jeton de pagination pour récupérer la page suivante d'associations. 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 d'associations suivante, 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

{
   "botChannelAssociations": [ 
      { 
         "botAlias": "string",
         "botConfiguration": { 
            "string" : "string" 
         },
         "botName": "string",
         "createdDate": number,
         "description": "string",
         "failureReason": "string",
         "name": "string",
         "status": "string",
         "type": "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.

botChannelAssociations

Tableau d'objets, un pour chaque association, qui fournit des informations sur le bot Amazon Lex et son association avec le canal.

Type : tableau d’objets BotChannelAssociation

nextToken

Un jeton de pagination qui récupère la page d'associations suivante. 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 d'associations suivante, spécifiez le jeton de pagination dans la demande suivante.

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

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 :