Aviso de fim do suporte: em 15 de setembro de 2025, o suporte para o Amazon Lex V1 AWS será interrompido. Após 15 de setembro de 2025, você não poderá mais acessar o console do Amazon Lex V1 nem os respectivos recursos. Se você estiver usando o Amazon Lex V2, consulte o [guia do Amazon Lex V2](https://docs.aws.amazon.com/lexv2/latest/dg/what-is.html) 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á.

# GetBot
<a name="API_GetBot"></a>

Retorna informações de metadados para um bot específico. Você deve fornecer o nome do bot e a versão ou o alias do bot. 

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

## Sintaxe da Solicitação
<a name="API_GetBot_RequestSyntax"></a>

```
GET /bots/name/versions/versionoralias HTTP/1.1
```

## Parâmetros da Solicitação de URI
<a name="API_GetBot_RequestParameters"></a>

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

 ** [name](#API_GetBot_RequestSyntax) **   <a name="lex-GetBot-request-uri-name"></a>
O nome do bot. O nome diferencia maiúsculas e minúsculas.   
Restrições de tamanho: tamanho mínimo 2. Tamanho máximo de 50.  
Padrão: `^([A-Za-z]_?)+$`   
Obrigatório: Sim

 ** [versionoralias](#API_GetBot_RequestSyntax) **   <a name="lex-GetBot-request-uri-versionOrAlias"></a>
A versão do alias do bot.  
Obrigatório: Sim

## Corpo da Solicitação
<a name="API_GetBot_RequestBody"></a>

Essa solicitação não tem corpo.

## Sintaxe da resposta
<a name="API_GetBot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "abortStatement": { 
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "checksum": "string",
   "childDirected": boolean,
   "clarificationPrompt": { 
      "maxAttempts": number,
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "createdDate": number,
   "description": "string",
   "detectSentiment": boolean,
   "enableModelImprovements": boolean,
   "failureReason": "string",
   "idleSessionTTLInSeconds": number,
   "intents": [ 
      { 
         "intentName": "string",
         "intentVersion": "string"
      }
   ],
   "lastUpdatedDate": number,
   "locale": "string",
   "name": "string",
   "nluIntentConfidenceThreshold": number,
   "status": "string",
   "version": "string",
   "voiceId": "string"
}
```

## Elementos de resposta
<a name="API_GetBot_ResponseElements"></a>

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.

 ** [abortStatement](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-abortStatement"></a>
A mensagem que o Amazon Lex retorna quando o usuário decide encerrar a conversa sem concluí-la. Para obter mais informações, consulte [PutBot](API_PutBot.md).  
Tipo: objeto [Statement](API_Statement.md)

 ** [checksum](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-checksum"></a>
Soma de verificação do bot usada para identificar uma revisão específica da versão `$LATEST` do bot.  
Tipo: String

 ** [childDirected](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-childDirected"></a>
Para cada bot do Amazon Lex criado com o Serviço de criação de modelo do Amazon Lex, você deve especificar se o uso do Amazon Lex está relacionado a um site, programa ou outro aplicativo direcionado, total ou parcialmente, a crianças menores de 13 anos e sujeito à Lei de Proteção à Privacidade Online Infantil (COPPA), especificando `true` ou `false` no `childDirected` campo. Ao especificar `true` no campo `childDirected`, você confirma que seu uso do Amazon Lex **está** relacionado a um site, programa ou outro aplicativo direcionado, total ou parcialmente, a crianças menores de 13 anos e sujeito à COPPA. Ao especificar `false` no campo `childDirected`, você confirma que seu uso do Amazon Lex **não está** relacionado a um site, programa ou outro aplicativo direcionado, total ou parcialmente, a crianças menores de 13 anos e sujeito à COPPA. Você não pode especificar um valor padrão para o campo `childDirected` que não reflita com precisão se o uso do Amazon Lex está relacionado a um site, programa ou outro aplicativo direcionado, total ou parcialmente, a crianças menores de 13 anos e sujeito à COPPA.  
Se o uso do Amazon Lex estiver relacionado a um site, programa ou outro aplicativo direcionado, total ou parcialmente, a crianças menores de 13 anos, você deverá obter qualquer consentimento parental verificável exigido pela COPPA. Para obter informações sobre o uso do Amazon Lex em conexão com sites, programas ou outros aplicativos direcionados, total ou parcialmente, a crianças menores de 13 anos, consulte as [perguntas frequentes do Amazon Lex](https://aws.amazon.com/lex/faqs#data-security).   
Tipo: booliano

 ** [clarificationPrompt](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-clarificationPrompt"></a>
A mensagem que o Amazon Lex usa quando não entende a solicitação do usuário. Para obter mais informações, consulte [PutBot](API_PutBot.md).   
Tipo: objeto [Prompt](API_Prompt.md)

 ** [createdDate](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-createdDate"></a>
A data e a hora em que o bot foi criado.  
Tipo: Timestamp

 ** [description](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-description"></a>
Uma descrição do bot.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 200.

 ** [detectSentiment](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-detectSentiment"></a>
Indica se as declarações inseridas pelo usuário devem ser enviadas ao Amazon Comprehend para análise de sentimento.  
Tipo: booliano

 ** [enableModelImprovements](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-enableModelImprovements"></a>
Indica se o bot usa melhorias de precisão. `true` indica que o bot está usando as melhorias, caso contrário, é `false`.  
Tipo: booliano

 ** [failureReason](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-failureReason"></a>
Se `status` for `FAILED`, o Amazon Lex explica por que não conseguiu criar o bot.  
Tipo: String

 ** [idleSessionTTLInSeconds](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-idleSessionTTLInSeconds"></a>
O tempo máximo em segundos que o Amazon Lex retém os dados coletados em uma conversa. Para obter mais informações, consulte [PutBot](API_PutBot.md).  
Tipo: inteiro  
Faixa válida: valor mínimo de 60. Valor máximo de 86.400.

 ** [intents](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-intents"></a>
Uma matriz de objetos `intent`. Para obter mais informações, consulte [PutBot](API_PutBot.md).  
Tipo: matriz de objetos [Intent](API_Intent.md)

 ** [lastUpdatedDate](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-lastUpdatedDate"></a>
A data em que o bot foi atualizado. Quando você cria um recurso, a data de criação e a data da última atualização são as mesmas.   
Tipo: Timestamp

 ** [locale](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-locale"></a>
 O local de destino deste bot.   
Tipo: String  
Valores válidos: `de-DE | en-AU | en-GB | en-IN | en-US | es-419 | es-ES | es-US | fr-FR | fr-CA | it-IT | ja-JP | ko-KR` 

 ** [name](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-name"></a>
O nome do bot.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 2. Tamanho máximo de 50.  
Padrão: `^([A-Za-z]_?)+$` 

 ** [nluIntentConfidenceThreshold](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-nluIntentConfidenceThreshold"></a>
A pontuação que determina onde o Amazon Lex insere o`AMAZON.FallbackIntent`,`AMAZON.KendraSearchIntent`, ou ambos ao retornar intenções alternativas em uma resposta [PostContent](https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html). [PostText](https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html) `AMAZON.FallbackIntent`será inserido se a pontuação de confiança para todas as intenções estiver abaixo desse valor. `AMAZON.KendraSearchIntent`só é inserido se estiver configurado para o bot.  
Tipo: duplo  
Intervalo válido: valor mínimo de 0. Valor máximo de 1.

 ** [status](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-status"></a>
O status do bot.   
Quando o status é `BUILDING`, o Amazon Lex está criando o bot para teste e uso.  
Se o status do bot for `READY_BASIC_TESTING`, você poderá testar o bot usando as declarações exatas especificadas nas intenções do bot. Quando o bot estiver pronto para o teste completo ou para ser executado, o status será `READY`.  
Se houve um problema com a criação do bot, o status será `FAILED` e o campo `failureReason` explica por que o bot não foi criado.  
Se o bot tiver sido salvo, mas não criado, o status será `NOT_BUILT`.  
Tipo: string  
Valores válidos: `BUILDING | READY | READY_BASIC_TESTING | FAILED | NOT_BUILT` 

 ** [version](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-version"></a>
A versão do bot. Para um novo bot, a versão é sempre `$LATEST`.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 64.  
Padrão: `\$LATEST|[0-9]+` 

 ** [voiceId](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-voiceId"></a>
O ID de voz do Amazon Polly que o Amazon Lex usa para a interação de voz com o usuário. Para obter mais informações, consulte [PutBot](API_PutBot.md).  
Tipo: string

## Erros
<a name="API_GetBot_Errors"></a>

 ** 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
<a name="API_GetBot_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetBot) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetBot) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetBot) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetBot) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetBot) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetBot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetBot) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetBot) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetBot) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetBot)