GetBotChannelAssociation - Amazon Lex V1
AnforderungssyntaxURI-AnfrageparameterAnforderungstextAntwortsyntaxAntwortelementeFehlerWeitere Informationen finden Sie unter:

Wenn Sie Amazon Lex V2 verwenden, lesen Sie stattdessen das Amazon Lex V2-Handbuch.

 

Wenn Sie Amazon Lex V1 verwenden, empfehlen wir, Ihre Bots auf Amazon Lex V2 zu aktualisieren. Wir fügen V1 keine neuen Funktionen mehr hinzu und empfehlen dringend, V2 für alle neuen Bots zu verwenden.

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

GetBotChannelAssociation

Gibt Informationen über die Verbindung zwischen einem Amazon Lex Lex-Bot und einer Messaging-Plattform zurück.

Diese Operation erfordert Berechtigungen für die Aktion lex:GetBotChannelAssociation.

Anforderungssyntax

GET /bots/botName/aliases/aliasName/channels/name HTTP/1.1

URI-Anfrageparameter

Die Anforderung verwendet die folgenden URI-Parameter.

aliasName

Ein Alias, der auf die spezifische Version des Amazon Lex Lex-Bot verweist, zu dem diese Zuordnung hergestellt wird.

Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 100 Zeichen.

Pattern: ^([A-Za-z]_?)+$

Erforderlich: Ja

botName

Der Name des Amazon Lex Lex-Bot.

Längenbeschränkungen: Mindestlänge von 2. Maximale Länge = 50 Zeichen.

Pattern: ^([A-Za-z]_?)+$

Erforderlich: Ja

name

Der Name der Assoziation zwischen dem Bot und dem Kanal. Der Name berücksichtigt Groß- und Kleinschreibung.

Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 100 Zeichen.

Pattern: ^([A-Za-z]_?)+$

Erforderlich: Ja

Anforderungstext

Der Anforderung besitzt keinen Anforderungstext.

Antwortsyntax

HTTP/1.1 200
Content-type: application/json

{
   "botAlias": "string",
   "botConfiguration": { 
      "string" : "string" 
   },
   "botName": "string",
   "createdDate": number,
   "description": "string",
   "failureReason": "string",
   "name": "string",
   "status": "string",
   "type": "string"
}

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

botAlias

Ein Alias, der auf die spezifische Version des Amazon Lex Lex-Bot verweist, zu dem diese Zuordnung hergestellt wird.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 100 Zeichen.

Pattern: ^([A-Za-z]_?)+$

botConfiguration

Stellt Informationen bereit, die die Messaging-Plattform für die Kommunikation mit dem Amazon Lex Lex-Bot benötigt.

Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge

Karteneinträge: Maximale Anzahl von 10 Elementen.

botName

Der Name des Amazon Lex Lex-Bot.

Typ: Zeichenfolge

Längenbeschränkungen: Mindestlänge von 2. Maximale Länge = 50 Zeichen.

Pattern: ^([A-Za-z]_?)+$

createdDate

Das Datum, an dem die Verbindung zwischen dem Bot und dem Kanal erstellt wurde.

Typ: Zeitstempel

description

Eine Beschreibung der Verbindung zwischen dem Bot und dem Kanal.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 0. Höchstlänge = 200 Zeichen.

failureReason

Falls status jaFAILED, gibt Amazon Lex den Grund an, warum die Zuordnung nicht erstellt werden konnte.

Typ: Zeichenfolge

name

Der Name der Assoziation zwischen dem Bot und dem Kanal.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 100 Zeichen.

Pattern: ^([A-Za-z]_?)+$

status

Der Status des Bot-Kanals.

  • CREATED- Der Kanal wurde erstellt und ist einsatzbereit.

  • IN_PROGRESS- Die Erstellung des Kanals ist im Gange.

  • FAILED- Beim Erstellen des Kanals ist ein Fehler aufgetreten. Informationen zur Ursache des Fehlers finden Sie in dem failureReason Feld.

Typ: Zeichenfolge

Zulässige Werte: IN_PROGRESS | CREATED | FAILED

type

Der Typ der Messaging-Plattform.

Typ: Zeichenfolge

Zulässige Werte: Facebook | Slack | Twilio-Sms | Kik

Fehler

BadRequestException

Die Anfrage ist nicht wohlformuliert. Beispielsweise ist ein Wert ungültig oder ein erforderliches Feld fehlt. Überprüfen Sie die Feldwerte und versuchen Sie es erneut.

HTTP Status Code: 400

InternalFailureException

Ein interner Amazon Lex Lex-Fehler ist aufgetreten. Versuchen Sie es erneut.

HTTP Status Code: 500

LimitExceededException

Die Anfrage hat ein Limit überschritten. Versuchen Sie es erneut.

HTTP-Statuscode: 429

NotFoundException

Die in der Anfrage angegebene Ressource wurde nicht gefunden. Überprüfen Sie die Ressource und versuchen Sie es erneut.

HTTP Status Code: 404

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS SDKs finden Sie im Folgenden: