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

# GetSession
<a name="API_runtime_GetSession"></a>

Retorna informações de sessão para um bot, alias e ID de usuário especificado.

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

```
GET /bot/botName/alias/botAlias/user/userId/session/?checkpointLabelFilter=checkpointLabelFilter HTTP/1.1
```

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

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

 ** [botAlias](#API_runtime_GetSession_RequestSyntax) **   <a name="lex-runtime_GetSession-request-uri-botAlias"></a>
O alias em uso para o bot que contém os dados da sessão.  
Obrigatório: Sim

 ** [botName](#API_runtime_GetSession_RequestSyntax) **   <a name="lex-runtime_GetSession-request-uri-botName"></a>
O nome do bot que contém os dados da sessão.  
Obrigatório: Sim

 ** [checkpointLabelFilter](#API_runtime_GetSession_RequestSyntax) **   <a name="lex-runtime_GetSession-request-uri-checkpointLabelFilter"></a>
Uma string usada para filtrar as intenções retornadas na estrutura `recentIntentSummaryView`.   
Quando você especifica um filtro, somente as intenções com o campo `checkpointLabel` definido para essa string são retornadas.  
Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 255.  
Padrão: `[a-zA-Z0-9-]+` 

 ** [userId](#API_runtime_GetSession_RequestSyntax) **   <a name="lex-runtime_GetSession-request-uri-userId"></a>
O ID do usuário do aplicativo cliente. O Amazon Lex usa isso para identificar a conversa de um usuário com seu bot.   
Restrições de tamanho: tamanho mínimo 2. Comprimento máximo de 100.  
Padrão: `[0-9a-zA-Z._:-]+`   
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "activeContexts": [ 
      { 
         "name": "string",
         "parameters": { 
            "string" : "string" 
         },
         "timeToLive": { 
            "timeToLiveInSeconds": number,
            "turnsToLive": number
         }
      }
   ],
   "dialogAction": { 
      "fulfillmentState": "string",
      "intentName": "string",
      "message": "string",
      "messageFormat": "string",
      "slots": { 
         "string" : "string" 
      },
      "slotToElicit": "string",
      "type": "string"
   },
   "recentIntentSummaryView": [ 
      { 
         "checkpointLabel": "string",
         "confirmationStatus": "string",
         "dialogActionType": "string",
         "fulfillmentState": "string",
         "intentName": "string",
         "slots": { 
            "string" : "string" 
         },
         "slotToElicit": "string"
      }
   ],
   "sessionAttributes": { 
      "string" : "string" 
   },
   "sessionId": "string"
}
```

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

 ** [activeContexts](#API_runtime_GetSession_ResponseSyntax) **   <a name="lex-runtime_GetSession-response-activeContexts"></a>
Uma lista de contextos ativos para a sessão. Um contexto pode ser definido quando uma intenção é cumprida ou chamando a operação `PostContent`, `PostText` ou `PutSession`.  
Você pode usar um contexto para controlar as intenções que podem acompanhar uma intenção ou para modificar a operação do seu aplicativo.  
Tipo: matriz de objetos [ActiveContext](API_runtime_ActiveContext.md)  
Membros da Matriz: número mínimo de 0 itens. Número máximo de 20 itens.

 ** [dialogAction](#API_runtime_GetSession_ResponseSyntax) **   <a name="lex-runtime_GetSession-response-dialogAction"></a>
Descreve o estado atual do bot.  
Tipo: objeto [DialogAction](API_runtime_DialogAction.md)

 ** [recentIntentSummaryView](#API_runtime_GetSession_ResponseSyntax) **   <a name="lex-runtime_GetSession-response-recentIntentSummaryView"></a>
Uma matriz de informações sobre as intenções usadas na sessão. A matriz pode conter no máximo três resumos. Se mais de três intenções forem usadas na sessão, a operação `recentIntentSummaryView` conterá informações sobre as últimas três intenções usadas.  
Se você definir o parâmetro `checkpointLabelFilter` na solicitação, a matriz conterá somente as intenções com o rótulo especificado.  
Tipo: matriz de objetos [IntentSummary](API_runtime_IntentSummary.md)  
Membros da Matriz: número mínimo de 0 itens. Número máximo de 3 itens.

 ** [sessionAttributes](#API_runtime_GetSession_ResponseSyntax) **   <a name="lex-runtime_GetSession-response-sessionAttributes"></a>
Mapa de key/value pares representando as informações de contexto específicas da sessão. Ele contém informações do aplicativo passadas entre o Amazon Lex e um aplicativo cliente.  
Tipo: mapa de string para string

 ** [sessionId](#API_runtime_GetSession_ResponseSyntax) **   <a name="lex-runtime_GetSession-response-sessionId"></a>
Um identificador exclusivo da sessão.  
Tipo: string

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

 ** BadRequestException **   
 A validação da solicitação falhou, não há mensagem utilizável no contexto ou a compilação do bot falhou, ainda está em andamento ou contém alterações não criadas.   
Código de status HTTP: 400

 ** InternalFailureException **   
Erro de serviço interno. Tente a chamada novamente.  
Código de status HTTP: 500

 ** LimitExceededException **   
Excedeu um limite.  
Código de status HTTP: 429

 ** NotFoundException **   
O recurso (como o bot Amazon Lex ou um alias) mencionado não foi encontrado.  
Código de status HTTP: 404

## Consulte Também
<a name="API_runtime_GetSession_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/runtime.lex-2016-11-28/GetSession) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/runtime.lex-2016-11-28/GetSession) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/GetSession) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/runtime.lex-2016-11-28/GetSession) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/GetSession) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/runtime.lex-2016-11-28/GetSession) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/runtime.lex-2016-11-28/GetSession) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/runtime.lex-2016-11-28/GetSession) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/runtime.lex-2016-11-28/GetSession) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/GetSession)