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

PutBotAlias

Erzeugt einen Alias für die angegebene Version des Bots oder ersetzt einen Alias für den angegebenen Bot. Um die Version des Bots zu ändern, auf die der Alias verweist, ersetzen Sie den Alias. Weitere Informationen zu Aliassen finden Sie unter Versioning und Aliasnamen.

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

Anforderungssyntax

PUT /bots/botName/aliases/name HTTP/1.1
Content-type: application/json

{
   "botVersion": "string",
   "checksum": "string",
   "conversationLogs": { 
      "iamRoleArn": "string",
      "logSettings": [ 
         { 
            "destination": "string",
            "kmsKeyArn": "string",
            "logType": "string",
            "resourceArn": "string"
         }
      ]
   },
   "description": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}

URI-Anfrageparameter

Die Anforderung verwendet die folgenden URI-Parameter.

botName

Der Name des Bots.

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

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

Erforderlich: Ja

name

Der Name des Alias. Beim Namen wird nicht zwischen Groß- und Kleinschreibung unterschieden.

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

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

Erforderlich: Ja

Anforderungstext

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

botVersion

Die Version des Bots.

Typ: Zeichenfolge

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

Pattern: \$LATEST|[0-9]+

Erforderlich: Ja

checksum

Identifiziert eine bestimmte Version der $LATEST Version.

Wenn Sie einen neuen Bot-Alias erstellen, lassen Sie das checksum Feld leer. Wenn Sie eine Prüfsumme angeben, erhalten Sie eine BadRequestException Ausnahme.

Wenn Sie einen Bot-Alias aktualisieren möchten, setzen Sie das checksum Feld auf die Prüfsumme der letzten Version der $LATEST Version. Wenn Sie das checksum Feld nicht angeben oder wenn die Prüfsumme nicht mit der $LATEST Version übereinstimmt, erhalten Sie eine PreconditionFailedException Ausnahme.

Typ: Zeichenfolge

Erforderlich: Nein

conversationLogs

Einstellungen für Konversationsprotokolle für den Alias.

Typ: ConversationLogsRequest Objekt

Erforderlich: Nein

description

Eine Beschreibung des Alias.

Typ: Zeichenfolge

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

Erforderlich: Nein

tags

Eine Liste von Tags, die dem Bot-Alias hinzugefügt werden sollen. Sie können Tags nur hinzufügen, wenn Sie einen Alias erstellen. Sie können den PutBotAlias Vorgang nicht verwenden, um die Tags eines Bot-Alias zu aktualisieren. Um Tags zu aktualisieren, verwenden Sie den TagResource-Vorgang.

Typ: Array von Tag-Objekten

Array-Mitglieder: Die Mindestanzahl beträgt 0 Elemente. Die maximale Anzahl beträgt 200 Elemente.

Erforderlich: Nein

Antwortsyntax

HTTP/1.1 200
Content-type: application/json

{
   "botName": "string",
   "botVersion": "string",
   "checksum": "string",
   "conversationLogs": { 
      "iamRoleArn": "string",
      "logSettings": [ 
         { 
            "destination": "string",
            "kmsKeyArn": "string",
            "logType": "string",
            "resourceArn": "string",
            "resourcePrefix": "string"
         }
      ]
   },
   "createdDate": number,
   "description": "string",
   "lastUpdatedDate": number,
   "name": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "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.

botName

Der Name des Bots, auf den der Alias zeigt.

Typ: Zeichenfolge

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

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

botVersion

Die Version des Bots, auf den der Alias verweist.

Typ: Zeichenfolge

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

Pattern: \$LATEST|[0-9]+

checksum

Die Prüfsumme für die aktuelle Version des Alias.

Typ: Zeichenfolge

conversationLogs

Die Einstellungen, die bestimmen, wie Amazon Lex Konversationsprotokolle für den Alias verwendet.

Typ: ConversationLogsResponse Objekt

createdDate

Das Datum, an dem der Bot-Alias erstellt wurde.

Typ: Zeitstempel

description

Eine Beschreibung des Alias.

Typ: Zeichenfolge

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

lastUpdatedDate

Das Datum, an dem der Bot-Alias aktualisiert wurde. Wenn Sie eine Ressource erstellen, stimmen das Erstellungsdatum und das Datum der letzten Aktualisierung überein.

Typ: Zeitstempel

name

Der Name des Alias.

Typ: Zeichenfolge

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

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

tags

Eine Liste von Tags, die einem Bot zugeordnet sind.

Typ: Array von Tag-Objekten

Array-Mitglieder: Die Mindestanzahl beträgt 0 Elemente. Die maximale Anzahl beträgt 200 Elemente.

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

ConflictException

Bei der Verarbeitung der Anfrage ist ein Konflikt aufgetreten. Versuchen Sie es erneut.

HTTP-Statuscode: 409

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

PreconditionFailedException

Die Prüfsumme der Ressource, die Sie ändern möchten, stimmt nicht mit der Prüfsumme in der Anfrage überein. Überprüfen Sie die Prüfsumme der Ressource und versuchen Sie es erneut.

HTTP-Statuscode: 412

Weitere Informationen finden Sie unter:

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