

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

# GetIntent
<a name="API_GetIntent"></a>

 Retorna informações sobre uma intenção. Além do nome da intenção, você deve especificar a versão da intenção. 

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

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

```
GET /intents/name/versions/version HTTP/1.1
```

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

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

 ** [name](#API_GetIntent_RequestSyntax) **   <a name="lex-GetIntent-request-uri-name"></a>
O nome da intenção. 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]_?)+$`   
Obrigatório: Sim

 ** [version](#API_GetIntent_RequestSyntax) **   <a name="lex-GetIntent-request-uri-version"></a>
A versão da intenção.  
Restrições de comprimento: tamanho mínimo de 1. O comprimento máximo é 64.  
Padrão: `\$LATEST|[0-9]+`   
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "checksum": "string",
   "conclusionStatement": { 
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "confirmationPrompt": { 
      "maxAttempts": number,
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "createdDate": number,
   "description": "string",
   "dialogCodeHook": { 
      "messageVersion": "string",
      "uri": "string"
   },
   "followUpPrompt": { 
      "prompt": { 
         "maxAttempts": number,
         "messages": [ 
            { 
               "content": "string",
               "contentType": "string",
               "groupNumber": number
            }
         ],
         "responseCard": "string"
      },
      "rejectionStatement": { 
         "messages": [ 
            { 
               "content": "string",
               "contentType": "string",
               "groupNumber": number
            }
         ],
         "responseCard": "string"
      }
   },
   "fulfillmentActivity": { 
      "codeHook": { 
         "messageVersion": "string",
         "uri": "string"
      },
      "type": "string"
   },
   "inputContexts": [ 
      { 
         "name": "string"
      }
   ],
   "kendraConfiguration": { 
      "kendraIndex": "string",
      "queryFilterString": "string",
      "role": "string"
   },
   "lastUpdatedDate": number,
   "name": "string",
   "outputContexts": [ 
      { 
         "name": "string",
         "timeToLiveInSeconds": number,
         "turnsToLive": number
      }
   ],
   "parentIntentSignature": "string",
   "rejectionStatement": { 
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "sampleUtterances": [ "string" ],
   "slots": [ 
      { 
         "defaultValueSpec": { 
            "defaultValueList": [ 
               { 
                  "defaultValue": "string"
               }
            ]
         },
         "description": "string",
         "name": "string",
         "obfuscationSetting": "string",
         "priority": number,
         "responseCard": "string",
         "sampleUtterances": [ "string" ],
         "slotConstraint": "string",
         "slotType": "string",
         "slotTypeVersion": "string",
         "valueElicitationPrompt": { 
            "maxAttempts": number,
            "messages": [ 
               { 
                  "content": "string",
                  "contentType": "string",
                  "groupNumber": number
               }
            ],
            "responseCard": "string"
         }
      }
   ],
   "version": "string"
}
```

## Elementos de resposta
<a name="API_GetIntent_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.

 ** [checksum](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-checksum"></a>
A soma de verificação da intenção.  
Tipo: String

 ** [conclusionStatement](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-conclusionStatement"></a>
Depois que a função do Lambda especificada no elemento `fulfillmentActivity` cumpre a intenção, o Amazon Lex transmite essa declaração ao usuário.  
Tipo: objeto [Statement](API_Statement.md)

 ** [confirmationPrompt](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-confirmationPrompt"></a>
Se definido no bot, o prompt que o Amazon Lex usa para confirmar a intenção do usuário antes de atendê-la. Para obter mais informações, consulte [PutIntent](API_PutIntent.md).   
Tipo: objeto [Prompt](API_Prompt.md)

 ** [createdDate](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-createdDate"></a>
A data em que a intenção foi criada.  
Tipo: Timestamp

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

 ** [dialogCodeHook](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-dialogCodeHook"></a>
Se definido no bot, o Amazon Lex invoca essa função do Lambda para cada entrada do usuário. Para obter mais informações, consulte [PutIntent](API_PutIntent.md).   
Tipo: objeto [CodeHook](API_CodeHook.md)

 ** [followUpPrompt](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-followUpPrompt"></a>
Se definido no bot, o Amazon Lex usa esse prompt para solicitar atividades adicionais do usuário depois que a intenção for atendida. Para obter mais informações, consulte [PutIntent](API_PutIntent.md).  
Tipo: objeto [FollowUpPrompt](API_FollowUpPrompt.md)

 ** [fulfillmentActivity](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-fulfillmentActivity"></a>
Descreve como a intenção é atendida. Para obter mais informações, consulte [PutIntent](API_PutIntent.md).   
Tipo: objeto [FulfillmentActivity](API_FulfillmentActivity.md)

 ** [inputContexts](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-inputContexts"></a>
Uma matriz de objetos `InputContext` que lista os contextos que devem estar ativos para que o Amazon Lex escolha a intenção em uma conversa com o usuário.  
Tipo: matriz de [InputContext](API_InputContext.md) objetos  
Membros da Matriz: número mínimo de 0 itens. Número máximo de 5 itens.

 ** [kendraConfiguration](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-kendraConfiguration"></a>
Informações de configuração, se houver, para conectar um índice do Amazon Kendra com a intenção `AMAZON.KendraSearchIntent`.  
Tipo: objeto [KendraConfiguration](API_KendraConfiguration.md)

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

 ** [name](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-name"></a>
O nome da intenção.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.  
Padrão: `^([A-Za-z]_?)+$` 

 ** [outputContexts](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-outputContexts"></a>
Uma matriz de objetos `OutputContext` que lista os contextos que a intenção ativa quando a intenção é atendida.  
Tipo: matriz de objetos [OutputContext](API_OutputContext.md)  
Membros da Matriz: número mínimo de 0 itens. Número máximo de 10 itens.

 ** [parentIntentSignature](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-parentIntentSignature"></a>
Um identificador exclusivo de uma intenção integrada.  
Tipo: string

 ** [rejectionStatement](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-rejectionStatement"></a>
Quando o usuário responde “não” à pergunta definida em `confirmationPrompt`, o Amazon Lex responde com essa mensagem para confirmar que a intenção foi cancelada.   
Tipo: objeto [Statement](API_Statement.md)

 ** [sampleUtterances](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-sampleUtterances"></a>
Uma matriz de amostra de declarações configurada para a intenção.  
Tipo: matriz de strings  
Membros da matriz: número mínimo de 0 itens. Número máximo de 1.500 itens.  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 200.

 ** [slots](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-slots"></a>
Uma matriz de slots de intenção configurados para a intenção.  
Tipo: matriz de objetos [Slot](API_Slot.md)  
Membros da Matriz: número mínimo de 0 itens. Número máximo de 100 itens.

 ** [version](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-version"></a>
A versão da intenção.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 64.  
Padrão: `\$LATEST|[0-9]+` 

## Erros
<a name="API_GetIntent_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_GetIntent_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/GetIntent) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetIntent) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetIntent) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetIntent) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetIntent) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetIntent) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetIntent) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetIntent) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetIntent) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetIntent) 