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

Aviso de fim do suporte: em 15 de setembro de 2025, o suporte para o Amazon Lex V1 AWS será interrompido. Depois de 15 de setembro de 2025, você não poderá mais acessar o console do Amazon Lex V1 ou os recursos do Amazon Lex V1. Se você estiver usando o Amazon Lex V2, consulte o guia do Amazon Lex V2 em vez disso.

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

GetBotChannelAssociation

Retorna informações sobre a associação entre um bot do Amazon Lex e uma plataforma de mensagens.

Essa operação exige permissões para a ação lex:GetBotChannelAssociation.

Sintaxe da Solicitação

GET /bots/botName/aliases/aliasName/channels/name 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.

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

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

Exigido: Sim

name

O nome da associação entre o bot e o canal. O nome diferencia maiúsculas e minúsculas.

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

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

Exigido: Sim

Corpo da Solicitação

Essa solicitação não tem corpo.

Sintaxe da resposta

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

Elementos de Resposta

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

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

botAlias

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

Tipo: String

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

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

botConfiguration

Fornece as informações que a plataforma de mensagens precisa para se comunicar com o bot do Amazon Lex.

Tipo: mapa de string para string

Entradas do mapa: número máximo de 10 itens.

botName

O nome do bot do Amazon Lex.

Tipo: String

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

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

createdDate

A data em que a associação entre o bot e o canal foi criada.

Tipo: Timestamp

description

A descrição da associação entre o bot e o canal.

Tipo: String

Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 200.

failureReason

Se status for FAILED, o Amazon Lex fornece o motivo da falha na criação da associação.

Tipo: String

name

O nome da associação entre o bot e o canal.

Tipo: String

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

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

status

O status do canal do bot.

  • CREATED - O canal foi criado e está pronto para uso.

  • IN_PROGRESS - A criação do canal está em andamento.

  • FAILED - Houve um erro ao criar o canal. Para obter informações sobre o motivo da falha, consulte o campo failureReason.

Tipo: String

Valores Válidos: IN_PROGRESS | CREATED | FAILED

type

O tipo da plataforma de mensagens.

Tipo: String

Valores Válidos: Facebook | Slack | Twilio-Sms | Kik

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

NotFoundException

O recurso especificado na solicitação não foi encontrado. Verifique o recurso e tente novamente.

Código de status HTTP: 404

Consulte também

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: