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

GetBots

Retorna as informações do bot da seguinte forma:

  • Se você fornecer o campo nameContains, a resposta incluirá informações sobre a versão $LATEST de todos os bots cujo nome contém a string especificada.

  • Se você não especificar o campo nameContains, a operação retornará informações sobre a versão $LATEST de todos os seus bots.

Essa operação exige permissão para a ação lex:GetBots.

Sintaxe da Solicitação

GET /bots/?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:

maxResults

O número máximo de bots a ser retornado na resposta retornada pela solicitação. O padrão é 10.

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

nameContains

Substring para corresponder aos nomes do bot. Um bot será retornado se alguma parte de seu nome corresponder ao substring. Por exemplo, “xyz” corresponde a “xyzabc” e “abcxyz”.

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

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

nextToken

Um token de paginação que busca a próxima página de bots. 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 aliases, 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

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

bots

Uma matriz de objetos botMetadata, com uma entrada para cada bot.

Tipo: matriz de objetos BotMetadata

nextToken

Se a resposta for truncada, ela incluirá um token de paginação que você pode especificar em sua próxima solicitação para buscar a próxima página de bots.

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

NotFoundException

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

Código de Status HTTP: 404

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: