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

GetBots

Gibt Bot-Informationen wie folgt zurück:

  • Wenn Sie das nameContains Feld angeben, enthält die Antwort Informationen zur $LATEST Version aller Bots, deren Name die angegebene Zeichenfolge enthält.

  • Wenn Sie das nameContains Feld nicht angeben, gibt der Vorgang Informationen über die $LATEST Version all Ihrer Bots zurück.

Diese Operation setzt eine Berechtigung für die lex:GetBots-Aktion voraus.

Anforderungssyntax

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

URI-Anfrageparameter

Die Anforderung verwendet die folgenden URI-Parameter.

maxResults

Die maximale Anzahl von Bots, die in der Antwort zurückgegeben werden sollen, die die Anfrage zurückgibt. Der Standardwert ist 10.

Gültiger Bereich: Mindestwert 1. Maximaler Wert von 50.

nameContains

Teilzeichenfolge, der in Bot-Namen zugeordnet werden soll. Ein Bot wird zurückgegeben, wenn ein Teil seines Namens mit der Teilzeichenfolge übereinstimmt. Zum Beispiel entspricht „xyz“ sowohl „xyzabc“ als auch „abcxyz“.

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

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

nextToken

Ein Paginierungstoken, das die nächste Seite mit Bots abruft. Wenn die Antwort auf diesen Anruf gekürzt wird, gibt Amazon Lex in der Antwort ein Paginierungstoken zurück. Um die nächste Seite mit Bots abzurufen, geben Sie das Paginierungstoken in der nächsten Anfrage an.

Anforderungstext

Der Anforderung besitzt keinen Anforderungstext.

Antwortsyntax

HTTP/1.1 200
Content-type: application/json

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

bots

Eine Reihe von botMetadata Objekten mit einem Eintrag für jeden Bot.

Typ: Array von BotMetadata-Objekten

nextToken

Wenn die Antwort gekürzt ist, enthält sie ein Paginierungstoken, das Sie in Ihrer nächsten Anfrage angeben können, um die nächste Seite mit Bots abzurufen.

Typ: Zeichenfolge

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: