GetBotChannelAssociations - Amazon Lex V1
Sintaxe da SolicitaçãoParâmetros da Solicitação de URICorpo da SolicitaçãoSintaxe da RespostaElementos de RespostaErrosConsulte também

Se você estiver usando o Amazon Lex V2, consulte o Guia do Amazon Lex V2.

 

Se você estiver usando o Amazon Lex V1, recomendamos atualizar seus bots para o Amazon Lex V2. Não estamos mais adicionando novos atributos à V1 e recomendamos o uso da V2 para todos os novos bots.

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

GetBotChannelAssociations

Retorna uma lista de todos os canais associados a um bot específico.

A operação GetBotChannelAssociations exige permissões para a ação lex:GetBotChannelAssociations.

Sintaxe da Solicitação

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

Parâmetros da Solicitação de URI

A solicitação usa os seguintes parâmetros de URI:

aliasName

Um alias que aponta para a versão específica do bot do Amazon Lex à qual essa associação está sendo feita.

Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.

Padrão: ^(-|^([A-Za-z]_?)+$)$

Exigido: Sim

botName

O nome do bot do Amazon Lex na associação.

Restrições de tamanho: tamanho mínimo 2. Tamanho máximo de 50.

Padrão: ^([A-Za-z]_?)+$

Exigido: Sim

maxResults

O número máximo de associações a ser retornado na resposta. O padrão é 50.

Faixa válida: valor mínimo de 1. Valor máximo de 50.

nameContains

Substring a ser correspondente nos nomes das associações de canais. Uma associação será retornada se alguma parte de seu nome corresponder ao substring. Por exemplo, “xyz” corresponde a “xyzabc” e “abcxyz”. Para retornar todas as associações de canais de bots, use um hífen (“-”) como nameContains parâmetro.

Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.

Padrão: ^([A-Za-z]_?)+$

nextToken

Um token de paginação para buscar a próxima página de associações. Se a resposta a essa chamada for truncada, o Amazon Lex retornará um token de paginação na resposta. Para buscar a próxima página de associações, especifique o token de paginação na próxima solicitação.

Corpo da Solicitação

Essa solicitação não tem corpo.

Sintaxe da Resposta

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 Resposta

Se a ação tiver êxito, o serviço enviará de volta uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

botChannelAssociations

Uma matriz de objetos, uma para cada associação, que fornece informações sobre o bot do Amazon Lex e sua associação com o canal.

Tipo: matriz de objetos BotChannelAssociation

nextToken

Um token de paginação que busca a próxima página de associações. Se a resposta a essa chamada for truncada, o Amazon Lex retornará um token de paginação na resposta. Para buscar a próxima página de associações, especifique o token de paginação na próxima solicitação.

Tipo: string

Erros

BadRequestException

A solicitação não está bem formada. Por exemplo, um valor é inválido ou um campo obrigatório está faltando. Verifique os valores dos campos e tente novamente.

Código de Status HTTP: 400

InternalFailureException

Ocorreu um erro interno do Amazon Lex. Tente sua solicitação novamente.

Código de Status HTTP: 500

LimitExceededException

A solicitação excedeu um limite. Tente sua solicitação novamente.

Código de status HTTP: 429

Consulte também

Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos da linguagem, consulte o seguinte: