GetBotChannelAssociations - Amazon Lex V1

Si utiliza Amazon Lex V2, consulte la guía de Amazon Lex V2.

 

Si utiliza Amazon Lex V1, le recomendamos que actualice los bots a Amazon Lex V2. Hemos dejado de agregar nuevas características a V1, por lo que recomendamos encarecidamente utilizar V2 para todos los nuevos bots.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

GetBotChannelAssociations

Devuelve una lista de todos los canales asociados con el bot especificado.

La operación GetBotChannelAssociations necesita permisos para la acción lex:GetBotChannelAssociations.

Sintaxis de la solicitud

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

Parámetros de solicitud del URI

La solicitud utiliza los siguientes parámetros URI.

aliasName

Un alias que apunta a la versión exacta del bot de Amazon Lex al que se vincula esta asociación.

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 100 caracteres.

Patrón: ^(-|^([A-Za-z]_?)+$)$

Obligatorio: sí

botName

El nombre del bot de Amazon Lex en la asociación.

Limitaciones de longitud: longitud mínima de 2. La longitud máxima es de 50 caracteres.

Patrón: ^([A-Za-z]_?)+$

Obligatorio: sí

maxResults

El número máximo de asociaciones que se devuelven en una respuesta. El valor predeterminado es 50.

Rango válido: valor mínimo de 1. Valor máximo de 50.

nameContains

La subcadena que debe coincidir con los nombres de asociaciones de canal. Se devolverá una asociación si alguna parte del nombre coincide con la subcadena. Por ejemplo, “xyz” coincide con “xyzabc” y “abcxyz”. Para mostrar todas las asociaciones de canales de bots, utilice un guion (“-”) como parámetro nameContains.

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 100 caracteres.

Patrón: ^([A-Za-z]_?)+$

nextToken

Un token de paginación para obtener la siguiente página de asociaciones. Si la respuesta a esta llamada está truncada, Amazon Lex devuelve un token de paginación en la respuesta. Para obtener la siguiente página de asociaciones, especifique el token de paginación en la siguiente solicitud.

Cuerpo de la solicitud

La solicitud no tiene un cuerpo de la solicitud.

Sintaxis de la respuesta

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" }

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

botChannelAssociations

Una matriz de objetos, uno para cada asociación, que proporciona información acerca del bot de Amazon Lex y su asociación con el canal.

Tipo: matriz de objetos BotChannelAssociation

nextToken

Un token de paginación que obtiene la siguiente página de asociaciones. Si la respuesta a esta llamada está truncada, Amazon Lex devuelve un token de paginación en la respuesta. Para obtener la siguiente página de asociaciones, especifique el token de paginación en la siguiente solicitud.

Tipo: cadena

Errores

BadRequestException

La solicitud no está bien formulada. Es posible que un valor no sea válido o que falte un campo obligatorio. Revise los valores del campo e inténtelo de nuevo.

Código de estado HTTP: 400

InternalFailureException

Se ha producido un error interno de Amazon Lex. Intente volver a realizar la solicitud.

Código de estado HTTP: 500

LimitExceededException

La solicitud ha superado un límite. Intente volver a realizar la solicitud.

Código de estado HTTP: 429

Véase también

Para obtener más información sobre el uso de esta API en uno de los AWS SDK específicos del idioma, consulta lo siguiente: