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

GetBotAliases

Retorna uma lista de alias para um bot específico do Amazon Lex.

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

Sintaxe da Solicitação

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

botName

O nome do bot.

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 aliases a ser retornado na resposta. O padrão é 50.

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

nameContains

Substring para corresponder aos nomes de alias do bot. Um alias 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 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 aliases. 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

{
   "BotAliases": [ 
      { 
         "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"
      }
   ],
   "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.

BotAliases

Uma matriz de objetos BotAliasMetadata, cada um descrevendo um alias de bot.

Tipo: matriz de objetos BotAliasMetadata

nextToken

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

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: