

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

# Ações
<a name="API_Operations"></a>

As seguintes ações são compatíveis com o Serviço de criação de modelos do Amazon Lex:
+  [CreateBotVersion](API_CreateBotVersion.md) 
+  [CreateIntentVersion](API_CreateIntentVersion.md) 
+  [CreateSlotTypeVersion](API_CreateSlotTypeVersion.md) 
+  [DeleteBot](API_DeleteBot.md) 
+  [DeleteBotAlias](API_DeleteBotAlias.md) 
+  [DeleteBotChannelAssociation](API_DeleteBotChannelAssociation.md) 
+  [DeleteBotVersion](API_DeleteBotVersion.md) 
+  [DeleteIntent](API_DeleteIntent.md) 
+  [DeleteIntentVersion](API_DeleteIntentVersion.md) 
+  [DeleteSlotType](API_DeleteSlotType.md) 
+  [DeleteSlotTypeVersion](API_DeleteSlotTypeVersion.md) 
+  [DeleteUtterances](API_DeleteUtterances.md) 
+  [GetBot](API_GetBot.md) 
+  [GetBotAlias](API_GetBotAlias.md) 
+  [GetBotAliases](API_GetBotAliases.md) 
+  [GetBotChannelAssociation](API_GetBotChannelAssociation.md) 
+  [GetBotChannelAssociations](API_GetBotChannelAssociations.md) 
+  [GetBots](API_GetBots.md) 
+  [GetBotVersions](API_GetBotVersions.md) 
+  [GetBuiltinIntent](API_GetBuiltinIntent.md) 
+  [GetBuiltinIntents](API_GetBuiltinIntents.md) 
+  [GetBuiltinSlotTypes](API_GetBuiltinSlotTypes.md) 
+  [GetExport](API_GetExport.md) 
+  [GetImport](API_GetImport.md) 
+  [GetIntent](API_GetIntent.md) 
+  [GetIntents](API_GetIntents.md) 
+  [GetIntentVersions](API_GetIntentVersions.md) 
+  [GetMigration](API_GetMigration.md) 
+  [GetMigrations](API_GetMigrations.md) 
+  [GetSlotType](API_GetSlotType.md) 
+  [GetSlotTypes](API_GetSlotTypes.md) 
+  [GetSlotTypeVersions](API_GetSlotTypeVersions.md) 
+  [GetUtterancesView](API_GetUtterancesView.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [PutBot](API_PutBot.md) 
+  [PutBotAlias](API_PutBotAlias.md) 
+  [PutIntent](API_PutIntent.md) 
+  [PutSlotType](API_PutSlotType.md) 
+  [StartImport](API_StartImport.md) 
+  [StartMigration](API_StartMigration.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 

As seguintes ações são compatíveis com o Serviço de runtime do Amazon Lex:
+  [DeleteSession](API_runtime_DeleteSession.md) 
+  [GetSession](API_runtime_GetSession.md) 
+  [PostContent](API_runtime_PostContent.md) 
+  [PostText](API_runtime_PostText.md) 
+  [PutSession](API_runtime_PutSession.md) 

# Serviço de criação de modelos do Amazon Lex
<a name="API_Operations_Amazon_Lex_Model_Building_Service"></a>

As seguintes ações são compatíveis com o Serviço de criação de modelos do Amazon Lex:
+  [CreateBotVersion](API_CreateBotVersion.md) 
+  [CreateIntentVersion](API_CreateIntentVersion.md) 
+  [CreateSlotTypeVersion](API_CreateSlotTypeVersion.md) 
+  [DeleteBot](API_DeleteBot.md) 
+  [DeleteBotAlias](API_DeleteBotAlias.md) 
+  [DeleteBotChannelAssociation](API_DeleteBotChannelAssociation.md) 
+  [DeleteBotVersion](API_DeleteBotVersion.md) 
+  [DeleteIntent](API_DeleteIntent.md) 
+  [DeleteIntentVersion](API_DeleteIntentVersion.md) 
+  [DeleteSlotType](API_DeleteSlotType.md) 
+  [DeleteSlotTypeVersion](API_DeleteSlotTypeVersion.md) 
+  [DeleteUtterances](API_DeleteUtterances.md) 
+  [GetBot](API_GetBot.md) 
+  [GetBotAlias](API_GetBotAlias.md) 
+  [GetBotAliases](API_GetBotAliases.md) 
+  [GetBotChannelAssociation](API_GetBotChannelAssociation.md) 
+  [GetBotChannelAssociations](API_GetBotChannelAssociations.md) 
+  [GetBots](API_GetBots.md) 
+  [GetBotVersions](API_GetBotVersions.md) 
+  [GetBuiltinIntent](API_GetBuiltinIntent.md) 
+  [GetBuiltinIntents](API_GetBuiltinIntents.md) 
+  [GetBuiltinSlotTypes](API_GetBuiltinSlotTypes.md) 
+  [GetExport](API_GetExport.md) 
+  [GetImport](API_GetImport.md) 
+  [GetIntent](API_GetIntent.md) 
+  [GetIntents](API_GetIntents.md) 
+  [GetIntentVersions](API_GetIntentVersions.md) 
+  [GetMigration](API_GetMigration.md) 
+  [GetMigrations](API_GetMigrations.md) 
+  [GetSlotType](API_GetSlotType.md) 
+  [GetSlotTypes](API_GetSlotTypes.md) 
+  [GetSlotTypeVersions](API_GetSlotTypeVersions.md) 
+  [GetUtterancesView](API_GetUtterancesView.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [PutBot](API_PutBot.md) 
+  [PutBotAlias](API_PutBotAlias.md) 
+  [PutIntent](API_PutIntent.md) 
+  [PutSlotType](API_PutSlotType.md) 
+  [StartImport](API_StartImport.md) 
+  [StartMigration](API_StartMigration.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 

# CreateBotVersion
<a name="API_CreateBotVersion"></a>

Cria uma nova versão do bot com base na versão do `$LATEST`. Se a versão `$LATEST` deste recurso não tiver sido alterada desde que você criou a última versão, o Amazon Lex não criará uma nova versão e retorna a última versão criada. Ele retorna a última versão criada.

**nota**  
Você pode atualizar apenas a versão `$LATEST` do bot. Você não pode atualizar as versões numeradas que você cria com a operação `CreateBotVersion`.

 Quando você cria a primeira versão de um bot, o Amazon Lex define essa versão como 1. As versões subsequentes são incrementadas em 1. Para obter mais informações, consulte [Versionamento](versioning-aliases.md#versioning-intro). 

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

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

```
POST /bots/name/versions HTTP/1.1
Content-type: application/json

{
   "checksum": "string"
}
```

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

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

 ** [name](#API_CreateBotVersion_RequestSyntax) **   <a name="lex-CreateBotVersion-request-uri-name"></a>
O nome do bot do qual você deseja criar uma nova versão. 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

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

A solicitação aceita os dados a seguir no formato JSON.

 ** [checksum](#API_CreateBotVersion_RequestSyntax) **   <a name="lex-CreateBotVersion-request-checksum"></a>
Identifica uma revisão específica da versão `$LATEST` do bot. Se você especificar uma soma de verificação e a versão `$LATEST` do bot tiver uma soma de verificação diferente, uma exceção `PreconditionFailedException` será retornada e o Amazon Lex não publicará uma nova versão. Se você não especificar uma soma de verificação, o Amazon Lex publicará a versão `$LATEST`.  
Tipo: String  
Obrigatório: não

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

```
HTTP/1.1 201
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",
   "status": "string",
   "version": "string",
   "voiceId": "string"
}
```

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

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 201.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [abortStatement](#API_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-response-abortStatement"></a>
A mensagem que o Amazon Lex usa para cancelar uma conversa. Para obter mais informações, consulte [PutBot](API_PutBot.md).  
Tipo: objeto [Statement](API_Statement.md)

 ** [checksum](#API_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-response-checksum"></a>
Soma de verificação que identifica a versão do bot que foi criado.  
Tipo: string

 ** [childDirected](#API_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-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_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-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_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-response-createdDate"></a>
A data em que a versão do bot foi criada.  
Tipo: Timestamp

 ** [description](#API_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-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_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-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_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-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_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-response-failureReason"></a>
Se `status` for `FAILED`, o Amazon Lex fornece o motivo da falha na criação do bot.  
Tipo: string

 ** [idleSessionTTLInSeconds](#API_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-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_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-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_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-response-lastUpdatedDate"></a>
A data em que a versão `$LATEST` deste bot foi atualizada.   
Tipo: Timestamp

 ** [locale](#API_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-response-locale"></a>
 Especifica a localidade 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_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-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]_?)+$` 

 ** [status](#API_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-response-status"></a>
 Ao enviar uma solicitação para criar ou atualizar um bot, o Amazon Lex define o elemento de resposta `status` como `BUILDING`. Depois que o Amazon Lex cria o bot, ele define `status` como `READY`. Se o Amazon Lex não puder criar o bot, ele define `status` como `FAILED`. O Amazon Lex retorna o motivo da falha no elemento de resposta `failureReason`.   
Tipo: string  
Valores válidos: `BUILDING | READY | READY_BASIC_TESTING | FAILED | NOT_BUILT` 

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

 ** [voiceId](#API_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-response-voiceId"></a>
O ID de voz do Amazon Polly que o Amazon Lex usa para interações de voz com o usuário.  
Tipo: string

## Erros
<a name="API_CreateBotVersion_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

 ** ConflictException **   
 Houve um conflito ao processar a solicitação. Tente sua solicitação novamente.   
Código de Status HTTP: 409

 ** 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

 ** PreconditionFailedException **   
 A soma de verificação do recurso que você está tentando alterar não corresponde à soma de verificação na solicitação. Verifique a soma de verificação e tente novamente.  
Código de status HTTP: 412

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

# CreateIntentVersion
<a name="API_CreateIntentVersion"></a>

Cria uma nova versão de uma intenção com base na versão `$LATEST` da intenção. Se a versão `$LATEST` desta intenção não tiver sido alterada desde que você a criou, o Amazon Lex não criará uma nova versão. Ele retorna a última versão criada.

**nota**  
Você pode atualizar apenas a versão `$LATEST` da intenção. Você não pode atualizar as versões numeradas que você cria com a operação `CreateIntentVersion`.

 Quando você cria uma versão de uma intenção, o Amazon Lex define a versão como 1. As versões subsequentes são incrementadas em 1. Para obter mais informações, consulte [Versionamento](versioning-aliases.md#versioning-intro). 

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

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

```
POST /intents/name/versions HTTP/1.1
Content-type: application/json

{
   "checksum": "string"
}
```

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

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

 ** [name](#API_CreateIntentVersion_RequestSyntax) **   <a name="lex-CreateIntentVersion-request-uri-name"></a>
O nome da intenção da qual você deseja criar uma nova versã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

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

A solicitação aceita os dados a seguir no formato JSON.

 ** [checksum](#API_CreateIntentVersion_RequestSyntax) **   <a name="lex-CreateIntentVersion-request-checksum"></a>
Soma de verificação da versão `$LATEST` da intenção que deve ser usada para criar a nova versão. Se você especificar uma soma de verificação e a versão `$LATEST` da intenção tiver uma soma de verificação diferente, o Amazon Lex retornará uma exceção `PreconditionFailedException` e não publicará uma nova versão. Se você não especificar uma soma de verificação, o Amazon Lex publicará a versão `$LATEST`.  
Tipo: String  
Obrigatório: não

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

```
HTTP/1.1 201
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_CreateIntentVersion_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 201.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [checksum](#API_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-response-checksum"></a>
Soma de verificação da versão de intenção criada.  
Tipo: String

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

 ** [confirmationPrompt](#API_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-response-confirmationPrompt"></a>
Se definido, o prompt que o Amazon Lex usa para confirmar a intenção do usuário antes de atendê-la.   
Tipo: objeto [Prompt](API_Prompt.md)

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

 ** [description](#API_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-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_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-response-dialogCodeHook"></a>
Se definido, o Amazon Lex invoca essa função do Lambda para cada entrada do usuário.  
Tipo: objeto [CodeHook](API_CodeHook.md)

 ** [followUpPrompt](#API_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-response-followUpPrompt"></a>
Se definido, o Amazon Lex usa esse prompt para solicitar atividades adicionais do usuário depois que a intenção for atendida.   
Tipo: objeto [FollowUpPrompt](API_FollowUpPrompt.md)

 ** [fulfillmentActivity](#API_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-response-fulfillmentActivity"></a>
 Descreve como a intenção é atendida.   
Tipo: objeto [FulfillmentActivity](API_FulfillmentActivity.md)

 ** [inputContexts](#API_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-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_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-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_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-response-lastUpdatedDate"></a>
A data em que a intenção foi atualizada.   
Tipo: Timestamp

 ** [name](#API_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-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_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-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_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-response-parentIntentSignature"></a>
Um identificador exclusivo de uma intenção integrada.  
Tipo: string

 ** [rejectionStatement](#API_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-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_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-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_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-response-slots"></a>
Uma variedade de tipos de slots que define as informações necessárias para atender 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_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-response-version"></a>
O número da versão atribuída à nova 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_CreateIntentVersion_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

 ** ConflictException **   
 Houve um conflito ao processar a solicitação. Tente sua solicitação novamente.   
Código de Status HTTP: 409

 ** 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

 ** PreconditionFailedException **   
 A soma de verificação do recurso que você está tentando alterar não corresponde à soma de verificação na solicitação. Verifique a soma de verificação e tente novamente.  
Código de status HTTP: 412

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

# CreateSlotTypeVersion
<a name="API_CreateSlotTypeVersion"></a>

Cria uma nova versão com base na versão `$LATEST` do tipo de slot especificado. Se a versão `$LATEST` deste recurso não tiver sido alterada desde que você criou a última versão, o Amazon Lex não criará uma nova versão e retorna a última versão criada. Ele retorna a última versão criada. 

**nota**  
Você pode atualizar apenas a versão `$LATEST` de um tipo de slot. Não é possível atualizar as versões numeradas que você cria com a operação `CreateSlotTypeVersion`.

Quando você cria uma versão de um tipo de slot, o Amazon Lex define a versão como 1. As versões subsequentes são incrementadas em 1. Para obter mais informações, consulte [Versionamento](versioning-aliases.md#versioning-intro). 

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

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

```
POST /slottypes/name/versions HTTP/1.1
Content-type: application/json

{
   "checksum": "string"
}
```

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

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

 ** [name](#API_CreateSlotTypeVersion_RequestSyntax) **   <a name="lex-CreateSlotTypeVersion-request-uri-name"></a>
O nome do tipo de slot do qual você deseja criar uma nova versã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

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

A solicitação aceita os dados a seguir no formato JSON.

 ** [checksum](#API_CreateSlotTypeVersion_RequestSyntax) **   <a name="lex-CreateSlotTypeVersion-request-checksum"></a>
Soma de verificação da versão `$LATEST` do tipo de slot que você deseja publicar. Se você especificar uma soma de verificação e a versão `$LATEST` da intenção tiver uma soma de verificação diferente, o Amazon Lex retornará uma exceção `PreconditionFailedException` e não publicará a nova versão. Se você não especificar uma soma de verificação, o Amazon Lex publicará a versão `$LATEST`.  
Tipo: String  
Obrigatório: não

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

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

{
   "checksum": "string",
   "createdDate": number,
   "description": "string",
   "enumerationValues": [ 
      { 
         "synonyms": [ "string" ],
         "value": "string"
      }
   ],
   "lastUpdatedDate": number,
   "name": "string",
   "parentSlotTypeSignature": "string",
   "slotTypeConfigurations": [ 
      { 
         "regexConfiguration": { 
            "pattern": "string"
         }
      }
   ],
   "valueSelectionStrategy": "string",
   "version": "string"
}
```

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

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 201.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [checksum](#API_CreateSlotTypeVersion_ResponseSyntax) **   <a name="lex-CreateSlotTypeVersion-response-checksum"></a>
Soma de verificação da versão `$LATEST` do tipo de slot.  
Tipo: String

 ** [createdDate](#API_CreateSlotTypeVersion_ResponseSyntax) **   <a name="lex-CreateSlotTypeVersion-response-createdDate"></a>
A data em que o tipo de slot foi criado.  
Tipo: Timestamp

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

 ** [enumerationValues](#API_CreateSlotTypeVersion_ResponseSyntax) **   <a name="lex-CreateSlotTypeVersion-response-enumerationValues"></a>
Uma lista de objetos `EnumerationValue` que define os valores que o tipo de slot pode ter.  
Tipo: matriz de objetos [EnumerationValue](API_EnumerationValue.md)  
Membros da Matriz: número mínimo de 0 itens. Número máximo de 10.000 itens.

 ** [lastUpdatedDate](#API_CreateSlotTypeVersion_ResponseSyntax) **   <a name="lex-CreateSlotTypeVersion-response-lastUpdatedDate"></a>
A data em que o tipo de slot 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

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

 ** [parentSlotTypeSignature](#API_CreateSlotTypeVersion_ResponseSyntax) **   <a name="lex-CreateSlotTypeVersion-response-parentSlotTypeSignature"></a>
O tipo de slot integrado usado como pai do tipo de slot.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.  
Padrão: `^((AMAZON\.)_?|[A-Za-z]_?)+` 

 ** [slotTypeConfigurations](#API_CreateSlotTypeVersion_ResponseSyntax) **   <a name="lex-CreateSlotTypeVersion-response-slotTypeConfigurations"></a>
Informações de configuração que estendem o tipo de slot integrado principal.  
Tipo: matriz de objetos [SlotTypeConfiguration](API_SlotTypeConfiguration.md)  
Membros da Matriz: número mínimo de 0 itens. Número máximo de 10 itens.

 ** [valueSelectionStrategy](#API_CreateSlotTypeVersion_ResponseSyntax) **   <a name="lex-CreateSlotTypeVersion-response-valueSelectionStrategy"></a>
A estratégia que o Amazon Lex usa para determinar o valor de slot. Para obter mais informações, consulte [PutSlotType](API_PutSlotType.md).  
Tipo: String  
Valores válidos: `ORIGINAL_VALUE | TOP_RESOLUTION` 

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

## Erros
<a name="API_CreateSlotTypeVersion_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

 ** ConflictException **   
 Houve um conflito ao processar a solicitação. Tente sua solicitação novamente.   
Código de Status HTTP: 409

 ** 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

 ** PreconditionFailedException **   
 A soma de verificação do recurso que você está tentando alterar não corresponde à soma de verificação na solicitação. Verifique a soma de verificação e tente novamente.  
Código de status HTTP: 412

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

# DeleteBot
<a name="API_DeleteBot"></a>

Exclui todas as versões do bot, incluindo a versão `$LATEST`. Para excluir uma versão específica do bot, use a operação [DeleteBotVersion](API_DeleteBotVersion.md). A operação `DeleteBot` não remove imediatamente o esquema do bot. Em vez disso, ele é marcado para exclusão e removido posteriormente.

O Amazon Lex armazena declarações indefinidamente para melhorar a capacidade do seu bot de responder às entradas do usuário. Essas declarações não são removidas quando o bot é excluído. Para remover as declarações, use a operação [DeleteUtterances](API_DeleteUtterances.md).

Se um bot tiver um alias, você não conseguirá excluí-lo. Em vez disso, a operação `DeleteBot` retorna uma exceção `ResourceInUseException` que inclui uma referência ao alias que se refere ao bot. Para remover a referência ao bot, exclua o alias. Se você receber a mesma exceção novamente, exclua o alias de referência até que a operação `DeleteBot` seja bem-sucedida.

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

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

```
DELETE /bots/name HTTP/1.1
```

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

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

 ** [name](#API_DeleteBot_RequestSyntax) **   <a name="lex-DeleteBot-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

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

Essa solicitação não tem corpo.

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

```
HTTP/1.1 204
```

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

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 204 com um corpo HTTP vazio.

## Erros
<a name="API_DeleteBot_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

 ** ConflictException **   
 Houve um conflito ao processar a solicitação. Tente sua solicitação novamente.   
Código de Status HTTP: 409

 ** 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

 ** ResourceInUseException **   
O recurso que você está tentando excluir é referenciado por outro recurso. Use essas informações para remover referências ao recurso que você está tentando excluir.  
O corpo da exceção contém um objeto JSON que descreve o recurso.  
 `{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,`   
 `"resourceReference": {`   
 `"name": string, "version": string } }`     
 ** exampleReference **   
Descreve o recurso que se refere ao recurso que você está tentando excluir. Esse objeto é retornado como parte da exceção `ResourceInUseException`. 
Código de Status HTTP: 400

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

# DeleteBotAlias
<a name="API_DeleteBotAlias"></a>

Exclui um alias de um bot especificado. 

Não é possível excluir um alias usado na associação entre um bot e um canal de mensagens. Se um alias for usado em uma associação de canal, a operação `DeleteBot` retornará uma exceção `ResourceInUseException` que inclui uma referência à associação de canal referente ao bot. Você pode remover a referência ao alias excluindo a associação do canal. Se você receber a mesma exceção novamente, exclua a associação de referência até que a operação `DeleteBotAlias` seja bem-sucedida.

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

```
DELETE /bots/botName/aliases/name HTTP/1.1
```

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

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

 ** [botName](#API_DeleteBotAlias_RequestSyntax) **   <a name="lex-DeleteBotAlias-request-uri-botName"></a>
O nome do bot para o qual o alias aponta.  
Restrições de tamanho: tamanho mínimo 2. Tamanho máximo de 50.  
Padrão: `^([A-Za-z]_?)+$`   
Obrigatório: Sim

 ** [name](#API_DeleteBotAlias_RequestSyntax) **   <a name="lex-DeleteBotAlias-request-uri-name"></a>
O nome do alias a ser excluído. 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

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

Essa solicitação não tem corpo.

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

```
HTTP/1.1 204
```

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

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 204 com um corpo HTTP vazio.

## Erros
<a name="API_DeleteBotAlias_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

 ** ConflictException **   
 Houve um conflito ao processar a solicitação. Tente sua solicitação novamente.   
Código de Status HTTP: 409

 ** 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

 ** ResourceInUseException **   
O recurso que você está tentando excluir é referenciado por outro recurso. Use essas informações para remover referências ao recurso que você está tentando excluir.  
O corpo da exceção contém um objeto JSON que descreve o recurso.  
 `{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,`   
 `"resourceReference": {`   
 `"name": string, "version": string } }`     
 ** exampleReference **   
Descreve o recurso que se refere ao recurso que você está tentando excluir. Esse objeto é retornado como parte da exceção `ResourceInUseException`. 
Código de Status HTTP: 400

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

# DeleteBotChannelAssociation
<a name="API_DeleteBotChannelAssociation"></a>

Exclui a associação entre um bot do Amazon Lex e uma plataforma de mensagens.

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

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

```
DELETE /bots/botName/aliases/aliasName/channels/name HTTP/1.1
```

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

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

 ** [aliasName](#API_DeleteBotChannelAssociation_RequestSyntax) **   <a name="lex-DeleteBotChannelAssociation-request-uri-botAlias"></a>
Um alias que aponta para a versão específica do bot do Amazon Lex à qual essa associação está sendo feita.  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.  
Padrão: `^([A-Za-z]_?)+$`   
Obrigatório: Sim

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

 ** [name](#API_DeleteBotChannelAssociation_RequestSyntax) **   <a name="lex-DeleteBotChannelAssociation-request-uri-name"></a>
O nome da associaçã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

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

Essa solicitação não tem corpo.

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

```
HTTP/1.1 204
```

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

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 204 com um corpo HTTP vazio.

## Erros
<a name="API_DeleteBotChannelAssociation_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

 ** ConflictException **   
 Houve um conflito ao processar a solicitação. Tente sua solicitação novamente.   
Código de Status HTTP: 409

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

# DeleteBotVersion
<a name="API_DeleteBotVersion"></a>

Exclui uma versão específica de um bot. Para excluir todas as versão de um bot, use a operação [DeleteBot](API_DeleteBot.md). 

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

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

```
DELETE /bots/name/versions/version HTTP/1.1
```

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

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

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

 ** [version](#API_DeleteBotVersion_RequestSyntax) **   <a name="lex-DeleteBotVersion-request-uri-version"></a>
A versão do bot a excluir. Você não pode excluir a versão `$LATEST` do bot. Para excluir a versão `$LATEST`, use a operação [DeleteBot](API_DeleteBot.md).  
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 64.  
Padrão: `[0-9]+`   
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

```
HTTP/1.1 204
```

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

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 204 com um corpo HTTP vazio.

## Erros
<a name="API_DeleteBotVersion_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

 ** ConflictException **   
 Houve um conflito ao processar a solicitação. Tente sua solicitação novamente.   
Código de Status HTTP: 409

 ** 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

 ** ResourceInUseException **   
O recurso que você está tentando excluir é referenciado por outro recurso. Use essas informações para remover referências ao recurso que você está tentando excluir.  
O corpo da exceção contém um objeto JSON que descreve o recurso.  
 `{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,`   
 `"resourceReference": {`   
 `"name": string, "version": string } }`     
 ** exampleReference **   
Descreve o recurso que se refere ao recurso que você está tentando excluir. Esse objeto é retornado como parte da exceção `ResourceInUseException`. 
Código de Status HTTP: 400

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

# DeleteIntent
<a name="API_DeleteIntent"></a>

Exclui todas as versões da intenção, incluindo a versão `$LATEST`. Para excluir uma versão específica da intenção, use a operação [DeleteIntentVersion](API_DeleteIntentVersion.md).

 Você só pode excluir uma versão de uma intenção se ela não for referenciada. Para excluir uma intenção mencionada em um ou mais bots (consulte[Amazon Lex: como funciona](how-it-works.md)), primeiro você deve remover essas referências. 

**nota**  
 Se você receber a exceção `ResourceInUseException`, ela fornecerá um exemplo de referência que mostra onde a intenção é referenciada. Para remover a referência à intenção, atualize o bot ou exclua-o. Se você receber a mesma exceção ao tentar excluir a intenção novamente, repita até que a intenção não tenha referências e a chamada para `DeleteIntent` seja bem-sucedida. 

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

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

```
DELETE /intents/name HTTP/1.1
```

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

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

 ** [name](#API_DeleteIntent_RequestSyntax) **   <a name="lex-DeleteIntent-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

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

Essa solicitação não tem corpo.

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

```
HTTP/1.1 204
```

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

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 204 com um corpo HTTP vazio.

## Erros
<a name="API_DeleteIntent_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

 ** ConflictException **   
 Houve um conflito ao processar a solicitação. Tente sua solicitação novamente.   
Código de Status HTTP: 409

 ** 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

 ** ResourceInUseException **   
O recurso que você está tentando excluir é referenciado por outro recurso. Use essas informações para remover referências ao recurso que você está tentando excluir.  
O corpo da exceção contém um objeto JSON que descreve o recurso.  
 `{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,`   
 `"resourceReference": {`   
 `"name": string, "version": string } }`     
 ** exampleReference **   
Descreve o recurso que se refere ao recurso que você está tentando excluir. Esse objeto é retornado como parte da exceção `ResourceInUseException`. 
Código de Status HTTP: 400

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

# DeleteIntentVersion
<a name="API_DeleteIntentVersion"></a>

Exclui uma versão específica de uma intenção. Para excluir todas as versões de uma intenção, use a operação [DeleteIntent](API_DeleteIntent.md). 

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

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

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

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

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

 ** [name](#API_DeleteIntentVersion_RequestSyntax) **   <a name="lex-DeleteIntentVersion-request-uri-name"></a>
O nome da intenção.  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.  
Padrão: `^([A-Za-z]_?)+$`   
Obrigatório: Sim

 ** [version](#API_DeleteIntentVersion_RequestSyntax) **   <a name="lex-DeleteIntentVersion-request-uri-version"></a>
A versão da intenção a ser excluída. Você não pode excluir a versão `$LATEST` da intenção. Para excluir a versão `$LATEST`, use a operação [DeleteIntent](API_DeleteIntent.md).  
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 64.  
Padrão: `[0-9]+`   
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

```
HTTP/1.1 204
```

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

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 204 com um corpo HTTP vazio.

## Erros
<a name="API_DeleteIntentVersion_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

 ** ConflictException **   
 Houve um conflito ao processar a solicitação. Tente sua solicitação novamente.   
Código de Status HTTP: 409

 ** 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

 ** ResourceInUseException **   
O recurso que você está tentando excluir é referenciado por outro recurso. Use essas informações para remover referências ao recurso que você está tentando excluir.  
O corpo da exceção contém um objeto JSON que descreve o recurso.  
 `{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,`   
 `"resourceReference": {`   
 `"name": string, "version": string } }`     
 ** exampleReference **   
Descreve o recurso que se refere ao recurso que você está tentando excluir. Esse objeto é retornado como parte da exceção `ResourceInUseException`. 
Código de Status HTTP: 400

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

# DeleteSlotType
<a name="API_DeleteSlotType"></a>

Exclui todas as versões do tipo de slot, incluindo a versão `$LATEST`. Para excluir uma versão específica do tipo de slot, use a operação [DeleteSlotTypeVersion](API_DeleteSlotTypeVersion.md).

 Você só pode excluir uma versão de um tipo de slot se ela não for referenciada. Para excluir um tipo de slot mencionado em uma ou mais intenções, primeiro você deve remover essas referências. 

**nota**  
 Se você receber a exceção `ResourceInUseException`, ela fornecerá um exemplo de referência que mostra a intenção onde o tipo de slot é referenciado. Para remover a referência ao tipo de slot, atualize a intenção ou exclua-o. Se você receber a mesma exceção ao tentar excluir o tipo de slot novamente, repita até que o tipo de slot não tenha referências e a chamada para `DeleteSlotType` seja bem-sucedida. 

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

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

```
DELETE /slottypes/name HTTP/1.1
```

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

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

 ** [name](#API_DeleteSlotType_RequestSyntax) **   <a name="lex-DeleteSlotType-request-uri-name"></a>
O nome do tipo de slot. 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

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

Essa solicitação não tem corpo.

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

```
HTTP/1.1 204
```

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

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 204 com um corpo HTTP vazio.

## Erros
<a name="API_DeleteSlotType_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

 ** ConflictException **   
 Houve um conflito ao processar a solicitação. Tente sua solicitação novamente.   
Código de Status HTTP: 409

 ** 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

 ** ResourceInUseException **   
O recurso que você está tentando excluir é referenciado por outro recurso. Use essas informações para remover referências ao recurso que você está tentando excluir.  
O corpo da exceção contém um objeto JSON que descreve o recurso.  
 `{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,`   
 `"resourceReference": {`   
 `"name": string, "version": string } }`     
 ** exampleReference **   
Descreve o recurso que se refere ao recurso que você está tentando excluir. Esse objeto é retornado como parte da exceção `ResourceInUseException`. 
Código de Status HTTP: 400

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

# DeleteSlotTypeVersion
<a name="API_DeleteSlotTypeVersion"></a>

Exclui uma versão específica de um tipo de slot. Para excluir todas as versões de um tipo de slot, use a operação [DeleteSlotType](API_DeleteSlotType.md). 

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

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

```
DELETE /slottypes/name/version/version HTTP/1.1
```

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

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

 ** [name](#API_DeleteSlotTypeVersion_RequestSyntax) **   <a name="lex-DeleteSlotTypeVersion-request-uri-name"></a>
O nome do tipo de slot.  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.  
Padrão: `^([A-Za-z]_?)+$`   
Obrigatório: Sim

 ** [version](#API_DeleteSlotTypeVersion_RequestSyntax) **   <a name="lex-DeleteSlotTypeVersion-request-uri-version"></a>
A versão do tipo de slot a ser excluída. Você não pode excluir a versão `$LATEST` do tipo de slot. Para excluir a versão `$LATEST`, use a operação [DeleteSlotType](API_DeleteSlotType.md).  
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 64.  
Padrão: `[0-9]+`   
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

```
HTTP/1.1 204
```

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

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 204 com um corpo HTTP vazio.

## Erros
<a name="API_DeleteSlotTypeVersion_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

 ** ConflictException **   
 Houve um conflito ao processar a solicitação. Tente sua solicitação novamente.   
Código de Status HTTP: 409

 ** 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

 ** ResourceInUseException **   
O recurso que você está tentando excluir é referenciado por outro recurso. Use essas informações para remover referências ao recurso que você está tentando excluir.  
O corpo da exceção contém um objeto JSON que descreve o recurso.  
 `{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,`   
 `"resourceReference": {`   
 `"name": string, "version": string } }`     
 ** exampleReference **   
Descreve o recurso que se refere ao recurso que você está tentando excluir. Esse objeto é retornado como parte da exceção `ResourceInUseException`. 
Código de Status HTTP: 400

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

# DeleteUtterances
<a name="API_DeleteUtterances"></a>

Exclui as declarações armazenadas.

O Amazon Lex armazena as declarações que os usuários enviam para o seu bot. As declarações são armazenadas por 15 dias para uso com a operação [GetUtterancesView](API_GetUtterancesView.md) e, em seguida, armazenadas indefinidamente para uso na melhoria da capacidade do seu bot de responder às entradas do usuário.

Use a operação `DeleteUtterances` para excluir declarações armazenadas por um usuário específico. Quando você usa a operação `DeleteUtterances`, as declarações armazenadas para melhorar a capacidade do seu bot de responder às entradas do usuário são excluídas imediatamente. As declarações armazenadas para uso com a operação `GetUtterancesView` são excluídas após 15 dias.

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

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

```
DELETE /bots/botName/utterances/userId HTTP/1.1
```

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

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

 ** [botName](#API_DeleteUtterances_RequestSyntax) **   <a name="lex-DeleteUtterances-request-uri-botName"></a>
O nome do bot que armazenou as declarações.  
Restrições de tamanho: tamanho mínimo 2. Tamanho máximo de 50.  
Padrão: `^([A-Za-z]_?)+$`   
Obrigatório: Sim

 ** [userId](#API_DeleteUtterances_RequestSyntax) **   <a name="lex-DeleteUtterances-request-uri-userId"></a>
 Um identificador exclusivo para o usuário que fez as declarações. Esse é o ID do usuário que foi enviado na solicitação de [PostText](https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html)operação [PostContent](https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html)ou que continha o enunciado.  
Restrições de tamanho: tamanho mínimo 2. Comprimento máximo de 100.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

```
HTTP/1.1 204
```

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

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 204 com um corpo HTTP vazio.

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

# 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) 

# GetBotAlias
<a name="API_GetBotAlias"></a>

Retorna informações sobre um alias de bot do Amazon Lex. Para obter mais informações sobre aliases, consulte [Versionamento e aliases](versioning-aliases.md).

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

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

```
GET /bots/botName/aliases/name HTTP/1.1
```

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

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

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

 ** [name](#API_GetBotAlias_RequestSyntax) **   <a name="lex-GetBotAlias-request-uri-name"></a>
O nome do alias do bot. 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

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

Essa solicitação não tem corpo.

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

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

{
   "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"
}
```

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

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

 ** [botVersion](#API_GetBotAlias_ResponseSyntax) **   <a name="lex-GetBotAlias-response-botVersion"></a>
A versão do bot para o qual o alias aponta.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 64.  
Padrão: `\$LATEST|[0-9]+` 

 ** [checksum](#API_GetBotAlias_ResponseSyntax) **   <a name="lex-GetBotAlias-response-checksum"></a>
Soma de verificação do alias do bot.  
Tipo: string

 ** [conversationLogs](#API_GetBotAlias_ResponseSyntax) **   <a name="lex-GetBotAlias-response-conversationLogs"></a>
As configurações que determinam como o Amazon Lex usa logs de conversa para o alias.  
Tipo: objeto [ConversationLogsResponse](API_ConversationLogsResponse.md)

 ** [createdDate](#API_GetBotAlias_ResponseSyntax) **   <a name="lex-GetBotAlias-response-createdDate"></a>
A data em que o alias do bot foi criado.  
Tipo: Timestamp

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

 ** [lastUpdatedDate](#API_GetBotAlias_ResponseSyntax) **   <a name="lex-GetBotAlias-response-lastUpdatedDate"></a>
A data em que o alias do 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

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

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

# GetBotAliases
<a name="API_GetBotAliases"></a>

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

```
GET /bots/botName/aliases/?maxResults=maxResults&nameContains=nameContains&nextToken=nextToken HTTP/1.1
```

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

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

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

 ** [maxResults](#API_GetBotAliases_RequestSyntax) **   <a name="lex-GetBotAliases-request-uri-maxResults"></a>
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](#API_GetBotAliases_RequestSyntax) **   <a name="lex-GetBotAliases-request-uri-nameContains"></a>
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](#API_GetBotAliases_RequestSyntax) **   <a name="lex-GetBotAliases-request-uri-nextToken"></a>
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
<a name="API_GetBotAliases_RequestBody"></a>

Essa solicitação não tem corpo.

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

```
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
<a name="API_GetBotAliases_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.

 ** [BotAliases](#API_GetBotAliases_ResponseSyntax) **   <a name="lex-GetBotAliases-response-BotAliases"></a>
Uma matriz de objetos `BotAliasMetadata`, cada um descrevendo um alias de bot.  
Tipo: matriz de objetos [BotAliasMetadata](API_BotAliasMetadata.md)

 ** [nextToken](#API_GetBotAliases_ResponseSyntax) **   <a name="lex-GetBotAliases-response-nextToken"></a>
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
<a name="API_GetBotAliases_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

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

# GetBotChannelAssociation
<a name="API_GetBotChannelAssociation"></a>

Retorna informações sobre a associação entre um bot do Amazon Lex e uma plataforma de mensagens.

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

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

```
GET /bots/botName/aliases/aliasName/channels/name HTTP/1.1
```

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

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

 ** [aliasName](#API_GetBotChannelAssociation_RequestSyntax) **   <a name="lex-GetBotChannelAssociation-request-uri-botAlias"></a>
Um alias que aponta para a versão específica do bot do Amazon Lex à qual essa associação está sendo feita.  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.  
Padrão: `^([A-Za-z]_?)+$`   
Obrigatório: Sim

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

 ** [name](#API_GetBotChannelAssociation_RequestSyntax) **   <a name="lex-GetBotChannelAssociation-request-uri-name"></a>
O nome da associação entre o bot e o canal. 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

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

Essa solicitação não tem corpo.

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

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

{
   "botAlias": "string",
   "botConfiguration": { 
      "string" : "string" 
   },
   "botName": "string",
   "createdDate": number,
   "description": "string",
   "failureReason": "string",
   "name": "string",
   "status": "string",
   "type": "string"
}
```

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

 ** [botAlias](#API_GetBotChannelAssociation_ResponseSyntax) **   <a name="lex-GetBotChannelAssociation-response-botAlias"></a>
Um alias que aponta para a versão específica do bot do Amazon Lex à qual essa associação está sendo feita.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.  
Padrão: `^([A-Za-z]_?)+$` 

 ** [botConfiguration](#API_GetBotChannelAssociation_ResponseSyntax) **   <a name="lex-GetBotChannelAssociation-response-botConfiguration"></a>
Fornece as informações que a plataforma de mensagens precisa para se comunicar com o bot do Amazon Lex.  
Tipo: mapa de string para string  
Entradas do mapa: número máximo de 10 itens.

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

 ** [createdDate](#API_GetBotChannelAssociation_ResponseSyntax) **   <a name="lex-GetBotChannelAssociation-response-createdDate"></a>
A data em que a associação entre o bot e o canal foi criada.  
Tipo: Timestamp

 ** [description](#API_GetBotChannelAssociation_ResponseSyntax) **   <a name="lex-GetBotChannelAssociation-response-description"></a>
A descrição da associação entre o bot e o canal.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 200.

 ** [failureReason](#API_GetBotChannelAssociation_ResponseSyntax) **   <a name="lex-GetBotChannelAssociation-response-failureReason"></a>
Se `status` for `FAILED`, o Amazon Lex fornece o motivo da falha na criação da associação.  
Tipo: string

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

 ** [status](#API_GetBotChannelAssociation_ResponseSyntax) **   <a name="lex-GetBotChannelAssociation-response-status"></a>
O status do canal do bot.   
+  `CREATED` - O canal foi criado e está pronto para uso.
+  `IN_PROGRESS` - A criação do canal está em andamento.
+  `FAILED` - Houve um erro ao criar o canal. Para obter informações sobre o motivo da falha, consulte o campo `failureReason`.
Tipo: string  
Valores válidos: `IN_PROGRESS | CREATED | FAILED` 

 ** [type](#API_GetBotChannelAssociation_ResponseSyntax) **   <a name="lex-GetBotChannelAssociation-response-type"></a>
O tipo da plataforma de mensagens.  
Tipo: string  
Valores válidos: `Facebook | Slack | Twilio-Sms | Kik` 

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

# GetBotChannelAssociations
<a name="API_GetBotChannelAssociations"></a>

 Retorna uma lista de todos os canais associados a um bot específico. 

A operação `GetBotChannelAssociations` exige permissões para a ação `lex:GetBotChannelAssociations`.

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

```
GET /bots/botName/aliases/aliasName/channels/?maxResults=maxResults&nameContains=nameContains&nextToken=nextToken HTTP/1.1
```

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

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

 ** [aliasName](#API_GetBotChannelAssociations_RequestSyntax) **   <a name="lex-GetBotChannelAssociations-request-uri-botAlias"></a>
Um alias que aponta para a versão específica do bot do Amazon Lex à qual essa associação está sendo feita.  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.  
Padrão: `^(-|^([A-Za-z]_?)+$)$`   
Obrigatório: Sim

 ** [botName](#API_GetBotChannelAssociations_RequestSyntax) **   <a name="lex-GetBotChannelAssociations-request-uri-botName"></a>
O nome do bot do Amazon Lex na associação.  
Restrições de tamanho: tamanho mínimo 2. Tamanho máximo de 50.  
Padrão: `^([A-Za-z]_?)+$`   
Obrigatório: Sim

 ** [maxResults](#API_GetBotChannelAssociations_RequestSyntax) **   <a name="lex-GetBotChannelAssociations-request-uri-maxResults"></a>
O número máximo de associações a ser retornado na resposta. O padrão é 50.   
Faixa válida: valor mínimo de 1. Valor máximo de 50.

 ** [nameContains](#API_GetBotChannelAssociations_RequestSyntax) **   <a name="lex-GetBotChannelAssociations-request-uri-nameContains"></a>
Substring a ser correspondente nos nomes das associações de canais. Uma associação será retornada se alguma parte de seu nome corresponder ao substring. Por exemplo, “xyz” corresponde a “xyzabc” e “abcxyz”. Para retornar todas as associações de canais de bots, use um hífen (“-”) como `nameContains` parâmetro.  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.  
Padrão: `^([A-Za-z]_?)+$` 

 ** [nextToken](#API_GetBotChannelAssociations_RequestSyntax) **   <a name="lex-GetBotChannelAssociations-request-uri-nextToken"></a>
Um token de paginação para buscar a próxima página de associações. 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 associações, especifique o token de paginação na próxima solicitação. 

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

Essa solicitação não tem corpo.

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

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

{
   "botChannelAssociations": [ 
      { 
         "botAlias": "string",
         "botConfiguration": { 
            "string" : "string" 
         },
         "botName": "string",
         "createdDate": number,
         "description": "string",
         "failureReason": "string",
         "name": "string",
         "status": "string",
         "type": "string"
      }
   ],
   "nextToken": "string"
}
```

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

 ** [botChannelAssociations](#API_GetBotChannelAssociations_ResponseSyntax) **   <a name="lex-GetBotChannelAssociations-response-botChannelAssociations"></a>
Uma matriz de objetos, uma para cada associação, que fornece informações sobre o bot do Amazon Lex e sua associação com o canal.   
Tipo: matriz de objetos [BotChannelAssociation](API_BotChannelAssociation.md)

 ** [nextToken](#API_GetBotChannelAssociations_ResponseSyntax) **   <a name="lex-GetBotChannelAssociations-response-nextToken"></a>
Um token de paginação que busca a próxima página de associações. 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 associações, especifique o token de paginação na próxima solicitação.   
Tipo: string

## Erros
<a name="API_GetBotChannelAssociations_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

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

# GetBots
<a name="API_GetBots"></a>

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

```
GET /bots/?maxResults=maxResults&nameContains=nameContains&nextToken=nextToken HTTP/1.1
```

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

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

 ** [maxResults](#API_GetBots_RequestSyntax) **   <a name="lex-GetBots-request-uri-maxResults"></a>
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](#API_GetBots_RequestSyntax) **   <a name="lex-GetBots-request-uri-nameContains"></a>
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](#API_GetBots_RequestSyntax) **   <a name="lex-GetBots-request-uri-nextToken"></a>
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 bots, especifique o token de paginação na próxima solicitação. 

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

Essa solicitação não tem corpo.

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

```
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
<a name="API_GetBots_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.

 ** [bots](#API_GetBots_ResponseSyntax) **   <a name="lex-GetBots-response-bots"></a>
Uma matriz de objetos `botMetadata`, com uma entrada para cada bot.   
Tipo: matriz de objetos [BotMetadata](API_BotMetadata.md)

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

# GetBotVersions
<a name="API_GetBotVersions"></a>

Obtém informações sobre todas as versões de um bot.

A operação `GetBotVersions` retorna um objeto `BotMetadata` para cada versão de um bot. Por exemplo, se um bot tiver três versões numeradas, a operação `GetBotVersions` retornará quatro objetos `BotMetadata` na resposta, um para cada versão numerada e um para a versão `$LATEST`. 

A operação `GetBotVersions` sempre retorna pelo menos uma versão, a versão`$LATEST`.

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

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

```
GET /bots/name/versions/?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

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

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

 ** [maxResults](#API_GetBotVersions_RequestSyntax) **   <a name="lex-GetBotVersions-request-uri-maxResults"></a>
O número máximo de versões de bot a ser retornado em uma resposta. O padrão é 10.  
Faixa válida: valor mínimo de 1. Valor máximo de 50.

 ** [name](#API_GetBotVersions_RequestSyntax) **   <a name="lex-GetBotVersions-request-uri-name"></a>
O nome do bot para o qual as versões devem ser retornadas.  
Restrições de tamanho: tamanho mínimo 2. Tamanho máximo de 50.  
Padrão: `^([A-Za-z]_?)+$`   
Obrigatório: Sim

 ** [nextToken](#API_GetBotVersions_RequestSyntax) **   <a name="lex-GetBotVersions-request-uri-nextToken"></a>
Um token de paginação para buscar a próxima página de versões de bot. 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 versões, especifique o token de paginação na próxima solicitação. 

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

Essa solicitação não tem corpo.

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

```
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
<a name="API_GetBotVersions_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.

 ** [bots](#API_GetBotVersions_ResponseSyntax) **   <a name="lex-GetBotVersions-response-bots"></a>
Uma matriz de objetos `BotMetadata`, um para cada versão numerada do bot mais um para a versão `$LATEST`.  
Tipo: matriz de objetos [BotMetadata](API_BotMetadata.md)

 ** [nextToken](#API_GetBotVersions_ResponseSyntax) **   <a name="lex-GetBotVersions-response-nextToken"></a>
Um token de paginação para buscar a próxima página de versões de bot. 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 versões, especifique o token de paginação na próxima solicitação.   
Tipo: String

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

# GetBuiltinIntent
<a name="API_GetBuiltinIntent"></a>

Retorna informações sobre uma intenção embutida.

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

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

```
GET /builtins/intents/signature HTTP/1.1
```

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

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

 ** [signature](#API_GetBuiltinIntent_RequestSyntax) **   <a name="lex-GetBuiltinIntent-request-uri-signature"></a>
O identificador exclusivo de uma intenção integrada. Para encontrar a assinatura de uma intenção, consulte [Intenções integradas padrão](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents) no *Alexa Skills Kit*.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "signature": "string",
   "slots": [ 
      { 
         "name": "string"
      }
   ],
   "supportedLocales": [ "string" ]
}
```

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

 ** [signature](#API_GetBuiltinIntent_ResponseSyntax) **   <a name="lex-GetBuiltinIntent-response-signature"></a>
O identificador exclusivo de uma intenção integrada.  
Tipo: string

 ** [slots](#API_GetBuiltinIntent_ResponseSyntax) **   <a name="lex-GetBuiltinIntent-response-slots"></a>
Uma matriz de objetos `BuiltinIntentSlot`, uma entrada para cada tipo de slot na intenção.  
Tipo: matriz de objetos [BuiltinIntentSlot](API_BuiltinIntentSlot.md)

 ** [supportedLocales](#API_GetBuiltinIntent_ResponseSyntax) **   <a name="lex-GetBuiltinIntent-response-supportedLocales"></a>
Uma lista de localidades compatíveis com a intenção.  
Tipo: matriz de strings  
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` 

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

# GetBuiltinIntents
<a name="API_GetBuiltinIntents"></a>

Obtém uma lista de intenções integradas que atendem aos critérios especificados.

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

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

```
GET /builtins/intents/?locale=locale&maxResults=maxResults&nextToken=nextToken&signatureContains=signatureContains HTTP/1.1
```

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

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

 ** [locale](#API_GetBuiltinIntents_RequestSyntax) **   <a name="lex-GetBuiltinIntents-request-uri-locale"></a>
Uma lista de localidades compatíveis com a intenção.  
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` 

 ** [maxResults](#API_GetBuiltinIntents_RequestSyntax) **   <a name="lex-GetBuiltinIntents-request-uri-maxResults"></a>
O número máximo de intenções a serem incluídas na resposta. O padrão é 10.  
Faixa válida: valor mínimo de 1. Valor máximo de 50.

 ** [nextToken](#API_GetBuiltinIntents_RequestSyntax) **   <a name="lex-GetBuiltinIntents-request-uri-nextToken"></a>
Um token de paginação que busca a próxima página de intenções. Se a chamada de API for truncada, o Amazon Lex retornará um token de paginação na resposta. Para buscar a próxima página de intenções, especifique o token de paginação na próxima solicitação.

 ** [signatureContains](#API_GetBuiltinIntents_RequestSyntax) **   <a name="lex-GetBuiltinIntents-request-uri-signatureContains"></a>
Substring para corresponder às assinaturas de intenção integradas. Uma intenção será retornada se alguma parte de seu nome corresponder ao substring. Por exemplo, “xyz” corresponde a “xyzabc” e “abcxyz”. Para encontrar a assinatura de uma intenção, consulte [Intenções integradas padrão](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents) no *Alexa Skills Kit*.

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

Essa solicitação não tem corpo.

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

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

{
   "intents": [ 
      { 
         "signature": "string",
         "supportedLocales": [ "string" ]
      }
   ],
   "nextToken": "string"
}
```

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

 ** [intents](#API_GetBuiltinIntents_ResponseSyntax) **   <a name="lex-GetBuiltinIntents-response-intents"></a>
Uma matriz de objetos `builtinIntentMetadata`, uma para cada intenção na resposta.  
Tipo: matriz de objetos [BuiltinIntentMetadata](API_BuiltinIntentMetadata.md)

 ** [nextToken](#API_GetBuiltinIntents_ResponseSyntax) **   <a name="lex-GetBuiltinIntents-response-nextToken"></a>
Um token de paginação que busca a próxima página de intenções. Se a resposta a essa chamada de API for truncada, o Amazon Lex retornará um token de paginação na resposta. Para buscar a próxima página de intenções, especifique o token de paginação na próxima solicitação.  
Tipo: string

## Erros
<a name="API_GetBuiltinIntents_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

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

# GetBuiltinSlotTypes
<a name="API_GetBuiltinSlotTypes"></a>

Obtém uma lista dos tipos de slots integrados que atendem aos critérios especificados.

Para obter uma lista de tipos de slot integrados, consulte [Referência do tipo de slot](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/slot-type-reference) no *Alexa Skills Kit*.

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

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

```
GET /builtins/slottypes/?locale=locale&maxResults=maxResults&nextToken=nextToken&signatureContains=signatureContains HTTP/1.1
```

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

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

 ** [locale](#API_GetBuiltinSlotTypes_RequestSyntax) **   <a name="lex-GetBuiltinSlotTypes-request-uri-locale"></a>
Uma lista de localidades compatíveis pelo tipo de slot.  
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` 

 ** [maxResults](#API_GetBuiltinSlotTypes_RequestSyntax) **   <a name="lex-GetBuiltinSlotTypes-request-uri-maxResults"></a>
O número máximo de tipo de slot a serem incluídos na resposta. O padrão é 10.  
Faixa válida: valor mínimo de 1. Valor máximo de 50.

 ** [nextToken](#API_GetBuiltinSlotTypes_RequestSyntax) **   <a name="lex-GetBuiltinSlotTypes-request-uri-nextToken"></a>
Um token de paginação que busca a próxima página de tipos de slot. Se a resposta a essa chamada de API for truncada, o Amazon Lex retornará um token de paginação na resposta. Para buscar a próxima página de tipos de slot, especifique o token de paginação na próxima solicitação.

 ** [signatureContains](#API_GetBuiltinSlotTypes_RequestSyntax) **   <a name="lex-GetBuiltinSlotTypes-request-uri-signatureContains"></a>
Substring para corresponder às assinaturas de tipo de slot integradas. Um tipo de slot será retornado se alguma parte de seu nome corresponder ao substring. Por exemplo, “xyz” corresponde a “xyzabc” e “abcxyz”.

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

Essa solicitação não tem corpo.

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

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

{
   "nextToken": "string",
   "slotTypes": [ 
      { 
         "signature": "string",
         "supportedLocales": [ "string" ]
      }
   ]
}
```

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

 ** [nextToken](#API_GetBuiltinSlotTypes_ResponseSyntax) **   <a name="lex-GetBuiltinSlotTypes-response-nextToken"></a>
Se a resposta for truncada, ela incluirá um token de paginação que você pode usar em sua próxima solicitação para buscar a próxima página de tipos de slot.  
Tipo: string

 ** [slotTypes](#API_GetBuiltinSlotTypes_ResponseSyntax) **   <a name="lex-GetBuiltinSlotTypes-response-slotTypes"></a>
Uma matriz de objetos `BuiltInSlotTypeMetadata`, uma entrada para cada tipo de slot retornado.  
Tipo: matriz de objetos [BuiltinSlotTypeMetadata](API_BuiltinSlotTypeMetadata.md)

## Erros
<a name="API_GetBuiltinSlotTypes_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

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

# GetExport
<a name="API_GetExport"></a>

Exporta o conteúdo de um recurso do Amazon Lex em um formato especificado. 

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

```
GET /exports/?exportType=exportType&name=name&resourceType=resourceType&version=version HTTP/1.1
```

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

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

 ** [exportType](#API_GetExport_RequestSyntax) **   <a name="lex-GetExport-request-uri-exportType"></a>
O formato dos dados exportados.  
Valores válidos: `ALEXA_SKILLS_KIT | LEX`   
Obrigatório: Sim

 ** [name](#API_GetExport_RequestSyntax) **   <a name="lex-GetExport-request-uri-name"></a>
O nome do bot a ser exportado.  
Restrições de comprimento: tamanho mínimo de 1. Tamanho máximo de 100.  
Padrão: `[a-zA-Z_]+`   
Obrigatório: Sim

 ** [resourceType](#API_GetExport_RequestSyntax) **   <a name="lex-GetExport-request-uri-resourceType"></a>
O tipo de recurso a ser exportado.   
Valores válidos: `BOT | INTENT | SLOT_TYPE`   
Obrigatório: Sim

 ** [version](#API_GetExport_RequestSyntax) **   <a name="lex-GetExport-request-uri-version"></a>
A versão do bot a ser exportado.  
Restrições de comprimento: tamanho mínimo de 1. O comprimento máximo é 64.  
Padrão: `[0-9]+`   
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "exportStatus": "string",
   "exportType": "string",
   "failureReason": "string",
   "name": "string",
   "resourceType": "string",
   "url": "string",
   "version": "string"
}
```

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

 ** [exportStatus](#API_GetExport_ResponseSyntax) **   <a name="lex-GetExport-response-exportStatus"></a>
O status da exportação.   
+  `IN_PROGRESS` - A exportação está em andamento.
+  `READY` - A exportação foi concluída.
+  `FAILED` - A exportação não pôde ser concluída.
Tipo: string  
Valores válidos: `IN_PROGRESS | READY | FAILED` 

 ** [exportType](#API_GetExport_ResponseSyntax) **   <a name="lex-GetExport-response-exportType"></a>
O formato dos dados exportados.  
Tipo: string  
Valores válidos: `ALEXA_SKILLS_KIT | LEX` 

 ** [failureReason](#API_GetExport_ResponseSyntax) **   <a name="lex-GetExport-response-failureReason"></a>
Se `status` for `FAILED`, o Amazon Lex fornece o motivo da falha da exportação do recurso.  
Tipo: string

 ** [name](#API_GetExport_ResponseSyntax) **   <a name="lex-GetExport-response-name"></a>
O nome do bot que está sendo exportado.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.  
Padrão: `[a-zA-Z_]+` 

 ** [resourceType](#API_GetExport_ResponseSyntax) **   <a name="lex-GetExport-response-resourceType"></a>
O tipo do recurso exportado.  
Tipo: string  
Valores válidos: `BOT | INTENT | SLOT_TYPE` 

 ** [url](#API_GetExport_ResponseSyntax) **   <a name="lex-GetExport-response-url"></a>
Uma URL pré-assinada do S3 que fornece a localização do recurso exportado. O recurso exportado é um arquivo ZIP que contém o recurso exportado no formato JSON. A estrutura do arquivamento pode mudar. Seu código não deve depender da estrutura de arquivamento.  
Tipo: string

 ** [version](#API_GetExport_ResponseSyntax) **   <a name="lex-GetExport-response-version"></a>
A versão do bot que está sendo exportado.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 64.  
Padrão: `[0-9]+` 

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

# GetImport
<a name="API_GetImport"></a>

Obtém informações sobre um trabalho de importação iniciado com a operação `StartImport`.

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

```
GET /imports/importId HTTP/1.1
```

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

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

 ** [importId](#API_GetImport_RequestSyntax) **   <a name="lex-GetImport-request-uri-importId"></a>
O identificador das informações do trabalho de importação a serem retornadas.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "createdDate": number,
   "failureReason": [ "string" ],
   "importId": "string",
   "importStatus": "string",
   "mergeStrategy": "string",
   "name": "string",
   "resourceType": "string"
}
```

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

 ** [createdDate](#API_GetImport_ResponseSyntax) **   <a name="lex-GetImport-response-createdDate"></a>
Um carimbo de data e hora para a data e a hora em que a tarefa de importação foi criada.  
Tipo: Timestamp

 ** [failureReason](#API_GetImport_ResponseSyntax) **   <a name="lex-GetImport-response-failureReason"></a>
Uma sequência de caracteres que descreve por que um trabalho de importação não foi concluído.  
Tipo: matriz de strings

 ** [importId](#API_GetImport_ResponseSyntax) **   <a name="lex-GetImport-response-importId"></a>
O identificador para a tarefa de importação específica.  
Tipo: String

 ** [importStatus](#API_GetImport_ResponseSyntax) **   <a name="lex-GetImport-response-importStatus"></a>
O status do trabalho de importação. Se o status for `FAILED`, você poderá obter o motivo da falha no campo `failureReason`.  
Tipo: string  
Valores válidos: `IN_PROGRESS | COMPLETE | FAILED` 

 ** [mergeStrategy](#API_GetImport_ResponseSyntax) **   <a name="lex-GetImport-response-mergeStrategy"></a>
A ação tomada quando houve um conflito entre um recurso existente e um recurso no arquivo de importação.  
Tipo: string  
Valores válidos: `OVERWRITE_LATEST | FAIL_ON_CONFLICT` 

 ** [name](#API_GetImport_ResponseSyntax) **   <a name="lex-GetImport-response-name"></a>
O nome dado ao trabalho de importação.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.  
Padrão: `[a-zA-Z_]+` 

 ** [resourceType](#API_GetImport_ResponseSyntax) **   <a name="lex-GetImport-response-resourceType"></a>
O tipo do recurso a ser importado.  
Tipo: string  
Valores válidos: `BOT | INTENT | SLOT_TYPE` 

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

# 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) 

# GetIntents
<a name="API_GetIntents"></a>

Retorna as informações da intenção da seguinte forma: 
+ Se você especificar o campo `nameContains`, retornará a versão `$LATEST` de todas as intenções que 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 todas as intenções. 

 A operação exige permissões para a ação `lex:GetIntents`. 

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

```
GET /intents/?maxResults=maxResults&nameContains=nameContains&nextToken=nextToken HTTP/1.1
```

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

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

 ** [maxResults](#API_GetIntents_RequestSyntax) **   <a name="lex-GetIntents-request-uri-maxResults"></a>
O número máximo de intenções a serem incluídas na resposta. O padrão é 10.  
Faixa válida: valor mínimo de 1. Valor máximo de 50.

 ** [nameContains](#API_GetIntents_RequestSyntax) **   <a name="lex-GetIntents-request-uri-nameContains"></a>
Substring para corresponder aos nomes da intenção. Uma intenção será retornada 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](#API_GetIntents_RequestSyntax) **   <a name="lex-GetIntents-request-uri-nextToken"></a>
Um token de paginação que busca a próxima página de intenções. Se a resposta a essa chamada de API for truncada, o Amazon Lex retornará um token de paginação na resposta. Para buscar a próxima página de intenções, especifique o token de paginação na próxima solicitação. 

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

Essa solicitação não tem corpo.

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

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

{
   "intents": [ 
      { 
         "createdDate": number,
         "description": "string",
         "lastUpdatedDate": number,
         "name": "string",
         "version": "string"
      }
   ],
   "nextToken": "string"
}
```

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

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

 ** [nextToken](#API_GetIntents_ResponseSyntax) **   <a name="lex-GetIntents-response-nextToken"></a>
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 intenções.   
Tipo: String

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

# GetIntentVersions
<a name="API_GetIntentVersions"></a>

Obtém informações sobre todas as versões de uma intenção.

A operação `GetIntentVersions` retorna um objeto `IntentMetadata` para cada versão de uma intenção. Por exemplo, se uma intenção tiver três versões numeradas, a operação `GetIntentVersions` retornará quatro objetos `IntentMetadata` na resposta, um para cada versão numerada e um para a versão `$LATEST`. 

A operação `GetIntentVersions` sempre retorna pelo menos uma versão, a versão`$LATEST`.

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

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

```
GET /intents/name/versions/?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

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

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

 ** [maxResults](#API_GetIntentVersions_RequestSyntax) **   <a name="lex-GetIntentVersions-request-uri-maxResults"></a>
O número máximo de versões de intenção a ser retornado em uma resposta. O padrão é 10.  
Faixa válida: valor mínimo de 1. Valor máximo de 50.

 ** [name](#API_GetIntentVersions_RequestSyntax) **   <a name="lex-GetIntentVersions-request-uri-name"></a>
O nome da intenção para a qual as versões devem ser retornadas.  
Restrições de comprimento: tamanho mínimo de 1. Tamanho máximo de 100.  
Padrão: `^([A-Za-z]_?)+$`   
Obrigatório: Sim

 ** [nextToken](#API_GetIntentVersions_RequestSyntax) **   <a name="lex-GetIntentVersions-request-uri-nextToken"></a>
Um token de paginação para buscar a próxima página de versões de intenção. 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 versões, especifique o token de paginação na próxima solicitação. 

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

Essa solicitação não tem corpo.

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

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

{
   "intents": [ 
      { 
         "createdDate": number,
         "description": "string",
         "lastUpdatedDate": number,
         "name": "string",
         "version": "string"
      }
   ],
   "nextToken": "string"
}
```

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

 ** [intents](#API_GetIntentVersions_ResponseSyntax) **   <a name="lex-GetIntentVersions-response-intents"></a>
Uma matriz de objetos `IntentMetadata`, um para cada versão numerada da intenção mais um para a versão `$LATEST`.  
Tipo: matriz de objetos [IntentMetadata](API_IntentMetadata.md)

 ** [nextToken](#API_GetIntentVersions_ResponseSyntax) **   <a name="lex-GetIntentVersions-response-nextToken"></a>
Um token de paginação para buscar a próxima página de versões de intenção. 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 versões, especifique o token de paginação na próxima solicitação.   
Tipo: String

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

# GetMigration
<a name="API_GetMigration"></a>

Fornece detalhes sobre uma migração contínua ou completa de um bot do Amazon Lex V1 para um bot do Amazon Lex V2. Use essa operação para visualizar os alertas e avisos de migração relacionados à migração.

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

```
GET /migrations/migrationId HTTP/1.1
```

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

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

 ** [migrationId](#API_GetMigration_RequestSyntax) **   <a name="lex-GetMigration-request-uri-migrationId"></a>
O identificador exclusivo da migração a ser visualizada. O `migrationID` é retornado pela operação [StartMigration](API_StartMigration.md).  
Restrições de tamanho: tamanho fixo de 10.  
Padrão: `^[0-9a-zA-Z]+$`   
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "alerts": [ 
      { 
         "details": [ "string" ],
         "message": "string",
         "referenceURLs": [ "string" ],
         "type": "string"
      }
   ],
   "migrationId": "string",
   "migrationStatus": "string",
   "migrationStrategy": "string",
   "migrationTimestamp": number,
   "v1BotLocale": "string",
   "v1BotName": "string",
   "v1BotVersion": "string",
   "v2BotId": "string",
   "v2BotRole": "string"
}
```

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

 ** [alerts](#API_GetMigration_ResponseSyntax) **   <a name="lex-GetMigration-response-alerts"></a>
Uma lista de alertas e avisos que indicam problemas com a migração do bot do Amazon Lex V1 para o Amazon Lex V2. Você recebe um aviso quando um atributo do Amazon Lex V1 tem uma implementação diferente no Amazon Lex V2.  
Para obter mais informações, consulte [Migração de um bot](https://docs.aws.amazon.com/lexv2/latest/dg/migrate.html) no *Guia do desenvolvedor do Amazon Lex V2*.  
Tipo: matriz de objetos [MigrationAlert](API_MigrationAlert.md)

 ** [migrationId](#API_GetMigration_ResponseSyntax) **   <a name="lex-GetMigration-response-migrationId"></a>
O identificador exclusivo da migração. É o mesmo identificador usado ao chamar a operação `GetMigration`.  
Tipo: string  
Restrições de tamanho: tamanho fixo de 10.  
Padrão: `^[0-9a-zA-Z]+$` 

 ** [migrationStatus](#API_GetMigration_ResponseSyntax) **   <a name="lex-GetMigration-response-migrationStatus"></a>
Indica o status da migração. Quando o status é `COMPLETE`, a migração é concluída e o bot está disponível no Amazon Lex V2. Pode haver alertas e avisos que precisem ser resolvidos para concluir a migração.  
Tipo: String  
Valores válidos: `IN_PROGRESS | COMPLETED | FAILED` 

 ** [migrationStrategy](#API_GetMigration_ResponseSyntax) **   <a name="lex-GetMigration-response-migrationStrategy"></a>
A estratégia usada para conduzir a migração.  
+  `CREATE_NEW` - Cria um novo bot do Amazon Lex V2 e migra o bot do Amazon Lex V1 para o novo bot.
+  `UPDATE_EXISTING` - Substitui os metadados existentes do bot do Amazon Lex V2 e a localidade que está sendo migrada. Isso não altera nenhuma outra localidade no bot do Amazon Lex V2. Se a localidade não existir, uma nova localidade será criada no bot do Amazon Lex V2.
Tipo: String  
Valores válidos: `CREATE_NEW | UPDATE_EXISTING` 

 ** [migrationTimestamp](#API_GetMigration_ResponseSyntax) **   <a name="lex-GetMigration-response-migrationTimestamp"></a>
A data e hora em que a migração foi iniciada.  
Tipo: Timestamp

 ** [v1BotLocale](#API_GetMigration_ResponseSyntax) **   <a name="lex-GetMigration-response-v1BotLocale"></a>
A localidade do bot do Amazon Lex V1 foi migrada para o Amazon Lex V2.  
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` 

 ** [v1BotName](#API_GetMigration_ResponseSyntax) **   <a name="lex-GetMigration-response-v1BotName"></a>
O nome do bot do Amazon Lex V1 foi migrado para o Amazon Lex V2.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 2. Tamanho máximo de 50.  
Padrão: `^([A-Za-z]_?)+$` 

 ** [v1BotVersion](#API_GetMigration_ResponseSyntax) **   <a name="lex-GetMigration-response-v1BotVersion"></a>
A versão do bot do Amazon Lex V1 foi migrado para o Amazon Lex V2.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 64.  
Padrão: `\$LATEST|[0-9]+` 

 ** [v2BotId](#API_GetMigration_ResponseSyntax) **   <a name="lex-GetMigration-response-v2BotId"></a>
O identificador exclusivo do bot do Amazon Lex V2 para o qual o Amazon Lex V1 está sendo migrado.  
Tipo: string  
Restrições de tamanho: tamanho fixo de 10.  
Padrão: `^[0-9a-zA-Z]+$` 

 ** [v2BotRole](#API_GetMigration_ResponseSyntax) **   <a name="lex-GetMigration-response-v2BotRole"></a>
O perfil do IAM que o Amazon Lex usa para executar a versão do bot do Amazon Lex V2.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 20. Tamanho máximo de 2.048.  
Padrão: `^arn:[\w\-]+:iam::[\d]{12}:role/.+$` 

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

# GetMigrations
<a name="API_GetMigrations"></a>

Obtém uma lista das migrações entre o Amazon Lex V1 e o Amazon Lex V2.

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

```
GET /migrations?maxResults=maxResults&migrationStatusEquals=migrationStatusEquals&nextToken=nextToken&sortByAttribute=sortByAttribute&sortByOrder=sortByOrder&v1BotNameContains=v1BotNameContains HTTP/1.1
```

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

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

 ** [maxResults](#API_GetMigrations_RequestSyntax) **   <a name="lex-GetMigrations-request-uri-maxResults"></a>
O número máximo de migrações a serem retornadas na resposta. O padrão é 10.  
Faixa válida: valor mínimo de 1. Valor máximo de 50.

 ** [migrationStatusEquals](#API_GetMigrations_RequestSyntax) **   <a name="lex-GetMigrations-request-uri-migrationStatusEquals"></a>
Filtra a lista para conter somente migrações no estado especificado.  
Valores válidos: `IN_PROGRESS | COMPLETED | FAILED` 

 ** [nextToken](#API_GetMigrations_RequestSyntax) **   <a name="lex-GetMigrations-request-uri-nextToken"></a>
Um token de paginação que busca a próxima página de migrações. Se a resposta a essa operação for truncada, o Amazon Lex retornará um token de paginação na resposta. Para buscar a próxima página de migrações, especifique o token de paginação na solicitação.

 ** [sortByAttribute](#API_GetMigrations_RequestSyntax) **   <a name="lex-GetMigrations-request-uri-sortByAttribute"></a>
O campo pelo qual classificar a lista de migrações. Você pode classificar pelo nome do bot do Amazon Lex V1 ou pela data e hora em que a migração foi iniciada.  
Valores válidos: `V1_BOT_NAME | MIGRATION_DATE_TIME` 

 ** [sortByOrder](#API_GetMigrations_RequestSyntax) **   <a name="lex-GetMigrations-request-uri-sortByOrder"></a>
A ordem para classificar a lista.  
Valores válidos: `ASCENDING | DESCENDING` 

 ** [v1BotNameContains](#API_GetMigrations_RequestSyntax) **   <a name="lex-GetMigrations-request-uri-v1BotNameContains"></a>
Filtra a lista para conter somente bots cujo nome contenha a string especificada. A string é correspondida em qualquer lugar no nome do bot.  
Restrições de tamanho: tamanho mínimo 2. Tamanho máximo de 50.  
Padrão: `^([A-Za-z]_?)+$` 

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

Essa solicitação não tem corpo.

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

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

{
   "migrationSummaries": [ 
      { 
         "migrationId": "string",
         "migrationStatus": "string",
         "migrationStrategy": "string",
         "migrationTimestamp": number,
         "v1BotLocale": "string",
         "v1BotName": "string",
         "v1BotVersion": "string",
         "v2BotId": "string",
         "v2BotRole": "string"
      }
   ],
   "nextToken": "string"
}
```

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

 ** [migrationSummaries](#API_GetMigrations_ResponseSyntax) **   <a name="lex-GetMigrations-response-migrationSummaries"></a>
Uma matriz de resumos para migrações do Amazon Lex V1 para o Amazon Lex V2. Para ver detalhes da migração, use o `migrationId` do resumo em uma chamada para a operação [GetMigration](API_GetMigration.md).  
Tipo: matriz de objetos [MigrationSummary](API_MigrationSummary.md)

 ** [nextToken](#API_GetMigrations_ResponseSyntax) **   <a name="lex-GetMigrations-response-nextToken"></a>
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 migrações.  
Tipo: string

## Erros
<a name="API_GetMigrations_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

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

# GetSlotType
<a name="API_GetSlotType"></a>

Retorna informações sobre uma versão específica de um tipo de slot. Além de especificar o nome do tipo de slot, você deve especificar a versão do tipo de slot.

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

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

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

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

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

 ** [name](#API_GetSlotType_RequestSyntax) **   <a name="lex-GetSlotType-request-uri-name"></a>
O nome do tipo de slot. 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_GetSlotType_RequestSyntax) **   <a name="lex-GetSlotType-request-uri-version"></a>
A versão do tipo de slot.   
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_GetSlotType_RequestBody"></a>

Essa solicitação não tem corpo.

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

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

{
   "checksum": "string",
   "createdDate": number,
   "description": "string",
   "enumerationValues": [ 
      { 
         "synonyms": [ "string" ],
         "value": "string"
      }
   ],
   "lastUpdatedDate": number,
   "name": "string",
   "parentSlotTypeSignature": "string",
   "slotTypeConfigurations": [ 
      { 
         "regexConfiguration": { 
            "pattern": "string"
         }
      }
   ],
   "valueSelectionStrategy": "string",
   "version": "string"
}
```

## Elementos de resposta
<a name="API_GetSlotType_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_GetSlotType_ResponseSyntax) **   <a name="lex-GetSlotType-response-checksum"></a>
Soma de verificação da versão `$LATEST` do tipo de slot.  
Tipo: String

 ** [createdDate](#API_GetSlotType_ResponseSyntax) **   <a name="lex-GetSlotType-response-createdDate"></a>
A data em que o tipo de slot foi criado.  
Tipo: Timestamp

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

 ** [enumerationValues](#API_GetSlotType_ResponseSyntax) **   <a name="lex-GetSlotType-response-enumerationValues"></a>
Uma lista de objetos `EnumerationValue` que define os valores que o tipo de slot pode ter.  
Tipo: matriz de objetos [EnumerationValue](API_EnumerationValue.md)  
Membros da Matriz: número mínimo de 0 itens. Número máximo de 10.000 itens.

 ** [lastUpdatedDate](#API_GetSlotType_ResponseSyntax) **   <a name="lex-GetSlotType-response-lastUpdatedDate"></a>
A data em que o tipo de slot 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

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

 ** [parentSlotTypeSignature](#API_GetSlotType_ResponseSyntax) **   <a name="lex-GetSlotType-response-parentSlotTypeSignature"></a>
O tipo de slot integrado usado como pai do tipo de slot.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.  
Padrão: `^((AMAZON\.)_?|[A-Za-z]_?)+` 

 ** [slotTypeConfigurations](#API_GetSlotType_ResponseSyntax) **   <a name="lex-GetSlotType-response-slotTypeConfigurations"></a>
Informações de configuração que estendem o tipo de slot integrado principal.  
Tipo: matriz de objetos [SlotTypeConfiguration](API_SlotTypeConfiguration.md)  
Membros da Matriz: número mínimo de 0 itens. Número máximo de 10 itens.

 ** [valueSelectionStrategy](#API_GetSlotType_ResponseSyntax) **   <a name="lex-GetSlotType-response-valueSelectionStrategy"></a>
A estratégia que o Amazon Lex usa para determinar o valor de slot. Para obter mais informações, consulte [PutSlotType](API_PutSlotType.md).  
Tipo: String  
Valores válidos: `ORIGINAL_VALUE | TOP_RESOLUTION` 

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

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

# GetSlotTypes
<a name="API_GetSlotTypes"></a>

Retorna as informações do tipo de slot da seguinte forma: 
+ Se você especificar o campo `nameContains`, retornará a versão `$LATEST` de todos os tipos de slot que 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 tipos de slot. 

 A operação exige permissões para a ação `lex:GetSlotTypes`. 

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

```
GET /slottypes/?maxResults=maxResults&nameContains=nameContains&nextToken=nextToken HTTP/1.1
```

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

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

 ** [maxResults](#API_GetSlotTypes_RequestSyntax) **   <a name="lex-GetSlotTypes-request-uri-maxResults"></a>
O número máximo de tipo de slot a serem incluídos na resposta. O padrão é 10.  
Faixa válida: valor mínimo de 1. Valor máximo de 50.

 ** [nameContains](#API_GetSlotTypes_RequestSyntax) **   <a name="lex-GetSlotTypes-request-uri-nameContains"></a>
Substring para corresponder aos nomes do tipo de slot. Um tipo de slot 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](#API_GetSlotTypes_RequestSyntax) **   <a name="lex-GetSlotTypes-request-uri-nextToken"></a>
Um token de paginação que busca a próxima página de tipos de slot. Se a resposta a essa chamada de API for truncada, o Amazon Lex retornará um token de paginação na resposta. Para buscar a próxima página de tipos de slot, especifique o token de paginação na próxima solicitação.

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

Essa solicitação não tem corpo.

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

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

{
   "nextToken": "string",
   "slotTypes": [ 
      { 
         "createdDate": number,
         "description": "string",
         "lastUpdatedDate": number,
         "name": "string",
         "version": "string"
      }
   ]
}
```

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

 ** [nextToken](#API_GetSlotTypes_ResponseSyntax) **   <a name="lex-GetSlotTypes-response-nextToken"></a>
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 tipos de slot.  
Tipo: String

 ** [slotTypes](#API_GetSlotTypes_ResponseSyntax) **   <a name="lex-GetSlotTypes-response-slotTypes"></a>
Uma matriz de objetos, um para cada tipo de slot, que fornece informações como o nome do tipo de slot, a versão e uma descrição.  
Tipo: matriz de objetos [SlotTypeMetadata](API_SlotTypeMetadata.md)

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

# GetSlotTypeVersions
<a name="API_GetSlotTypeVersions"></a>

Obtém informações sobre todas as versões de um tipo de slot.

A operação `GetSlotTypeVersions` retorna um objeto `SlotTypeMetadata` para cada versão de um tipo de slot. Por exemplo, se um tipo de slot tiver três versões numeradas, a operação `GetSlotTypeVersions` retornará quatro objetos `SlotTypeMetadata` na resposta, um para cada versão numerada e um para a versão `$LATEST`. 

A operação `GetSlotTypeVersions` sempre retorna pelo menos uma versão, a versão`$LATEST`.

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

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

```
GET /slottypes/name/versions/?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

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

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

 ** [maxResults](#API_GetSlotTypeVersions_RequestSyntax) **   <a name="lex-GetSlotTypeVersions-request-uri-maxResults"></a>
O número máximo de versões de tipo de slot a serem incluídos na resposta. O padrão é 10.  
Faixa válida: valor mínimo de 1. Valor máximo de 50.

 ** [name](#API_GetSlotTypeVersions_RequestSyntax) **   <a name="lex-GetSlotTypeVersions-request-uri-name"></a>
O nome do tipo de slot para o qual as versões devem ser retornadas.  
Restrições de comprimento: tamanho mínimo de 1. Tamanho máximo de 100.  
Padrão: `^([A-Za-z]_?)+$`   
Obrigatório: Sim

 ** [nextToken](#API_GetSlotTypeVersions_RequestSyntax) **   <a name="lex-GetSlotTypeVersions-request-uri-nextToken"></a>
Um token de paginação para buscar a próxima página de versões de tipo de slot. 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 versões, especifique o token de paginação na próxima solicitação. 

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

Essa solicitação não tem corpo.

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

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

{
   "nextToken": "string",
   "slotTypes": [ 
      { 
         "createdDate": number,
         "description": "string",
         "lastUpdatedDate": number,
         "name": "string",
         "version": "string"
      }
   ]
}
```

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

 ** [nextToken](#API_GetSlotTypeVersions_ResponseSyntax) **   <a name="lex-GetSlotTypeVersions-response-nextToken"></a>
Um token de paginação para buscar a próxima página de versões de tipo de slot. 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 versões, especifique o token de paginação na próxima solicitação.   
Tipo: string

 ** [slotTypes](#API_GetSlotTypeVersions_ResponseSyntax) **   <a name="lex-GetSlotTypeVersions-response-slotTypes"></a>
Uma matriz de objetos `SlotTypeMetadata`, um para cada versão numerada do tipo de versão mais um para a versão `$LATEST`.  
Tipo: matriz de objetos [SlotTypeMetadata](API_SlotTypeMetadata.md)

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

# GetUtterancesView
<a name="API_GetUtterancesView"></a>

Use a operação `GetUtterancesView` para obter informações sobre as declarações que seus usuários fizeram ao seu bot. Você pode usar essa lista para ajustar as declarações aos quais seu bot responde.

Por exemplo, digamos que você crie um bot para pedir flores. Depois que seus usuários usarem seu bot por um tempo, use a operação `GetUtterancesView` para ver as solicitações que eles fizeram e se foram bem-sucedidas. Você pode descobrir que a declaração “Eu quero flores” não está sendo reconhecida. Você pode adicionar essa declaração à intenção `OrderFlowers` para que seu bot reconheça essa declaração.

Depois de publicar uma nova versão de um bot, você pode obter informações sobre a versão antiga e a nova para poder comparar o desempenho entre as duas versões. 

As estatísticas de declaração são geradas uma vez por dia. Os dados ficam disponíveis nos últimos 15 dias. Você pode solicitar informações de até 5 versões do seu bot em cada solicitação. O Amazon Lex retorna as declarações mais frequentes recebidas pelo bot nos últimos 15 dias. A resposta contém informações sobre um máximo de 100 declarações para cada versão.

As estatísticas de declaração não são geradas nas seguintes condições:
+ O campo `childDirected` foi definido como verdadeiro quando o bot foi criado.
+ Você está usando a ofuscação de slots com um ou mais slots.
+ Você optou por não participar da melhoria do Amazon Lex.

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

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

```
GET /bots/botname/utterances?view=aggregation&bot_versions=botVersions&status_type=statusType HTTP/1.1
```

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

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

 ** [botname](#API_GetUtterancesView_RequestSyntax) **   <a name="lex-GetUtterancesView-request-uri-botName"></a>
O nome do bot para o qual as informações da declaração devem ser retornadas.  
Restrições de tamanho: tamanho mínimo 2. Tamanho máximo de 50.  
Padrão: `^([A-Za-z]_?)+$`   
Obrigatório: Sim

 ** [botVersions](#API_GetUtterancesView_RequestSyntax) **   <a name="lex-GetUtterancesView-request-uri-botVersions"></a>
Uma matriz de versões de bot para o qual as informações da declaração devem ser retornadas. O limite é de 5 versões por solicitação.  
Membros da Matriz: número mínimo de 1 item. Número máximo de 5 itens.  
Restrições de comprimento: tamanho mínimo de 1. O comprimento máximo é 64.  
Padrão: `\$LATEST|[0-9]+`   
Obrigatório: Sim

 ** [statusType](#API_GetUtterancesView_RequestSyntax) **   <a name="lex-GetUtterancesView-request-uri-statusType"></a>
Para retornar declarações que foram reconhecidas e tratadas, use `Detected`. Para retornar declarações que não foram reconhecidas, use `Missed`.  
Valores válidos: `Detected | Missed`   
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "botName": "string",
   "utterances": [ 
      { 
         "botVersion": "string",
         "utterances": [ 
            { 
               "count": number,
               "distinctUsers": number,
               "firstUtteredDate": number,
               "lastUtteredDate": number,
               "utteranceString": "string"
            }
         ]
      }
   ]
}
```

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

 ** [botName](#API_GetUtterancesView_ResponseSyntax) **   <a name="lex-GetUtterancesView-response-botName"></a>
O nome do bot para o qual as informações da declaração foram retornadas.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 2. Tamanho máximo de 50.  
Padrão: `^([A-Za-z]_?)+$` 

 ** [utterances](#API_GetUtterancesView_ResponseSyntax) **   <a name="lex-GetUtterancesView-response-utterances"></a>
Uma matriz de objetos [UtteranceList](API_UtteranceList.md), cada um contendo uma lista de [UtteranceData](API_UtteranceData.md) objetos descrevendo as declarações que foram processadas pelo seu bot. A resposta contém no máximo 100 objetos `UtteranceData` para cada versão. O Amazon Lex retorna as declarações mais frequentes recebidas pelo bot nos últimos 15 dias.  
Tipo: matriz de objetos [UtteranceList](API_UtteranceList.md)

## Erros
<a name="API_GetUtterancesView_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

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

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Obtém uma lista de tags associadas a um recurso especificado. Somente bots, aliases de bots e canais de bots podem ter tags associadas a eles.

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

```
GET /tags/resourceArn HTTP/1.1
```

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

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

 ** [resourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="lex-ListTagsForResource-request-uri-resourceArn"></a>
O nome do recurso da Amazon (ARN) do recurso para o qual você deseja a lista de tags.  
Restrições de Tamanho: tamanho mínimo 1. O comprimento máximo é 1011.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

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

 ** [tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="lex-ListTagsForResource-response-tags"></a>
As tags associadas a um recurso.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.

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

# PutBot
<a name="API_PutBot"></a>

Cria um bot de conversa do Amazon Lex ou substitui um bot existente. Ao criar ou atualizar um bot, você só precisa especificar um nome, uma localidade e se o bot é direcionado a crianças menores de 13 anos. Você pode usar isso para adicionar intenções posteriormente ou para remover intenções de um bot existente. Quando você cria um bot com o mínimo de informações, o bot é criado ou atualizado, mas o Amazon Lex retorna a resposta `` `FAILED`. Você pode criar o bot depois de adicionar uma ou mais intenções. Para obter mais informações sobre o Amazon Lex, consulte o [Amazon Lex: como funciona](how-it-works.md). 

Se você especificar o nome de um bot existente, os campos na solicitação substituirão os valores existentes na versão `$LATEST` do bot. O Amazon Lex remove todos os campos para os quais você não fornece valores na solicitação, exceto os campos `idleTTLInSeconds` e `privacySettings`, que são definidos com seus valores padrão. Se você não especificar valores para os campos obrigatórios, o Amazon Lex lançará uma exceção.

Essa operação exige permissões para a ação `lex:PutBot`. Para obter mais informações, consulte [Gerenciamento de identidade e acesso para o Amazon Lex](security-iam.md).

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

```
PUT /bots/name/versions/$LATEST HTTP/1.1
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"
   },
   "createVersion": boolean,
   "description": "string",
   "detectSentiment": boolean,
   "enableModelImprovements": boolean,
   "idleSessionTTLInSeconds": number,
   "intents": [ 
      { 
         "intentName": "string",
         "intentVersion": "string"
      }
   ],
   "locale": "string",
   "nluIntentConfidenceThreshold": number,
   "processBehavior": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "voiceId": "string"
}
```

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

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

 ** [name](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-uri-name"></a>
O nome do bot. O nome *não* é sensível a 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

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

A solicitação aceita os dados a seguir no formato JSON.

 ** [abortStatement](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-abortStatement"></a>
Quando o Amazon Lex não consegue entender a entrada do usuário no contexto, ele tenta extrair as informações algumas vezes. Depois disso, o Amazon Lex envia a mensagem definida no `abortStatement` para o usuário e, em seguida, cancela a conversa. Para definir o número de novas tentativas, use o campo `valueElicitationPrompt` para o tipo de slot.   
Por exemplo, em um bot de pedidos de pizza, o Amazon Lex pode perguntar a um usuário “Que tipo de massa você quer?” Se a resposta do usuário não for uma das esperadas (por exemplo, “massa fina”, “prato fundo” etc.), o Amazon Lex tentará obter uma resposta correta mais algumas vezes.   
Por exemplo, em um aplicativo de pedidos de pizza, `OrderPizza` pode ser uma das intenções. Essa intenção pode exigir o slot `CrustType`. Você especifica o campo `valueElicitationPrompt` ao criar o slot `CrustType`.  
Se você tiver definido uma intenção de fallback, a declaração de cancelamento não será enviada ao usuário; em vez disso, a intenção de fallback será usada. Para obter mais informações, consulte [AMAZON. FallbackIntent](https://docs.aws.amazon.com/lex/latest/dg/built-in-intent-fallback.html).  
Tipo: objeto [Statement](API_Statement.md)  
Obrigatório: não

 ** [checksum](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-checksum"></a>
Identifica uma revisão específica da versão `$LATEST`.  
Ao criar um novo bot, deixe o campo `checksum` em branco. Se você especificar uma soma de verificação, obterá uma exceção `BadRequestException`.  
Quando quiser atualizar um bot, defina o campo `checksum` como a soma de verificação da revisão mais recente da versão `$LATEST`. Se você não especificar o campo ` checksum` ou se a soma de verificação não corresponder à versão `$LATEST`, você receberá uma exceção `PreconditionFailedException`.  
Tipo: String  
Obrigatório: não

 ** [childDirected](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-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  
Obrigatório: Sim

 ** [clarificationPrompt](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-clarificationPrompt"></a>
Quando o Amazon Lex não entende a intenção do usuário, ele usa essa mensagem para obter esclarecimentos. Para especificar quantas vezes o Amazon Lex deve repetir o prompt de esclarecimento, use o campo `maxAttempts`. Se o Amazon Lex ainda não entender, ele enviará a mensagem no campo `abortStatement`.   
Ao criar um prompt de esclarecimento, certifique-se de que ela sugira a resposta correta do usuário. Por exemplo, para um bot que pede pizza e bebidas, você pode criar este prompt de esclarecimento: “O que você gostaria de fazer? Você pode dizer "Pedir uma bebida" ou "Pedir uma pizza".  
Se você tiver definido uma intenção de fallback, ela será invocada se o prompt de esclarecimento for repetido o número de vezes definido no campo `maxAttempts`. Para obter mais informações, consulte [AMAZON. FallbackIntent](https://docs.aws.amazon.com/lex/latest/dg/built-in-intent-fallback.html).  
Se você não definir um prompt de esclarecimento, no runtime, o Amazon Lex retornará uma exceção de 400 solicitações inválidas em três casos:   
+ Prompt de acompanhamento - Quando o usuário responde a um prompt de acompanhamento, mas não fornece uma intenção. Por exemplo, em resposta a um prompt de acompanhamento que diz “Você gostaria de mais alguma coisa hoje?” O usuário diz: “Sim”. Como o Amazon Lex não tem um prompt de esclarecimento para obter uma intenção do usuário, ele retorna uma exceção 400 Solicitação inválida.
+ Função do Lambda - Ao usar uma função do Lambda, você retorna um tipo de diálogo `ElicitIntent`. Como o Amazon Lex não tem um prompt de esclarecimento para obter uma intenção do usuário, ele retorna uma exceção 400 Solicitação inválida.
+ PutSession operação - Ao usar a `PutSession` operação, você envia um tipo `ElicitIntent` de diálogo. Como o Amazon Lex não tem um prompt de esclarecimento para obter uma intenção do usuário, ele retorna uma exceção 400 Solicitação inválida.
Tipo: objeto [Prompt](API_Prompt.md)  
Obrigatório: não

 ** [createVersion](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-createVersion"></a>
Quando configurado para `true`, uma nova versão numerada do bot é criada. Isso é o mesmo que chamar a operação `CreateBotVersion`. Se `createVersion` não for especificado, o valor padrão será `false`.  
Tipo: booliano  
Obrigatório: não

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

 ** [detectSentiment](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-detectSentiment"></a>
Quando configurado para o usuário `true`, as declarações do usuário são enviadas ao Amazon Comprehend para análise de sentimento. Se `detectSentiment` não for especificado, o valor padrão será `false`.  
Tipo: booliano  
Obrigatório: não

 ** [enableModelImprovements](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-enableModelImprovements"></a>
Defina como `true` para permitir o acesso a melhorias na compreensão de linguagem natural.   
Ao definir o parâmetro `enableModelImprovements` como `true`, você pode usar o parâmetro `nluIntentConfidenceThreshold` para configurar pontuações de confiança. Para obter mais informações, consulte [Pontuações de confiança](https://docs.aws.amazon.com/lex/latest/dg/confidence-scores.html).  
Você só pode definir o parâmetro `enableModelImprovements` em determinadas regiões. Se você definir o parâmetro como `true`, seu bot terá acesso a melhorias de precisão.  
As regiões nas quais você pode definir o parâmetro `enableModelImprovements` como `false` a para a localidade en-US:  
+ Leste dos EUA (Norte da Virgínia) (us-east-1)
+ Oeste dos EUA (Oregon) (us-west-2)
+ Ásia-Pacífico (Sydney) (ap-southeast-2)
+ Europa (Irlanda) (eu-west-1)
Em outras regiões e localidades, o parâmetro `enableModelImprovements` é definido como `true` por padrão. Nessas regiões e localidades, definir o parâmetro como `false` gera uma exceção `ValidationException`.  
Tipo: booliano  
Obrigatório: não

 ** [idleSessionTTLInSeconds](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-idleSessionTTLInSeconds"></a>
O tempo máximo em segundos que o Amazon Lex retém os dados coletados em uma conversa.  
Uma sessão de interação do usuário permanecerá ativa pelo tempo especificado. Se nenhuma conversa ocorrer durante esse período, a sessão expirará, e o Amazon Lex excluirá todos os dados fornecidos antes do tempo limite.  
Por exemplo, suponha que um usuário escolha a OrderPizza intenção, mas se distraia na metade do processo de fazer um pedido. Se o usuário não concluir o pedido dentro do prazo especificado, o Amazon Lex descartará as informações do slot coletadas e o usuário deverá começar de novo.  
Se você não incluir o elemento `idleSessionTTLInSeconds` em uma solicitação da operação `PutBot`, o Amazon Lex usará o valor padrão. Isso também se aplica se a solicitação substituir um bot existente.  
O padrão é 300 segundos (5 minutos).  
Tipo: inteiro  
Faixa válida: valor mínimo de 60. Valor máximo de 86.400.  
Obrigatório: não

 ** [intents](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-intents"></a>
Uma matriz de objetos `Intent`. Cada intenção representa um comando que um usuário pode expressar. Por exemplo, um bot de pedido de pizza pode apoiar uma OrderPizza intenção. Para obter mais informações, consulte [Amazon Lex: como funciona](how-it-works.md).  
Tipo: matriz de objetos [Intent](API_Intent.md)  
Obrigatório: não

 ** [locale](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-locale"></a>
 Especifica a localidade de destino deste bot. Qualquer intenção usada no bot deve ser compatível com a localidade do bot.   
O padrão é `en-US`.  
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`   
Obrigatório: Sim

 ** [nluIntentConfidenceThreshold](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-nluIntentConfidenceThreshold"></a>
Determina o limite em que o Amazon Lex inserirá 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`e só `AMAZON.KendraSearchIntent` são inseridos se estiverem configurados para o bot.  
Você deve definir o parâmetro `enableModelImprovements` como `true` para usar pontuações de confiança nas seguintes regiões.  
+ Leste dos EUA (Norte da Virgínia) (us-east-1)
+ Oeste dos EUA (Oregon) (us-west-2)
+ Ásia-Pacífico (Sydney) (ap-southeast-2)
+ Europa (Irlanda) (eu-west-1)
Em outras regiões, o parâmetro `enableModelImprovements` é definido como `true` por padrão.  
Por exemplo, suponha que um bot esteja configurado com o limite de confiança de 0,80 e o `AMAZON.FallbackIntent`. O Amazon Lex retorna três intenções alternativas com as seguintes pontuações de confiança: IntentA (0,70), IntentB (0,60), IntentC (0,50). A resposta da operação `PostText` seria:  
+ AMAZÔNIA. FallbackIntent
+ IntentA
+ IntentB
+ IntentC
Tipo: duplo  
Intervalo válido: valor mínimo de 0. Valor máximo de 1.  
Obrigatório: não

 ** [processBehavior](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-processBehavior"></a>
Se você definir o elemento `processBehavior` como `BUILD`, o Amazon Lex criará o bot para que ele possa ser executado. Se você definir o elemento como `SAVE`, o Amazon Lex salva o bot, mas não o cria.   
Se você não especificar este valor, o valor padrão é `BUILD`.  
Tipo: String  
Valores válidos: `SAVE | BUILD`   
Obrigatório: não

 ** [tags](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-tags"></a>
Uma lista de tags a serem adicionadas ao bot. Você só pode adicionar tags ao criar um bot; não pode usar a operação `PutBot` para atualizar as tags em um bot. Para atualizar tags, use a operação `TagResource`.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: não

 ** [voiceId](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-voiceId"></a>
O ID de voz do Amazon Polly que você quer que o Amazon Lex use para interações de voz com o usuário. A localidade configurada para a voz deve corresponder à localidade do bot. Para obter mais informações, consulte [Vozes no Amazon Polly](https://docs.aws.amazon.com/polly/latest/dg/voicelist.html) no *Guia do desenvolvedor do Amazon Polly*.  
Tipo: String  
Obrigatório: não

## Sintaxe da resposta
<a name="API_PutBot_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,
   "createVersion": boolean,
   "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",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "version": "string",
   "voiceId": "string"
}
```

## Elementos de resposta
<a name="API_PutBot_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_PutBot_ResponseSyntax) **   <a name="lex-PutBot-response-abortStatement"></a>
A mensagem que o Amazon Lex usa para cancelar uma conversa. Para obter mais informações, consulte [PutBot](#API_PutBot).  
Tipo: objeto [Statement](API_Statement.md)

 ** [checksum](#API_PutBot_ResponseSyntax) **   <a name="lex-PutBot-response-checksum"></a>
Soma de verificação do bot que você criou.  
Tipo: String

 ** [childDirected](#API_PutBot_ResponseSyntax) **   <a name="lex-PutBot-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_PutBot_ResponseSyntax) **   <a name="lex-PutBot-response-clarificationPrompt"></a>
 Os prompts que o Amazon Lex usa quando não entende a intenção do usuário. Para obter mais informações, consulte [PutBot](#API_PutBot).   
Tipo: objeto [Prompt](API_Prompt.md)

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

 ** [createVersion](#API_PutBot_ResponseSyntax) **   <a name="lex-PutBot-response-createVersion"></a>
 `True` se uma nova versão do bot tiver sido criada. Se o campo `createVersion` não tiver sido especificado na solicitação, o campo `createVersion` será definido como falso na resposta.  
Tipo: booliano

 ** [description](#API_PutBot_ResponseSyntax) **   <a name="lex-PutBot-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_PutBot_ResponseSyntax) **   <a name="lex-PutBot-response-detectSentiment"></a>
 `true` se o bot estiver configurado para enviar declarações do usuário ao Amazon Comprehend para análise de sentimento. Se o campo `detectSentiment` não tiver sido especificado na solicitação, o campo `detectSentiment` será `false` na resposta.  
Tipo: booliano

 ** [enableModelImprovements](#API_PutBot_ResponseSyntax) **   <a name="lex-PutBot-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_PutBot_ResponseSyntax) **   <a name="lex-PutBot-response-failureReason"></a>
Se `status` for `FAILED`, o Amazon Lex fornece o motivo da falha na criação do bot.  
Tipo: String

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

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

 ** [lastUpdatedDate](#API_PutBot_ResponseSyntax) **   <a name="lex-PutBot-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_PutBot_ResponseSyntax) **   <a name="lex-PutBot-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_PutBot_ResponseSyntax) **   <a name="lex-PutBot-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_PutBot_ResponseSyntax) **   <a name="lex-PutBot-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_PutBot_ResponseSyntax) **   <a name="lex-PutBot-response-status"></a>
 Ao enviar uma solicitação para criar um bot com `processBehavior` definido como `BUILD`, o Amazon Lex define o elemento de resposta `status` como `BUILDING`.  
No estado `READY_BASIC_TESTING`, você pode testar o bot com entradas do usuário que correspondem exatamente as declarações configuradas para as intenções e valores do bot nos tipos de slot.  
Se o Amazon Lex não puder criar o bot, ele define `status` como `FAILED`. O Amazon Lex retorna o motivo da falha no elemento de resposta `failureReason`.   
Quando você define `processBehavior` como `SAVE`, o Amazon Lex define o código de status como `NOT BUILT`.  
Quando o bot está no estado `READY`, você pode testar e publicar o bot.  
Tipo: String  
Valores válidos: `BUILDING | READY | READY_BASIC_TESTING | FAILED | NOT_BUILT` 

 ** [tags](#API_PutBot_ResponseSyntax) **   <a name="lex-PutBot-response-tags"></a>
Uma lista de tags associadas ao bot.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.

 ** [version](#API_PutBot_ResponseSyntax) **   <a name="lex-PutBot-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_PutBot_ResponseSyntax) **   <a name="lex-PutBot-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).  
Tipo: string

## Erros
<a name="API_PutBot_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

 ** ConflictException **   
 Houve um conflito ao processar a solicitação. Tente sua solicitação novamente.   
Código de Status HTTP: 409

 ** 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

 ** PreconditionFailedException **   
 A soma de verificação do recurso que você está tentando alterar não corresponde à soma de verificação na solicitação. Verifique a soma de verificação e tente novamente.  
Código de status HTTP: 412

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

# PutBotAlias
<a name="API_PutBotAlias"></a>

Cria um alias para a versão especificada do bot ou substitui um alias para o bot especificado. Para alterar a versão do bot para a qual o alias aponta, substitua o alias. Para obter mais informações sobre aliases, consulte [Versionamento e aliases](versioning-aliases.md).

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

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

```
PUT /bots/botName/aliases/name HTTP/1.1
Content-type: application/json

{
   "botVersion": "string",
   "checksum": "string",
   "conversationLogs": { 
      "iamRoleArn": "string",
      "logSettings": [ 
         { 
            "destination": "string",
            "kmsKeyArn": "string",
            "logType": "string",
            "resourceArn": "string"
         }
      ]
   },
   "description": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

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

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

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

 ** [name](#API_PutBotAlias_RequestSyntax) **   <a name="lex-PutBotAlias-request-uri-name"></a>
O nome do alias. O nome *não* é sensível a maiúsculas e minúsculas.  
Restrições de comprimento: tamanho mínimo de 1. Tamanho máximo de 100.  
Padrão: `^([A-Za-z]_?)+$`   
Obrigatório: Sim

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

A solicitação aceita os dados a seguir no formato JSON.

 ** [botVersion](#API_PutBotAlias_RequestSyntax) **   <a name="lex-PutBotAlias-request-botVersion"></a>
A versão do bot.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 64.  
Padrão: `\$LATEST|[0-9]+`   
Obrigatório: Sim

 ** [checksum](#API_PutBotAlias_RequestSyntax) **   <a name="lex-PutBotAlias-request-checksum"></a>
Identifica uma revisão específica da versão `$LATEST`.  
Ao criar um novo alias de bot, deixe o campo `checksum` em branco. Se você especificar uma soma de verificação, obterá uma exceção `BadRequestException`.  
Quando quiser atualizar um alias de bot, defina o campo `checksum` como a soma de verificação da revisão mais recente da versão `$LATEST`. Se você não especificar o campo ` checksum` ou se a soma de verificação não corresponder à versão `$LATEST`, você receberá uma exceção `PreconditionFailedException`.  
Tipo: String  
Obrigatório: não

 ** [conversationLogs](#API_PutBotAlias_RequestSyntax) **   <a name="lex-PutBotAlias-request-conversationLogs"></a>
Configurações para logs de conversas para o alias.  
Tipo: objeto [ConversationLogsRequest](API_ConversationLogsRequest.md)  
Obrigatório: não

 ** [description](#API_PutBotAlias_RequestSyntax) **   <a name="lex-PutBotAlias-request-description"></a>
Uma descrição do alias.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 200.  
Obrigatório: não

 ** [tags](#API_PutBotAlias_RequestSyntax) **   <a name="lex-PutBotAlias-request-tags"></a>
Uma lista de tags a serem adicionadas ao alias de bot. Você só pode adicionar tags ao criar um alias de bot; não pode usar a operação `PutBotAlias` para atualizar as tags em um alias de bot. Para atualizar tags, use a operação `TagResource`.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: não

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

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

{
   "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",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

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

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

 ** [botVersion](#API_PutBotAlias_ResponseSyntax) **   <a name="lex-PutBotAlias-response-botVersion"></a>
A versão do bot para o qual o alias aponta.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 64.  
Padrão: `\$LATEST|[0-9]+` 

 ** [checksum](#API_PutBotAlias_ResponseSyntax) **   <a name="lex-PutBotAlias-response-checksum"></a>
A soma de verificação para a versão atual do alias.  
Tipo: String

 ** [conversationLogs](#API_PutBotAlias_ResponseSyntax) **   <a name="lex-PutBotAlias-response-conversationLogs"></a>
As configurações que determinam como o Amazon Lex usa logs de conversa para o alias.  
Tipo: objeto [ConversationLogsResponse](API_ConversationLogsResponse.md)

 ** [createdDate](#API_PutBotAlias_ResponseSyntax) **   <a name="lex-PutBotAlias-response-createdDate"></a>
A data em que o alias do bot foi criado.  
Tipo: Timestamp

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

 ** [lastUpdatedDate](#API_PutBotAlias_ResponseSyntax) **   <a name="lex-PutBotAlias-response-lastUpdatedDate"></a>
A data em que o alias do 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

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

 ** [tags](#API_PutBotAlias_ResponseSyntax) **   <a name="lex-PutBotAlias-response-tags"></a>
Uma lista de tags associadas a um bot.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.

## Erros
<a name="API_PutBotAlias_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

 ** ConflictException **   
 Houve um conflito ao processar a solicitação. Tente sua solicitação novamente.   
Código de Status HTTP: 409

 ** 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

 ** PreconditionFailedException **   
 A soma de verificação do recurso que você está tentando alterar não corresponde à soma de verificação na solicitação. Verifique a soma de verificação e tente novamente.  
Código de status HTTP: 412

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

# PutIntent
<a name="API_PutIntent"></a>

Cria uma intenção ou substitui uma intenção existente.

Para definir a interação entre o usuário e seu bot, você usa uma ou mais intenções. Para um bot de pedidos de pizza, por exemplo, você criaria uma intenção `OrderPizza`. 

Para criar uma intenção ou substituir uma intenção existente, você deve fornecer o seguinte:
+ Nome da intenção. Por exemplo, .`OrderPizza`
+ Amostra de declarações. Por exemplo, “Posso pedir uma pizza, por favor.” e “Quero pedir uma pizza”.
+ Informações a serem coletadas. Você especifica os tipos de slots para as informações que seu bot solicitará do usuário. Você pode especificar tipos de compartimentos padrão, como data ou hora, ou tipos de compartimentos personalizados, como o tamanho e a massa de uma pizza.
+ Como a intenção será atendida. Você pode fornecer uma função do Lambda ou configurar a intenção para retornar as informações da intenção ao aplicativo cliente. Se você usa uma função do Lambda, quando todas as informações de intenção estão disponíveis, o Amazon Lex invoca sua função do Lambda. Se você configurar sua intenção para retornar as informações de intenção para o aplicativo cliente. 

Você pode especificar outras informações opcionais na solicitação, como:
+ Um prompt de confirmação para solicitar que o usuário confirme uma intenção. Por exemplo, “Devo pedir sua pizza?”
+ Uma declaração de conclusão a ser enviada ao usuário após o atendimento da intenção. Por exemplo, “Devo pedir sua pizza?”.
+ Um prompt de acompanhamento que solicita atividades adicionais ao usuário. Por exemplo, perguntar “Você quer pedir uma bebida com a sua pizza?”

Se você especificar um nome de intenção existente para atualizar a intenção, o Amazon Lex substituirá os valores na versão `$LATEST` da intenção pelos valores na solicitação. O Amazon Lex remove campos que você não fornece na solicitação. Se você não especificar os campos obrigatórios, o Amazon Lex lançará uma exceção. Quando você atualiza a versão `$LATEST` de uma intenção, o campo `status` de qualquer bot que usa a versão `$LATEST` da intenção é definido como `NOT_BUILT`.

Para obter mais informações, consulte [Amazon Lex: como funciona](how-it-works.md).

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

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

```
PUT /intents/name/versions/$LATEST HTTP/1.1
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"
   },
   "createVersion": boolean,
   "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"
   },
   "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"
         }
      }
   ]
}
```

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

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

 ** [name](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-uri-name"></a>
O nome da intenção. O nome *não* é sensível a maiúsculas e minúsculas.   
O nome não pode corresponder a um nome de intenção incorporado ou a um nome de intenção incorporado com “AMAZON.” removido. Por exemplo, como há uma intenção integrada chamada `AMAZON.HelpIntent`, você não pode criar uma intenção personalizada chamada `HelpIntent`.   
Para obter uma lista de intenções integradas, consulte [Intenções integradas padrão](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents) no *Alexa Skills Kit*.  
Restrições de comprimento: tamanho mínimo de 1. Tamanho máximo de 100.  
Padrão: `^([A-Za-z]_?)+$`   
Obrigatório: Sim

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

A solicitação aceita os dados a seguir no formato JSON.

 ** [checksum](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-checksum"></a>
Identifica uma revisão específica da versão `$LATEST`.  
Ao criar uma nova intenção, deixe o campo `checksum` em branco. Se você especificar uma soma de verificação, obterá uma exceção `BadRequestException`.  
Quando quiser atualizar uma intenção, defina o campo `checksum` como a soma de verificação da revisão mais recente da versão `$LATEST`. Se você não especificar o campo ` checksum` ou se a soma de verificação não corresponder à versão `$LATEST`, você receberá uma exceção `PreconditionFailedException`.  
Tipo: String  
Obrigatório: não

 ** [conclusionStatement](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-conclusionStatement"></a>
 A declaração que você deseja que o Amazon Lex transmita ao usuário após a intenção ser atendida com sucesso pela função do Lambda.   
Esse elemento é relevante somente se você fornecer uma função do Lambda no `fulfillmentActivity`. Se você retornar a intenção ao aplicativo cliente, não poderá especificar esse elemento.  
Os `followUpPrompt` e `conclusionStatement` são mutuamente exclusivos. Você pode especificar apenas um.
Tipo: objeto [Statement](API_Statement.md)  
Obrigatório: não

 ** [confirmationPrompt](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-confirmationPrompt"></a>
Solicita que o usuário confirme a intenção. Essa pergunta deve ter uma resposta afirmativa ou negativa.  
O Amazon Lex usa esse prompt para garantir que o usuário reconheça que a intenção está pronta para ser atendida. Por exemplo, com a intenção `OrderPizza`, talvez você queira confirmar que o pedido está correto antes de fazer o pedido. Para outras finalidades, como intenções que simplesmente respondem às perguntas do usuário, talvez não seja necessário pedir confirmação ao usuário antes de fornecer as informações.   
Você deve fornecer tanto o `rejectionStatement` quanto o `confirmationPrompt`, ou nenhum.
Tipo: objeto [Prompt](API_Prompt.md)  
Obrigatório: não

 ** [createVersion](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-createVersion"></a>
Quando configurado para `true`, uma nova versão numerada da intenção é criada. Isso é o mesmo que chamar a operação `CreateIntentVersion`. Se você não especificar `createVersion`, o valor padrão será `false`.  
Tipo: booliano  
Obrigatório: não

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

 ** [dialogCodeHook](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-dialogCodeHook"></a>
 Especifica uma função do Lambda do alias para invocar cada entrada do usuário. Você pode invocar essa função do Lambda para personalizar a interação do usuário.   
Por exemplo, suponha que seu bot determine que o usuário é John. Sua função do Lambda pode recuperar as informações de John de um banco de dados de back-end e preencher previamente alguns dos valores. Por exemplo, se achar que John é intolerante ao glúten, você pode definir o intervalo de intenção correspondente, `GlutenIntolerant`, como verdadeiro. Você pode encontrar o número de telefone de John e definir o atributo de sessão correspondente.   
Tipo: objeto [CodeHook](API_CodeHook.md)  
Obrigatório: não

 ** [followUpPrompt](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-followUpPrompt"></a>
O Amazon Lex usa esse prompt para solicitar atividades adicionais do usuário depois de atender uma intenção. Por exemplo, depois que a intenção `OrderPizza` for atendida, você pode solicitar que o usuário peça uma bebida.  
A ação que o Amazon Lex executa depende da resposta do usuário, da seguinte forma:  
+ Se o usuário disser “Sim”, ele responderá com o prompt de esclarecimento configurado para o bot.
+ Se o usuário disser “Sim” e continuar com uma declaração que aciona uma intenção, ele iniciará uma conversa sobre a intenção.
+ Se o usuário disser “Não”, ele responderá com a declaração de rejeição configurada para o prompt de acompanhamento.
+ Se ele não reconhecer a declaração, ele repetirá o prompt de acompanhamento novamente.
O campo `followUpPrompt` e o campo `conclusionStatement` são mutuamente exclusivos. Você pode especificar apenas um.   
Tipo: objeto [FollowUpPrompt](API_FollowUpPrompt.md)  
Obrigatório: não

 ** [fulfillmentActivity](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-fulfillmentActivity"></a>
Obrigatório. Descreve como a intenção é atendida. Por exemplo, depois que um usuário fornece todas as informações de um pedido de pizza, `fulfillmentActivity` define como o bot faz um pedido em uma pizzaria local.   
 Você pode configurar o Amazon Lex para retornar todas as informações de intenção ao aplicativo cliente ou direcioná-lo para invocar uma função do Lambda que possa processar a intenção (por exemplo, fazer um pedido em uma pizzaria).   
Tipo: objeto [FulfillmentActivity](API_FulfillmentActivity.md)  
Obrigatório: não

 ** [inputContexts](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-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.  
Obrigatório: não

 ** [kendraConfiguration](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-kendraConfiguration"></a>
Informações de configuração necessárias para usar a intenção `AMAZON.KendraSearchIntent`para se conectar a um índice do Amazon Kendra. Para obter mais informações, consulte [AMAZON. KendraSearchIntent](https://docs.aws.amazon.com/lex/latest/dg/built-in-intent-kendra-search.html).  
Tipo: objeto [KendraConfiguration](API_KendraConfiguration.md)  
Obrigatório: não

 ** [outputContexts](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-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.  
Obrigatório: não

 ** [parentIntentSignature](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-parentIntentSignature"></a>
O identificador exclusivo da intenção integrada a ser usada como base para essa intenção. Para encontrar a assinatura de uma intenção, consulte [Intenções integradas padrão](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents) no *Alexa Skills Kit*.  
Tipo: String  
Obrigatório: não

 ** [rejectionStatement](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-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.   
Você deve fornecer tanto o `rejectionStatement` quanto o `confirmationPrompt`, ou nenhum.
Tipo: objeto [Statement](API_Statement.md)  
Obrigatório: não

 ** [sampleUtterances](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-sampleUtterances"></a>
Uma lista das declarações (strings) que um usuário pode fazer para sinalizar a intenção. Por exemplo, “Quero \$1PizzaSize\$1 pizza”, “Pedir \$1Quantidade\$1 \$1PizzaSize\$1 pizzas”.   
Em cada declaração, o nome de um slot é colocado entre chaves.   
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.  
Obrigatório: não

 ** [slots](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-slots"></a>
Uma matriz de slots de intenção. Em runtime, o Amazon Lex extrai os valores de slot necessários do usuário usando prompts definidos nos slots. Para obter mais informações, consulte [Amazon Lex: como funciona](how-it-works.md).   
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.  
Obrigatório: não

## Sintaxe da resposta
<a name="API_PutIntent_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,
   "createVersion": boolean,
   "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_PutIntent_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_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-response-checksum"></a>
Soma de verificação da versão `$LATEST` de intenção criada ou atualizada.  
Tipo: String

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

 ** [confirmationPrompt](#API_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-response-confirmationPrompt"></a>
Se definido na intenção, o Amazon Lex solicita que o usuário confirme a intenção antes de atendê-la.  
Tipo: objeto [Prompt](API_Prompt.md)

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

 ** [createVersion](#API_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-response-createVersion"></a>
 `True` se uma nova versão da intenção tiver sido criada. Se o campo `createVersion` não tiver sido especificado na solicitação, o campo `createVersion` será definido como falso na resposta.  
Tipo: booliano

 ** [description](#API_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-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_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-response-dialogCodeHook"></a>
Se definido na intenção, o Amazon Lex invoca essa função do Lambda para cada entrada do usuário.  
Tipo: objeto [CodeHook](API_CodeHook.md)

 ** [followUpPrompt](#API_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-response-followUpPrompt"></a>
Se definido na intenção, o Amazon Lex usa esse prompt para solicitar atividades adicionais do usuário depois que a intenção for atendida.  
Tipo: objeto [FollowUpPrompt](API_FollowUpPrompt.md)

 ** [fulfillmentActivity](#API_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-response-fulfillmentActivity"></a>
Se definido na intenção, o Amazon Lex invoca essa função do Lambda para cumprir a intenção depois que o usuário fornece todas as informações exigidas pela intenção.  
Tipo: objeto [FulfillmentActivity](API_FulfillmentActivity.md)

 ** [inputContexts](#API_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-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_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-response-kendraConfiguration"></a>
Informações de configuração, se houver, necessárias para se conectar a um índice do Amazon Kendra e usar na intenção `AMAZON.KendraSearchIntent`.  
Tipo: objeto [KendraConfiguration](API_KendraConfiguration.md)

 ** [lastUpdatedDate](#API_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-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_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-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_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-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_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-response-parentIntentSignature"></a>
Um identificador exclusivo da intenção integrada na qual essa intenção se baseia.  
Tipo: string

 ** [rejectionStatement](#API_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-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_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-response-sampleUtterances"></a>
 Uma matriz de amostras de declarações que são configuradas 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_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-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_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-response-version"></a>
A versão da intenção. Para uma nova intenção, 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]+` 

## Erros
<a name="API_PutIntent_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

 ** ConflictException **   
 Houve um conflito ao processar a solicitação. Tente sua solicitação novamente.   
Código de Status HTTP: 409

 ** 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

 ** PreconditionFailedException **   
 A soma de verificação do recurso que você está tentando alterar não corresponde à soma de verificação na solicitação. Verifique a soma de verificação e tente novamente.  
Código de status HTTP: 412

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

# PutSlotType
<a name="API_PutSlotType"></a>

Cria um tipo de slot personalizado ou substitui um tipo de slot personalizado existente.

Para criar um tipo de slot personalizado, especifique um nome para o tipo de slot e um conjunto de valores de enumeração, que são os valores que um slot desse tipo pode assumir. Para obter mais informações, consulte [Amazon Lex: como funciona](how-it-works.md).

Se você especificar o nome de um tipo de slot existente, os campos na solicitação substituirão os valores existentes na versão `$LATEST` do tipo de slot. O Amazon Lex remove campos que você não fornece na solicitação. Se você não especificar os campos obrigatórios, o Amazon Lex lançará uma exceção. Quando você atualiza a versão `$LATEST` de um tipo de slot, o campo `$LATEST` de qualquer bot que usa a versão `status` do tipo de slot é definido como `NOT_BUILT`. 

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

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

```
PUT /slottypes/name/versions/$LATEST HTTP/1.1
Content-type: application/json

{
   "checksum": "string",
   "createVersion": boolean,
   "description": "string",
   "enumerationValues": [ 
      { 
         "synonyms": [ "string" ],
         "value": "string"
      }
   ],
   "parentSlotTypeSignature": "string",
   "slotTypeConfigurations": [ 
      { 
         "regexConfiguration": { 
            "pattern": "string"
         }
      }
   ],
   "valueSelectionStrategy": "string"
}
```

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

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

 ** [name](#API_PutSlotType_RequestSyntax) **   <a name="lex-PutSlotType-request-uri-name"></a>
O nome do tipo de slot. O nome *não* é sensível a maiúsculas e minúsculas.   
O nome não pode corresponder a um nome de tipo de slot incorporado ou a um nome de tipo de slot incorporado com “AMAZON.” removido. Por exemplo, como há um tipo de slot integrado chamado `AMAZON.DATE`, você não pode criar um tipo de slot personalizado chamado `DATE`.   
Para obter uma lista de tipos de slot integrados, consulte [Referência do tipo de slot](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/slot-type-reference) no *Alexa Skills Kit*.  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.  
Padrão: `^([A-Za-z]_?)+$`   
Obrigatório: Sim

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

A solicitação aceita os dados a seguir no formato JSON.

 ** [checksum](#API_PutSlotType_RequestSyntax) **   <a name="lex-PutSlotType-request-checksum"></a>
Identifica uma revisão específica da versão `$LATEST`.  
Ao criar um novo tipo de slot, deixe o campo `checksum` em branco. Se você especificar uma soma de verificação, obterá uma exceção `BadRequestException`.  
Quando quiser atualizar um tipo de slot, defina o campo `checksum` como a soma de verificação da revisão mais recente da versão `$LATEST`. Se você não especificar o campo ` checksum` ou se a soma de verificação não corresponder à versão `$LATEST`, você receberá uma exceção `PreconditionFailedException`.  
Tipo: String  
Obrigatório: não

 ** [createVersion](#API_PutSlotType_RequestSyntax) **   <a name="lex-PutSlotType-request-createVersion"></a>
Quando configurado para `true`, uma nova versão numerada do tipo de slot é criada. Isso é o mesmo que chamar a operação `CreateSlotTypeVersion`. Se você não especificar `createVersion`, o valor padrão será `false`.  
Tipo: booliano  
Obrigatório: não

 ** [description](#API_PutSlotType_RequestSyntax) **   <a name="lex-PutSlotType-request-description"></a>
Uma descrição do tipo de slot.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 200.  
Obrigatório: não

 ** [enumerationValues](#API_PutSlotType_RequestSyntax) **   <a name="lex-PutSlotType-request-enumerationValues"></a>
Uma lista de objetos `EnumerationValue` que define os valores que o tipo de slot pode ter. Cada valor pode ter uma lista de `synonyms`, que são valores adicionais que ajudam a treinar o modelo de machine learning sobre os valores que ele resolve para o slot.   
Um tipo de slot de expressão regular não exige valores de enumeração. Todos os outros tipos de slots exigem uma lista de valores de enumeração.  
Quando o Amazon Lex resolve um valor de slot, ele gera uma lista de resolução que contém até cinco valores possíveis para o slot. Se você estiver usando uma função do Lambda, essa lista de resolução será passada para a função. Se você não estiver usando uma função do Lambda, poderá optar por retornar o valor que o usuário inseriu ou o primeiro valor na lista como o valor de slot. O campo `valueSelectionStrategy` indica a opção a ser usada.   
Tipo: matriz de objetos [EnumerationValue](API_EnumerationValue.md)  
Membros da Matriz: número mínimo de 0 itens. Número máximo de 10.000 itens.  
Obrigatório: não

 ** [parentSlotTypeSignature](#API_PutSlotType_RequestSyntax) **   <a name="lex-PutSlotType-request-parentSlotTypeSignature"></a>
O tipo de slot integrado usado como pai do tipo de slot. Quando você define um tipo de slot pai, o novo tipo de slot tem todas as mesmas configurações do pai.  
Somente `AMAZON.AlphaNumeric` é suportado.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.  
Padrão: `^((AMAZON\.)_?|[A-Za-z]_?)+`   
Obrigatório: não

 ** [slotTypeConfigurations](#API_PutSlotType_RequestSyntax) **   <a name="lex-PutSlotType-request-slotTypeConfigurations"></a>
Informações de configuração que estendem o tipo de slot integrado principal. A configuração é adicionada às configurações do tipo de slot principal.  
Tipo: matriz de objetos [SlotTypeConfiguration](API_SlotTypeConfiguration.md)  
Membros da Matriz: número mínimo de 0 itens. Número máximo de 10 itens.  
Obrigatório: não

 ** [valueSelectionStrategy](#API_PutSlotType_RequestSyntax) **   <a name="lex-PutSlotType-request-valueSelectionStrategy"></a>
Determina a estratégia de resolução de slots que o Amazon Lex usa para retornar valores do tipo de slot. O campo pode ser definido com os dos seguintes valores:  
+  `ORIGINAL_VALUE` - Retorna o valor inserido pelo usuário, se o valor do usuário for semelhante ao valor de um slot.
+  `TOP_RESOLUTION` - Se houver uma lista de resolução para o slot, retornará o primeiro valor na lista como o valor do tipo de slot. Se não houver uma lista de resolução, retornará o valor “null”.
Se `valueSelectionStrategy` não for especificado, o valor padrão será `ORIGINAL_VALUE`.  
Tipo: String  
Valores válidos: `ORIGINAL_VALUE | TOP_RESOLUTION`   
Obrigatório: não

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

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

{
   "checksum": "string",
   "createdDate": number,
   "createVersion": boolean,
   "description": "string",
   "enumerationValues": [ 
      { 
         "synonyms": [ "string" ],
         "value": "string"
      }
   ],
   "lastUpdatedDate": number,
   "name": "string",
   "parentSlotTypeSignature": "string",
   "slotTypeConfigurations": [ 
      { 
         "regexConfiguration": { 
            "pattern": "string"
         }
      }
   ],
   "valueSelectionStrategy": "string",
   "version": "string"
}
```

## Elementos de resposta
<a name="API_PutSlotType_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_PutSlotType_ResponseSyntax) **   <a name="lex-PutSlotType-response-checksum"></a>
Soma de verificação da versão `$LATEST` do tipo de slot.  
Tipo: String

 ** [createdDate](#API_PutSlotType_ResponseSyntax) **   <a name="lex-PutSlotType-response-createdDate"></a>
A data em que o tipo de slot foi criado.  
Tipo: Timestamp

 ** [createVersion](#API_PutSlotType_ResponseSyntax) **   <a name="lex-PutSlotType-response-createVersion"></a>
 `True` se uma nova versão do tipo de slot tiver sido criada. Se o campo `createVersion` não tiver sido especificado na solicitação, o campo `createVersion` será definido como falso na resposta.  
Tipo: booliano

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

 ** [enumerationValues](#API_PutSlotType_ResponseSyntax) **   <a name="lex-PutSlotType-response-enumerationValues"></a>
Uma lista de objetos `EnumerationValue` que define os valores que o tipo de slot pode ter.  
Tipo: matriz de objetos [EnumerationValue](API_EnumerationValue.md)  
Membros da Matriz: número mínimo de 0 itens. Número máximo de 10.000 itens.

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

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

 ** [parentSlotTypeSignature](#API_PutSlotType_ResponseSyntax) **   <a name="lex-PutSlotType-response-parentSlotTypeSignature"></a>
O tipo de slot integrado usado como pai do tipo de slot.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.  
Padrão: `^((AMAZON\.)_?|[A-Za-z]_?)+` 

 ** [slotTypeConfigurations](#API_PutSlotType_ResponseSyntax) **   <a name="lex-PutSlotType-response-slotTypeConfigurations"></a>
Informações de configuração que estendem o tipo de slot integrado principal.  
Tipo: matriz de objetos [SlotTypeConfiguration](API_SlotTypeConfiguration.md)  
Membros da Matriz: número mínimo de 0 itens. Número máximo de 10 itens.

 ** [valueSelectionStrategy](#API_PutSlotType_ResponseSyntax) **   <a name="lex-PutSlotType-response-valueSelectionStrategy"></a>
A estratégia de resolução de slot que o Amazon Lex usa para determinar o valor de slot. Para obter mais informações, consulte [PutSlotType](#API_PutSlotType).  
Tipo: String  
Valores válidos: `ORIGINAL_VALUE | TOP_RESOLUTION` 

 ** [version](#API_PutSlotType_ResponseSyntax) **   <a name="lex-PutSlotType-response-version"></a>
A versão do tipo de slot. Para um novo tipo de slot, 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]+` 

## Erros
<a name="API_PutSlotType_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

 ** ConflictException **   
 Houve um conflito ao processar a solicitação. Tente sua solicitação novamente.   
Código de Status HTTP: 409

 ** 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

 ** PreconditionFailedException **   
 A soma de verificação do recurso que você está tentando alterar não corresponde à soma de verificação na solicitação. Verifique a soma de verificação e tente novamente.  
Código de status HTTP: 412

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

# StartImport
<a name="API_StartImport"></a>

Inicia um trabalho para importar um recurso para o Amazon Lex.

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

```
POST /imports/ HTTP/1.1
Content-type: application/json

{
   "mergeStrategy": "string",
   "payload": blob,
   "resourceType": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

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

A solicitação não usa nenhum parâmetro de URI.

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

A solicitação aceita os dados a seguir no formato JSON.

 ** [mergeStrategy](#API_StartImport_RequestSyntax) **   <a name="lex-StartImport-request-mergeStrategy"></a>
Especifica a ação que a operação `StartImport` deve realizar quando há um recurso existente com o mesmo nome.  
+ FAIL\$1ON\$1CONFLICT - A operação de importação é interrompida no primeiro conflito entre um recurso no arquivo de importação e um recurso existente. O nome do recurso que está causando o conflito está no campo `failureReason` da resposta à operação `GetImport`.

  OVERWRITE\$1LATEST - A operação de importação prossegue mesmo se houver um conflito com um recurso existente. A versão \$1LASTEST do recurso existente é substituída pelos dados do arquivo de importação.
Tipo: String  
Valores válidos: `OVERWRITE_LATEST | FAIL_ON_CONFLICT`   
Obrigatório: Sim

 ** [payload](#API_StartImport_RequestSyntax) **   <a name="lex-StartImport-request-payload"></a>
Um arquivo zip em formato binário. O arquivo deve conter um arquivo, um arquivo JSON que contém o recurso a ser importado. O recurso deve corresponder ao tipo especificado no campo `resourceType`.  
Tipo: Objeto de dados binários codificado em Base64  
Obrigatório: Sim

 ** [resourceType](#API_StartImport_RequestSyntax) **   <a name="lex-StartImport-request-resourceType"></a>
Especifica o tipo de recurso a ser exportado. Cada recurso também exporta todos os recursos dos quais ele depende.   
+ Um bot exporta intenções dependentes.
+ Uma intenção exporta os tipos de slots dependentes.
Tipo: String  
Valores válidos: `BOT | INTENT | SLOT_TYPE`   
Obrigatório: Sim

 ** [tags](#API_StartImport_RequestSyntax) **   <a name="lex-StartImport-request-tags"></a>
Uma lista de tags a serem adicionadas ao bot importado. Apenas é possível adicionar tags ao importar um bot. Não é possível adicionar tags a uma intenção ou tipo de slot.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: não

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

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

{
   "createdDate": number,
   "importId": "string",
   "importStatus": "string",
   "mergeStrategy": "string",
   "name": "string",
   "resourceType": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

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

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 201.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [createdDate](#API_StartImport_ResponseSyntax) **   <a name="lex-StartImport-response-createdDate"></a>
Um carimbo de data e hora para a data e a hora em que a tarefa de importação foi solicitada.  
Tipo: Timestamp

 ** [importId](#API_StartImport_ResponseSyntax) **   <a name="lex-StartImport-response-importId"></a>
O identificador para a tarefa de importação específica.  
Tipo: String

 ** [importStatus](#API_StartImport_ResponseSyntax) **   <a name="lex-StartImport-response-importStatus"></a>
O status do trabalho de importação. Se o status for `FAILED`, você poderá obter o motivo da falha usando a operação `GetImport`.  
Tipo: String  
Valores válidos: `IN_PROGRESS | COMPLETE | FAILED` 

 ** [mergeStrategy](#API_StartImport_ResponseSyntax) **   <a name="lex-StartImport-response-mergeStrategy"></a>
A ação a ser executada quando houver um conflito de fusão.  
Tipo: String  
Valores válidos: `OVERWRITE_LATEST | FAIL_ON_CONFLICT` 

 ** [name](#API_StartImport_ResponseSyntax) **   <a name="lex-StartImport-response-name"></a>
O nome dado ao trabalho de importação.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.  
Padrão: `[a-zA-Z_]+` 

 ** [resourceType](#API_StartImport_ResponseSyntax) **   <a name="lex-StartImport-response-resourceType"></a>
O tipo do recurso a ser importado.  
Tipo: string  
Valores válidos: `BOT | INTENT | SLOT_TYPE` 

 ** [tags](#API_StartImport_ResponseSyntax) **   <a name="lex-StartImport-response-tags"></a>
Uma lista de tags a serem adicionadas ao bot importado.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.

## Erros
<a name="API_StartImport_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

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

# StartMigration
<a name="API_StartMigration"></a>

Começa a migrar um bot do Amazon Lex V1 para o Amazon Lex V2. Migre seu bot quando quiser aproveitar os novos atributos do Amazon Lex V2.

Para obter mais informações, consulte [Migração de um bot](https://docs.aws.amazon.com/lex/latest/dg/migrate.html) no *Guia do desenvolvedor do Amazon Lex*.

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

```
POST /migrations HTTP/1.1
Content-type: application/json

{
   "migrationStrategy": "string",
   "v1BotName": "string",
   "v1BotVersion": "string",
   "v2BotName": "string",
   "v2BotRole": "string"
}
```

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

A solicitação não usa nenhum parâmetro de URI.

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

A solicitação aceita os dados a seguir no formato JSON.

 ** [migrationStrategy](#API_StartMigration_RequestSyntax) **   <a name="lex-StartMigration-request-migrationStrategy"></a>
A estratégia usada para conduzir a migração.  
+  `CREATE_NEW` - Cria um novo bot do Amazon Lex V2 e migra o bot do Amazon Lex V1 para o novo bot.
+  `UPDATE_EXISTING` - Substitui os metadados existentes do bot do Amazon Lex V2 e a localidade que está sendo migrada. Isso não altera nenhuma outra localidade no bot do Amazon Lex V2. Se a localidade não existir, uma nova localidade será criada no bot do Amazon Lex V2.
Tipo: String  
Valores válidos: `CREATE_NEW | UPDATE_EXISTING`   
Obrigatório: Sim

 ** [v1BotName](#API_StartMigration_RequestSyntax) **   <a name="lex-StartMigration-request-v1BotName"></a>
O nome do bot do Amazon Lex V1 que você está migrando para o Amazon Lex V2.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 2. Tamanho máximo de 50.  
Padrão: `^([A-Za-z]_?)+$`   
Obrigatório: Sim

 ** [v1BotVersion](#API_StartMigration_RequestSyntax) **   <a name="lex-StartMigration-request-v1BotVersion"></a>
A versão do bot a ser migrado para o Amazon Lex V2. Você pode migrar a versão `$LATEST`, bem como qualquer versão numerada.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 64.  
Padrão: `\$LATEST|[0-9]+`   
Obrigatório: Sim

 ** [v2BotName](#API_StartMigration_RequestSyntax) **   <a name="lex-StartMigration-request-v2BotName"></a>
O nome do bot do Amazon Lex V2 para o qual você está migrando o bot do Amazon Lex V1.   
+ Se o bot do Amazon Lex V2 não existir, você deverá usar a estratégia de migração `CREATE_NEW`.
+ Se o bot do Amazon Lex V2 existir, você deverá usar a estratégia de migração `UPDATE_EXISTING` para alterar o conteúdo do bot do Amazon Lex V2.
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.  
Padrão: `^([0-9a-zA-Z][_-]?)+$`   
Obrigatório: Sim

 ** [v2BotRole](#API_StartMigration_RequestSyntax) **   <a name="lex-StartMigration-request-v2BotRole"></a>
O perfil do IAM que o Amazon Lex usa para executar a versão do bot do Amazon Lex V2.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 20. Tamanho máximo de 2.048.  
Padrão: `^arn:[\w\-]+:iam::[\d]{12}:role/.+$`   
Obrigatório: sim

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

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

{
   "migrationId": "string",
   "migrationStrategy": "string",
   "migrationTimestamp": number,
   "v1BotLocale": "string",
   "v1BotName": "string",
   "v1BotVersion": "string",
   "v2BotId": "string",
   "v2BotRole": "string"
}
```

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

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 202.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [migrationId](#API_StartMigration_ResponseSyntax) **   <a name="lex-StartMigration-response-migrationId"></a>
O identificador exclusivo que o Amazon Lex atribuiu à migração.  
Tipo: String  
Restrições de tamanho: tamanho fixo de 10.  
Padrão: `^[0-9a-zA-Z]+$` 

 ** [migrationStrategy](#API_StartMigration_ResponseSyntax) **   <a name="lex-StartMigration-response-migrationStrategy"></a>
A estratégia usada para conduzir a migração.  
Tipo: String  
Valores válidos: `CREATE_NEW | UPDATE_EXISTING` 

 ** [migrationTimestamp](#API_StartMigration_ResponseSyntax) **   <a name="lex-StartMigration-response-migrationTimestamp"></a>
A data e hora em que a migração foi iniciada.  
Tipo: Timestamp

 ** [v1BotLocale](#API_StartMigration_ResponseSyntax) **   <a name="lex-StartMigration-response-v1BotLocale"></a>
A localidade usada para o bot do Amazon Lex V1.   
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` 

 ** [v1BotName](#API_StartMigration_ResponseSyntax) **   <a name="lex-StartMigration-response-v1BotName"></a>
O nome do bot do Amazon Lex V1 que você está migrando para o Amazon Lex V2.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 2. Tamanho máximo de 50.  
Padrão: `^([A-Za-z]_?)+$` 

 ** [v1BotVersion](#API_StartMigration_ResponseSyntax) **   <a name="lex-StartMigration-response-v1BotVersion"></a>
A versão do bot a ser migrado para o Amazon Lex V2.   
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 64.  
Padrão: `\$LATEST|[0-9]+` 

 ** [v2BotId](#API_StartMigration_ResponseSyntax) **   <a name="lex-StartMigration-response-v2BotId"></a>
O identificador exclusivo do bot do Amazon Lex V2.   
Tipo: String  
Restrições de tamanho: tamanho fixo de 10.  
Padrão: `^[0-9a-zA-Z]+$` 

 ** [v2BotRole](#API_StartMigration_ResponseSyntax) **   <a name="lex-StartMigration-response-v2BotRole"></a>
O perfil do IAM que o Amazon Lex usa para executar a versão do bot do Amazon Lex V2.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 20. Tamanho máximo de 2.048.  
Padrão: `^arn:[\w\-]+:iam::[\d]{12}:role/.+$` 

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

 ** AccessDeniedException **   
Seu usuário ou função do IAM não tem permissão para chamar o Amazon Lex V2 APIs necessário para migrar seu bot.  
Código de status HTTP: 403

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

# TagResource
<a name="API_TagResource"></a>

Adiciona as tags especificadas ao recurso especificado. Se uma chave de tag já existir, o valor existente será substituído pelo novo valor.

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

```
POST /tags/resourceArn HTTP/1.1
Content-type: application/json

{
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

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

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

 ** [resourceArn](#API_TagResource_RequestSyntax) **   <a name="lex-TagResource-request-uri-resourceArn"></a>
O nome do recurso da Amazon (ARN) do bot, do alias do bot ou do canal do bot a ser marcado.  
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 1011.  
Obrigatório: Sim

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

A solicitação aceita os dados a seguir no formato JSON.

 ** [tags](#API_TagResource_RequestSyntax) **   <a name="lex-TagResource-request-tags"></a>
A lista de chaves de tag a serem adicionadas a um recurso. Se uma chave de tag já existir, o valor existente será substituído pelo novo valor.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: sim

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

```
HTTP/1.1 204
```

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

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 204 com um corpo HTTP vazio.

## Erros
<a name="API_TagResource_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

 ** ConflictException **   
 Houve um conflito ao processar a solicitação. Tente sua solicitação novamente.   
Código de Status HTTP: 409

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

# UntagResource
<a name="API_UntagResource"></a>

Remove as tags de um bot, alias de bot ou canal de bot.

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

```
DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1
```

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

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

 ** [resourceArn](#API_UntagResource_RequestSyntax) **   <a name="lex-UntagResource-request-uri-resourceArn"></a>
O nome do recurso da Amazon (ARN) do recurso do qual remover as tags.  
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 1011.  
Obrigatório: Sim

 ** [tagKeys](#API_UntagResource_RequestSyntax) **   <a name="lex-UntagResource-request-uri-tagKeys"></a>
Uma lista de chaves de tag a serem removidas do recurso. Se uma chave de tag não existir no recurso, ela será ignorada.  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 128.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

```
HTTP/1.1 204
```

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

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 204 com um corpo HTTP vazio.

## Erros
<a name="API_UntagResource_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

 ** ConflictException **   
 Houve um conflito ao processar a solicitação. Tente sua solicitação novamente.   
Código de Status HTTP: 409

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

# Serviço de runtime do Amazon Lex
<a name="API_Operations_Amazon_Lex_Runtime_Service"></a>

As seguintes ações são compatíveis com o Serviço de runtime do Amazon Lex:
+  [DeleteSession](API_runtime_DeleteSession.md) 
+  [GetSession](API_runtime_GetSession.md) 
+  [PostContent](API_runtime_PostContent.md) 
+  [PostText](API_runtime_PostText.md) 
+  [PutSession](API_runtime_PutSession.md) 

# DeleteSession
<a name="API_runtime_DeleteSession"></a>

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

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

```
DELETE /bot/botName/alias/botAlias/user/userId/session HTTP/1.1
```

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

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

 ** [botAlias](#API_runtime_DeleteSession_RequestSyntax) **   <a name="lex-runtime_DeleteSession-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_DeleteSession_RequestSyntax) **   <a name="lex-runtime_DeleteSession-request-uri-botName"></a>
O nome do bot que contém os dados da sessão.  
Obrigatório: Sim

 ** [userId](#API_runtime_DeleteSession_RequestSyntax) **   <a name="lex-runtime_DeleteSession-request-uri-userId"></a>
O identificador do usuário associado aos dados da sessão.  
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_DeleteSession_RequestBody"></a>

Essa solicitação não tem corpo.

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

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

{
   "botAlias": "string",
   "botName": "string",
   "sessionId": "string",
   "userId": "string"
}
```

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

 ** [botAlias](#API_runtime_DeleteSession_ResponseSyntax) **   <a name="lex-runtime_DeleteSession-response-botAlias"></a>
O alias em uso para o bot associado aos dados da sessão.  
Tipo: string

 ** [botName](#API_runtime_DeleteSession_ResponseSyntax) **   <a name="lex-runtime_DeleteSession-response-botName"></a>
O nome do bot associado aos dados de sessão.  
Tipo: string

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

 ** [userId](#API_runtime_DeleteSession_ResponseSyntax) **   <a name="lex-runtime_DeleteSession-response-userId"></a>
O ID do usuário do aplicativo cliente.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 2. Comprimento máximo de 100.  
Padrão: `[0-9a-zA-Z._:-]+` 

## Erros
<a name="API_runtime_DeleteSession_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

 ** ConflictException **   
 Dois clientes estão usando a mesma conta da AWS, o bot do Amazon Lex e o mesmo ID de usuário.   
Código de Status HTTP: 409

 ** 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_DeleteSession_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/DeleteSession) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/runtime.lex-2016-11-28/DeleteSession) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/DeleteSession) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/runtime.lex-2016-11-28/DeleteSession) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/DeleteSession) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/runtime.lex-2016-11-28/DeleteSession) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/runtime.lex-2016-11-28/DeleteSession) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/runtime.lex-2016-11-28/DeleteSession) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/runtime.lex-2016-11-28/DeleteSession) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/DeleteSession) 

# 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) 

# PostContent
<a name="API_runtime_PostContent"></a>

 Envia a entrada do usuário (texto ou fala) ao Amazon Lex. Os clientes usam essa API para enviar solicitações de texto e áudio para o Amazon Lex em runtime. O Amazon Lex interpreta a entrada do usuário usando o modelo de machine learning criado para o bot. 

A operação `PostContent` oferece suporte a entrada de áudio em 8 kHz e 16 kHz. Você pode usar áudio de 8 kHz para obter maior precisão de reconhecimento de fala em aplicativos de áudio de telefone. 

 Em resposta, o Amazon Lex retorna a próxima mensagem para transmitir ao usuário. Considere as seguintes mensagens de exemplo: 
+  Para uma entrada do usuário “Eu gostaria de uma pizza”, o Amazon Lex pode retornar uma resposta com uma mensagem gerando dados do slot (por exemplo, `PizzaSize`): “Qual tamanho de pizza você gostaria?”. 
+  Depois que o usuário fornece todas as informações do pedido de pizza, o Amazon Lex pode retornar uma resposta com uma mensagem para obter a confirmação do usuário: “Pedir a pizza?”. 
+  Depois que o usuário responder “Sim” ao prompt de confirmação, o Amazon Lex poderá retornar uma declaração de conclusão: “Obrigado, sua pizza de queijo foi pedida.”. 

 Nem todas as mensagens do Amazon Lex exigem uma resposta do usuário. Por exemplo, declarações de conclusão não exigem uma resposta. Algumas mensagens exigem apenas uma resposta sim ou não. Além do `message`, o Amazon Lex fornece contexto adicional sobre a mensagem na resposta que você pode usar para aprimorar o comportamento do cliente, como exibir a interface de usuário apropriada do cliente. Considere os seguintes exemplos: 
+  Se a mensagem for para obter dados de slots, o Amazon Lex retornará as seguintes informações de contexto: 
  +  cabeçalho `x-amz-lex-dialog-state` definido como `ElicitSlot` 
  +  cabeçalho `x-amz-lex-intent-name` definido com o nome da intenção no contexto atual 
  +  cabeçalho `x-amz-lex-slot-to-elicit` definido com o nome do slot para o qual `message` está obtendo informações 
  +  cabeçalho `x-amz-lex-slots` definido como um mapa de slots configurados para a intenção com seus valores atuais 
+  Se a mensagem for um prompt de confirmação, o cabeçalho `x-amz-lex-dialog-state` será definido como `Confirmation` e o cabeçalho `x-amz-lex-slot-to-elicit` será omitido. 
+  Se a mensagem for um prompt de esclarecimento configurado para a intenção, indicando que a intenção do usuário não foi compreendida, o cabeçalho `x-amz-dialog-state` será definido como `ElicitIntent` e o cabeçalho `x-amz-slot-to-elicit` será omitido. 

 Além disso, o Amazon Lex também retorna seu aplicativo específico`sessionAttributes`. Para obter mais informações, consulte [Gerenciar o contexto de conversação](https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html). 

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

```
POST /bot/botName/alias/botAlias/user/userId/content HTTP/1.1
x-amz-lex-session-attributes: sessionAttributes
x-amz-lex-request-attributes: requestAttributes
Content-Type: contentType
Accept: accept
x-amz-lex-active-contexts: activeContexts

inputStream
```

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

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

 ** [accept](#API_runtime_PostContent_RequestSyntax) **   <a name="lex-runtime_PostContent-request-accept"></a>
 Você passa este valor como o cabeçalho HTTP `Accept`.   
 A mensagem que o Amazon Lex retorna na resposta pode ser texto ou fala com base no valor do cabeçalho HTTP `Accept` na solicitação.   
+  Se o valor for `text/plain; charset=utf-8`, o Amazon Lex retornará o texto na resposta. 
+  Se o valor começar com `audio/`, o Amazon Lex retornará a fala na resposta. O Amazon Lex usa o Amazon Polly para gerar a fala (usando a configuração especificada no cabeçalho `Accept`). Por exemplo, se você especificar `audio/mpeg` como valor, o Amazon Lex retornará a fala no formato MPEG.
+ Se o valor for `audio/pcm`, a fala retornada está `audio/pcm` no formato little-endian de 16 bits. 
+ Os valores aceitos são os seguintes:
  + audio/mpeg
  + audio/ogg
  + audio/pcm
  + text/plain; charset=utf-8
  + audio/\$1 (o padrão é mpeg)

 ** [activeContexts](#API_runtime_PostContent_RequestSyntax) **   <a name="lex-runtime_PostContent-request-activeContexts"></a>
Uma lista de contextos ativos para a solicitação. Um contexto pode ser ativado quando uma intenção anterior é atendida ou incluindo o contexto na solicitação,  
Se você não especificar uma lista de contextos, o Amazon Lex usará a lista atual de contextos para a sessão. Se você especificar uma lista vazia, todos os contextos da sessão serão apagados.

 ** [botAlias](#API_runtime_PostContent_RequestSyntax) **   <a name="lex-runtime_PostContent-request-uri-botAlias"></a>
Alias do bot Amazon Lex.  
Obrigatório: Sim

 ** [botName](#API_runtime_PostContent_RequestSyntax) **   <a name="lex-runtime_PostContent-request-uri-botName"></a>
Nome do bot do Amazon Lex.  
Obrigatório: Sim

 ** [contentType](#API_runtime_PostContent_RequestSyntax) **   <a name="lex-runtime_PostContent-request-contentType"></a>
 Você passa este valor como o cabeçalho HTTP `Content-Type`.   
 Indica o formato de áudio ou texto. O valor do cabeçalho deve começar com um dos seguintes prefixos:   
+ No formato PCM, os dados de áudio devem estar na ordem de bytes little-endian.
  + audio/l16; rate=16000; channels=1
  + audio/x-l16; sample-rate=16000; channel-count=1
  + áudio/lpcm; taxa de amostragem = 8000; = 16; contagem de canais = 1; = falso sample-size-bits is-big-endian 
+ Formato Opus
  + áudio/ x-cbr-opus-with -preâmbulo; tamanho do preâmbulo = 0; taxa de bits = 256000; =4 frame-size-milliseconds
+ Formato de texto
  + text/plain; charset=utf-8
Obrigatório: Sim

 ** [requestAttributes](#API_runtime_PostContent_RequestSyntax) **   <a name="lex-runtime_PostContent-request-requestAttributes"></a>
Você passa este valor como o cabeçalho HTTP `x-amz-lex-request-attributes`.  
Informações específicas da solicitação passadas entre o Amazon Lex e um aplicativo cliente. O valor deve ser um mapa serializado JSON e codificado em base64 com chaves e valores de string. O tamanho total dos cabeçalhos `requestAttributes` e `sessionAttributes` está limitado a 12 KB.  
O namespace `x-amz-lex:` é reservado para atributos especiais. Não crie atributos de solicitação com o prefixo `x-amz-lex:`.  
Para obter mais informações, consulte [Definição de atributos de solicitação](https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs).

 ** [sessionAttributes](#API_runtime_PostContent_RequestSyntax) **   <a name="lex-runtime_PostContent-request-sessionAttributes"></a>
Você passa este valor como o cabeçalho HTTP `x-amz-lex-session-attributes`.  
Informações específicas do aplicativo passadas entre o Amazon Lex e um aplicativo cliente. O valor deve ser um mapa serializado JSON e codificado em base64 com chaves e valores de string. O tamanho total dos cabeçalhos `sessionAttributes` e `requestAttributes` está limitado a 12 KB.  
Para obter mais informações, consulte [Definição de atributos de sessão](https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs).

 ** [userId](#API_runtime_PostContent_RequestSyntax) **   <a name="lex-runtime_PostContent-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. No runtime, cada solicitação deve conter o campo `userID`.  
Para decidir o ID de usuário a ser usado em seu aplicativo, considere os seguintes fatores.  
+ O campo `userID` não deve conter nenhuma informação de identificação pessoal do usuário, por exemplo, nome, números de identificação pessoal ou outras informações pessoais do usuário final.
+ Se você quiser que um usuário inicie uma conversa em um dispositivo e continue em outro, use um identificador específico do usuário.
+ Se você quiser que o mesmo usuário possa ter duas conversas independentes em dois dispositivos diferentes, escolha um identificador específico do dispositivo.
+ Um usuário não pode ter duas conversas independentes com duas versões diferentes do mesmo bot. Por exemplo, um usuário não pode conversar com as versões PROD e BETA do mesmo bot. Se você prevê que um usuário precisará conversar com duas versões diferentes, por exemplo, durante o teste, inclua o alias do bot no ID do usuário para separar as duas conversas.
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_PostContent_RequestBody"></a>

A solicitação aceita os dados binários a seguir.

 ** [inputStream](#API_runtime_PostContent_RequestSyntax) **   <a name="lex-runtime_PostContent-request-inputStream"></a>
 Entrada do usuário no formato de áudio PCM ou Opus ou formato de texto, conforme descrito no cabeçalho HTTP `Content-Type`.   
Você pode transmitir dados de áudio para o Amazon Lex ou criar um buffer local que capture todos os dados de áudio antes do envio. Em geral, você obtém melhor desempenho se transmitir dados de áudio em vez de armazenar os dados em buffer localmente.  
Obrigatório: sim

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

```
HTTP/1.1 200
Content-Type: contentType
x-amz-lex-intent-name: intentName
x-amz-lex-nlu-intent-confidence: nluIntentConfidence
x-amz-lex-alternative-intents: alternativeIntents
x-amz-lex-slots: slots
x-amz-lex-session-attributes: sessionAttributes
x-amz-lex-sentiment: sentimentResponse
x-amz-lex-message: message
x-amz-lex-encoded-message: encodedMessage
x-amz-lex-message-format: messageFormat
x-amz-lex-dialog-state: dialogState
x-amz-lex-slot-to-elicit: slotToElicit
x-amz-lex-input-transcript: inputTranscript
x-amz-lex-encoded-input-transcript: encodedInputTranscript
x-amz-lex-bot-version: botVersion
x-amz-lex-session-id: sessionId
x-amz-lex-active-contexts: activeContexts

audioStream
```

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

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

A resposta retorna os cabeçalhos HTTP a seguir.

 ** [activeContexts](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-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.

 ** [alternativeIntents](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-alternativeIntents"></a>
Uma a quatro intenções alternativas que podem ser aplicáveis à intenção do usuário.  
Cada alternativa inclui uma pontuação que indica o grau de confiança do Amazon Lex de que a intenção corresponde à intenção do usuário. As intenções são classificadas pela pontuação de confiança.

 ** [botVersion](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-botVersion"></a>
A versão do bot que respondeu à conversa. Você pode usar essas informações para ajudar a determinar se uma versão de um bot tem um desempenho melhor do que outra versão.  
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 64.  
Padrão: `[0-9]+|\$LATEST` 

 ** [contentType](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-contentType"></a>
Tipo de conteúdo conforme especificado no cabeçalho HTTP `Accept` na solicitação.

 ** [dialogState](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-dialogState"></a>
Identifica o estado atual da interação do usuário. O Amazon Lex retorna um dos seguintes valores como `dialogState`. Opcionalmente, o cliente pode usar essas informações para personalizar a interface do usuário.   
+  `ElicitIntent` - O Amazon Lex quer obter a intenção do usuário. Considere os seguintes exemplos: 

   Por exemplo, um usuário pode expressar uma intenção (“Quero pedir uma pizza”). Se o Amazon Lex não puder deduzir a intenção do usuário a partir dessa declaração, ele retornará esse estado de diálogo. 
+  `ConfirmIntent` - O Amazon Lex espera uma resposta “sim” ou “não”. 

  Por exemplo, o Amazon Lex quer a confirmação do usuário antes de atender uma intenção. Em vez de uma simples resposta de “sim” ou “não”, um usuário pode responder com informações adicionais. Por exemplo, “sim, mas peça uma pizza de massa grossa” ou “não, quero pedir uma bebida”. O Amazon Lex pode processar essas informações adicionais (nesses exemplos, atualizar o slot do tipo de crosta ou alterar a intenção de OrderPizza para OrderDrink). 
+  `ElicitSlot` - O Amazon Lex espera o valor de um slot para a intenção atual. 

   Por exemplo, suponha que, na resposta, o Amazon Lex envie esta mensagem: “Qual tamanho de pizza você gostaria?”. Um usuário pode responder com o valor de slot (por exemplo, “média”). O usuário também pode fornecer informações adicionais na resposta (por exemplo, “pizza média de massa grossa”). O Amazon Lex pode processar essas informações adicionais de forma adequada. 
+  `Fulfilled` - Transmite que a função do Lambda atendeu com sucesso a intenção. 
+  `ReadyForFulfillment` - Transmite que o cliente deve atender à solicitação. 
+  `Failed` - Transmite que a conversa com o usuário falhou. 

   Isso pode acontecer por vários motivos, incluindo o fato de o usuário não fornecer uma resposta adequada aos prompts do serviço (você pode configurar quantas vezes o Amazon Lex pode solicitar informações específicas a um usuário) ou se a função do Lambda não atender à intenção. 
Valores válidos: `ElicitIntent | ConfirmIntent | ElicitSlot | Fulfilled | ReadyForFulfillment | Failed` 

 ** [encodedInputTranscript](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-encodedInputTranscript"></a>
O texto usado para processar a solicitação.  
Se a entrada tiver sido um fluxo de áudio, o campo `encodedInputTranscript` conterá o texto extraído do fluxo de áudio. Esse é o texto que é processado para reconhecer as intenções e os valores de slot. Você pode usar essas informações para determinar se o Amazon Lex está processando corretamente o áudio que você envia.  
O campo `encodedInputTranscript` é codificado em base 64. Você deve decodificar o campo antes de poder usar o valor.

 ** [encodedMessage](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-encodedMessage"></a>
A mensagem a ser transmitida ao usuário. A mensagem pode vir da configuração do bot ou de uma função do Lambda.  
Se a intenção não estiver configurada com uma função do Lambda, ou se a função do Lambda tiver retornado `Delegate` como `dialogAction.type` em sua resposta, o Amazon Lex decide o próximo curso de ação e seleciona uma mensagem apropriada da configuração do bot com base no contexto de interação atual. Por exemplo, se o Amazon Lex não conseguir entender a entrada do usuário, ele usa uma mensagem de prompt de esclarecimento.  
Ao criar uma intenção, você pode atribuir mensagens a grupos. Quando as mensagens são atribuídas a grupos, o Amazon Lex retorna uma mensagem de cada grupo na resposta. O campo de mensagem é uma string JSON de escape que contém as mensagens. Para obter mais informações sobre a estrutura da string JSON retornada, consulte [Formatos de mensagem suportados](howitworks-manage-prompts.md#msg-prompts-formats).  
Se a função do Lambda retornar uma mensagem, o Amazon Lex a enviará para o cliente em sua resposta.  
O campo `encodedMessage` é codificado em base 64. Você deve decodificar o campo antes de poder usar o valor.  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.366.

 ** [inputTranscript](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-inputTranscript"></a>
 *Esse cabeçalho foi descontinuado.*   
O texto usado para processar a solicitação.  
Você pode usar esse campo somente nas localidades de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR e it-IT. Em todas as outras localidades, o campo `inputTranscript` é nulo. Em vez disso, use o campo `encodedInputTranscript`.  
Se a entrada tiver sido um fluxo de áudio, o campo `inputTranscript` conterá o texto extraído do fluxo de áudio. Esse é o texto que é processado para reconhecer as intenções e os valores de slot. Você pode usar essas informações para determinar se o Amazon Lex está processando corretamente o áudio que você envia.

 ** [intentName](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-intentName"></a>
Intenção atual do usuário que o Amazon Lex conhece.

 ** [message](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-message"></a>
 *Esse cabeçalho foi descontinuado.*   
Você só pode usar esse campo nas localidades de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR e it-IT. Em todas as outras localidades, o campo `message` é nulo. Em vez disso, use o campo `encodedMessage`.  
A mensagem a ser transmitida ao usuário. A mensagem pode vir da configuração do bot ou de uma função do Lambda.  
Se a intenção não estiver configurada com uma função do Lambda, ou se a função do Lambda tiver retornado `Delegate` como `dialogAction.type` em sua resposta, o Amazon Lex decide o próximo curso de ação e seleciona uma mensagem apropriada da configuração do bot com base no contexto de interação atual. Por exemplo, se o Amazon Lex não conseguir entender a entrada do usuário, ele usa uma mensagem de prompt de esclarecimento.  
Ao criar uma intenção, você pode atribuir mensagens a grupos. Quando as mensagens são atribuídas a grupos, o Amazon Lex retorna uma mensagem de cada grupo na resposta. O campo de mensagem é uma string JSON de escape que contém as mensagens. Para obter mais informações sobre a estrutura da string JSON retornada, consulte [Formatos de mensagem suportados](howitworks-manage-prompts.md#msg-prompts-formats).  
Se a função do Lambda retornar uma mensagem, o Amazon Lex a enviará para o cliente em sua resposta.  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.024.

 ** [messageFormat](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-messageFormat"></a>
O formato da mensagem de resposta. Um dos seguintes valores:  
+  `PlainText` - A mensagem contém texto sem formatação UTF-8.
+  `CustomPayload` - A mensagem é um formato personalizado para o cliente.
+  `SSML` - A mensagem contém texto formatado para saída de voz.
+  `Composite` - A mensagem contém um objeto JSON de escape que contém uma ou mais mensagens dos grupos aos quais as mensagens foram atribuídas quando a intenção foi criada.
Valores válidos: `PlainText | CustomPayload | SSML | Composite` 

 ** [nluIntentConfidence](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-nluIntentConfidence"></a>
Fornece uma pontuação que indica o quanto o Amazon Lex tem certeza de que a intenção retornada é aquela que corresponde à intenção do usuário. A pontuação está entre 0,0 e 1,0.  
A pontuação é relativa, não absoluta. A pontuação pode mudar com base nas melhorias no Amazon Lex. 

 ** [sentimentResponse](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-sentimentResponse"></a>
O sentimento expresso em uma declaração.  
Quando o bot está configurado para enviar declarações ao Amazon Comprehend para análise de sentimentos, esse campo contém o resultado da análise.

 ** [sessionAttributes](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-sessionAttributes"></a>
 Mapa de key/value pares representando as informações de contexto específicas da sessão. 

 ** [sessionId](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-sessionId"></a>
O identificador exclusivo da sessão.

 ** [slots](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-slots"></a>
Mapa de zero ou mais slots de intenção (pares de chaves/valores) do Amazon Lex detectados na entrada do usuário durante a conversação. O campo é codificado em base 64.  
O Amazon Lex cria uma lista de resolução que contém valores prováveis para um slot. O valor que ele retorna é determinado pelo `valueSelectionStrategy` selecionado quando o tipo de slot foi criado ou atualizado. Se `valueSelectionStrategy` for definido como `ORIGINAL_VALUE`, o valor fornecido pelo usuário será retornado, se o valor do usuário for semelhante ao valor de slot. Se `valueSelectionStrategy` estiver definido como `TOP_RESOLUTION`, o Amazon Lex retornará o primeiro valor na lista de resolução ou, se não houver lista de resolução, nulo. Se `valueSelectionStrategy` não for especificado, o padrão será `ORIGINAL_VALUE`.

 ** [slotToElicit](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-slotToElicit"></a>
 Se o valor `dialogState` for `ElicitSlot`, retornará o nome do slot para o qual o Amazon Lex está obtendo um valor. 

A resposta retorna as informações a seguir como corpo HTTP.

 ** [audioStream](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-audioStream"></a>
O prompt (ou declaração) a ser transmitido ao usuário. Isso se baseia na configuração e no contexto do bot. Por exemplo, se o Amazon Lex não entender a intenção do usuário, ele envia o `clarificationPrompt` configurado para o bot. Se a intenção exigir confirmação antes de realizar a ação de atendimento, ela envia o `confirmationPrompt`. Outro exemplo: suponha que a função do Lambda tenha atendido com sucesso a intenção e enviado uma mensagem para transmitir ao usuário. Em seguida, o Amazon Lex envia essa mensagem na resposta. 

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

 ** BadGatewayException **   
Ou o bot do Amazon Lex ainda está sendo construído ou um dos serviços dependentes (Amazon Polly, AWS Lambda) falhou com um erro interno de serviço.  
Código de status HTTP: 502

 ** 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

 ** ConflictException **   
 Dois clientes estão usando a mesma conta da AWS, o bot do Amazon Lex e o mesmo ID de usuário.   
Código de Status HTTP: 409

 ** DependencyFailedException **   
 Uma das dependências, como AWS Lambda ou Amazon Polly, gerou uma exceção. Por exemplo,   
+ Se o Amazon Lex não tiver permissões suficientes para chamar uma função do Lambda.
+ Se uma função do Lambda levar mais de 30 segundos para ser executada.
+ Se uma função do Lambda de atendimento retornar uma ação `Delegate` de diálogo sem remover nenhum valor de slot.
Código de status HTTP: 424

 ** 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

 ** LoopDetectedException **   
Essa exceção não é usada.  
Código de status HTTP: 508

 ** NotAcceptableException **   
O cabeçalho de aceitação na solicitação não tem um valor válido.  
Código de status HTTP: 406

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

 ** RequestTimeoutException **   
A fala de entrada é muito longa.  
Código de status HTTP: 408

 ** UnsupportedMediaTypeException **   
O cabeçalho Content-Type (API `PostContent`) tem um valor inválido.   
Código de status HTTP: 415

## Exemplos
<a name="API_runtime_PostContent_Examples"></a>

### Exemplo 1
<a name="API_runtime_PostContent_Example_1"></a>

 Nessa solicitação, o URI identifica um bot (Tráfego), uma versão do bot (\$1LATEST) e um nome de usuário final (someuser). O cabeçalho `Content-Type` identifica o formato do áudio no corpo. O Amazon Lex também oferece suporte a outros formatos. Para converter áudio de um formato para outro, se necessário, você pode usar o software de código aberto SoX. Você especifica o formato no qual deseja obter a resposta adicionando o cabeçalho HTTP `Accept`. 

 Na resposta, o cabeçalho `x-amz-lex-message` mostra a resposta que o Amazon Lex retornou. O cliente pode então enviar essa resposta ao usuário. A mesma mensagem é enviada em audio/MPEG formato por meio de codificação em partes (conforme solicitado). 

#### Exemplo de solicitação
<a name="API_runtime_PostContent_Example_1_Request"></a>

```
"POST /bot/Traffic/alias/$LATEST/user/someuser/content HTTP/1.1[\r][\n]"
"x-amz-lex-session-attributes: eyJ1c2VyTmFtZSI6IkJvYiJ9[\r][\n]"
"Content-Type: audio/x-l16; channel-count=1; sample-rate=16000f[\r][\n]"
"Accept: audio/mpeg[\r][\n]"
"Host: runtime.lex.us-east-1.amazonaws.com[\r][\n]"
"Authorization: AWS4-HMAC-SHA256 Credential=BLANKED_OUT/20161230/us-east-1/lex/aws4_request, 
SignedHeaders=accept;content-type;host;x-amz-content-sha256;x-amz-date;x-amz-lex-session-attributes, Signature=78ca5b54ea3f64a17ff7522de02cd90a9acd2365b45a9ce9b96ea105bb1c7ec2[\r][\n]"
"X-Amz-Date: 20161230T181426Z[\r][\n]"
"X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855[\r][\n]"
"Transfer-Encoding: chunked[\r][\n]"
"Connection: Keep-Alive[\r][\n]"
"User-Agent: Apache-HttpClient/4.5.x (Java/1.8.0_112)[\r][\n]"
"Accept-Encoding: gzip,deflate[\r][\n]"
"[\r][\n]"
"1000[\r][\n]"
"[0x7][0x0][0x7][0x0][\n]"
"[0x0][0x7][0x0][0xfc][0xff][\n]"
"[0x0][\n]"
…
```

#### Resposta da amostra
<a name="API_runtime_PostContent_Example_1_Response"></a>

```
"HTTP/1.1 200 OK[\r][\n]"
"x-amzn-RequestId: cc8b34af-cebb-11e6-a35c-55f3a992f28d[\r][\n]"
"x-amz-lex-message: Sorry, can you repeat that?[\r][\n]"
"x-amz-lex-dialog-state: ElicitIntent[\r][\n]"
"x-amz-lex-session-attributes: eyJ1c2VyTmFtZSI6IkJvYiJ9[\r][\n]"
"Content-Type: audio/mpeg[\r][\n]"
"Transfer-Encoding: chunked[\r][\n]"
"Date: Fri, 30 Dec 2016 18:14:28 GMT[\r][\n]"
"[\r][\n]"               
"2000[\r][\n]"
"ID3[0x4][0x0][0x0][0x0][0x0][0x0]#TSSE[0x0][0x0][0x0][0xf][0x0][0x0][0x3]Lavf57.41.100[0x0][0x0][0x0][0x0][0x0][0x0][0x0][0x0][0x0][0x0][0x0][0xff][0xf3]`[0xc4][0x0][0x1b]{[0x8d][0xe8][0x1]C[0x18][0x1][0x0]J[0xe0]`b[0xdd][0xd1][0xb][0xfd][0x11][0xdf][0xfe]";[0xbb][0xbb][0x9f][0xee][0xee][0xee][0xee]|DDD/[0xff][0xff][0xff][0xff]www?D[0xf7]w^?[0xff][0xfa]h[0x88][0x85][0xfe][0x88][0x88][0x88][[0xa2]'[0xff][0xfa]"{[0x9f][0xe8][0x88]]D[0xeb][0xbb][0xbb][0xa2]!u[0xfd][0xdd][0xdf][0x88][0x94][0x0]F[0xef][0xa1]8[0x0][0x82]w[0x88]N[0x0][0x0][0x9b][0xbb][0xe8][0xe
…
```

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

# PostText
<a name="API_runtime_PostText"></a>

Envia a entrada do usuário ao Amazon Lex. Os aplicativos clientes podem usar essa API para enviar solicitações ao Amazon Lex em runtime. Em seguida, o Amazon Lex interpreta a entrada do usuário usando o modelo de machine learning criado para o bot. 

 Em resposta, o Amazon Lex retorna a próxima `message` para transmitir um `responseCard` opcional ao usuário para exibir. Considere as seguintes mensagens de exemplo: 
+  Para uma entrada do usuário “Eu gostaria de uma pizza”, o Amazon Lex pode retornar uma resposta com uma mensagem gerando dados do slot (por exemplo, PizzaSize): “Qual tamanho de pizza você gostaria?” 
+  Depois que o usuário fornece todas as informações do pedido de pizza, o Amazon Lex pode retornar uma resposta com uma mensagem para obter a confirmação do usuário: “Continuar com o pedido de pizza?”. 
+  Depois que o usuário responder o prompt de confirmação com “Sim”, o Amazon Lex poderá retornar uma declaração de conclusão: “Obrigado, sua pizza de queijo foi pedida.”. 

 Nem todas as mensagens do Amazon Lex exigem uma resposta do usuário. Por exemplo, uma declaração de conclusão não exige uma resposta. Algumas mensagens exigem apenas uma resposta “sim” ou “não” do usuário. Além do `message`, o Amazon Lex fornece contexto adicional sobre a mensagem na resposta que você pode usar para aprimorar o comportamento do cliente, por exemplo, para exibir a interface de usuário apropriada do cliente. Esses são os campos `slotToElicit`, `dialogState`, `intentName` e `slots` na resposta. Considere os seguintes exemplos: 
+ Se a mensagem for para obter dados de slots, o Amazon Lex retornará as seguintes informações de contexto:
  +  `dialogState`definido como ElicitSlot 
  +  `intentName` definido como o nome da intenção no contexto atual 
  +  `slotToElicit` definido como o nome do slot para o qual `message` está obtendo informações 
  +  `slots` definido como um mapa de slots configurados para a intenção com valores atuais conhecidos 
+  Se a mensagem for um prompt de confirmação, o `dialogState` será definido como ConfirmIntent e `SlotToElicit` definido como nulo. 
+ Se a mensagem for um prompt de esclarecimento (configurado para a intenção) que indica que a intenção do usuário não foi compreendida, a `dialogState` é definida como ElicitIntent e definida como `slotToElicit` nula. 

 Além disso, o Amazon Lex também retorna seu aplicativo específico`sessionAttributes`. Para obter mais informações, consulte [Gerenciar o contexto de conversação](https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html). 

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

```
POST /bot/botName/alias/botAlias/user/userId/text HTTP/1.1
Content-type: application/json

{
   "activeContexts": [ 
      { 
         "name": "string",
         "parameters": { 
            "string" : "string" 
         },
         "timeToLive": { 
            "timeToLiveInSeconds": number,
            "turnsToLive": number
         }
      }
   ],
   "inputText": "string",
   "requestAttributes": { 
      "string" : "string" 
   },
   "sessionAttributes": { 
      "string" : "string" 
   }
}
```

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

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

 ** [botAlias](#API_runtime_PostText_RequestSyntax) **   <a name="lex-runtime_PostText-request-uri-botAlias"></a>
O alias do bot do Amazon Lex.  
Obrigatório: Sim

 ** [botName](#API_runtime_PostText_RequestSyntax) **   <a name="lex-runtime_PostText-request-uri-botName"></a>
O nome do bot do Amazon Lex.  
Obrigatório: Sim

 ** [userId](#API_runtime_PostText_RequestSyntax) **   <a name="lex-runtime_PostText-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. No runtime, cada solicitação deve conter o campo `userID`.  
Para decidir o ID de usuário a ser usado em seu aplicativo, considere os seguintes fatores.  
+ O campo `userID` não deve conter nenhuma informação de identificação pessoal do usuário, por exemplo, nome, números de identificação pessoal ou outras informações pessoais do usuário final.
+ Se você quiser que um usuário inicie uma conversa em um dispositivo e continue em outro, use um identificador específico do usuário.
+ Se você quiser que o mesmo usuário possa ter duas conversas independentes em dois dispositivos diferentes, escolha um identificador específico do dispositivo.
+ Um usuário não pode ter duas conversas independentes com duas versões diferentes do mesmo bot. Por exemplo, um usuário não pode conversar com as versões PROD e BETA do mesmo bot. Se você prevê que um usuário precisará conversar com duas versões diferentes, por exemplo, durante o teste, inclua o alias do bot no ID do usuário para separar as duas conversas.
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_PostText_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [activeContexts](#API_runtime_PostText_RequestSyntax) **   <a name="lex-runtime_PostText-request-activeContexts"></a>
Uma lista de contextos ativos para a solicitação. Um contexto pode ser ativado quando uma intenção anterior é atendida ou incluindo o contexto na solicitação,  
Se você não especificar uma lista de contextos, o Amazon Lex usará a lista atual de contextos para a sessão. Se você especificar uma lista vazia, todos os contextos da sessão serão apagados.  
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.  
Obrigatório: não

 ** [inputText](#API_runtime_PostText_RequestSyntax) **   <a name="lex-runtime_PostText-request-inputText"></a>
O texto que o usuário inseriu (o Amazon Lex interpreta esse texto).  
Ao usar a AWS CLI, você não pode passar uma URL no parâmetro `--input-text`. Em vez disso, passe o URL usando o parâmetro `--cli-input-json`.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.024.  
Obrigatório: Sim

 ** [requestAttributes](#API_runtime_PostText_RequestSyntax) **   <a name="lex-runtime_PostText-request-requestAttributes"></a>
Informações específicas da solicitação passadas entre o Amazon Lex e um aplicativo cliente.  
O namespace `x-amz-lex:` é reservado para atributos especiais. Não crie atributos de solicitação com o prefixo `x-amz-lex:`.  
Para obter mais informações, consulte [Definição de atributos de solicitação](https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs).  
Tipo: mapa de string para string  
Obrigatório: não

 ** [sessionAttributes](#API_runtime_PostText_RequestSyntax) **   <a name="lex-runtime_PostText-request-sessionAttributes"></a>
Informações específicas do aplicativo passadas entre o Amazon Lex e um aplicativo cliente.  
Para obter mais informações, consulte [Definição de atributos de sessão](https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs).  
Tipo: mapa de string para string  
Obrigatório: Não

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

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

{
   "activeContexts": [ 
      { 
         "name": "string",
         "parameters": { 
            "string" : "string" 
         },
         "timeToLive": { 
            "timeToLiveInSeconds": number,
            "turnsToLive": number
         }
      }
   ],
   "alternativeIntents": [ 
      { 
         "intentName": "string",
         "nluIntentConfidence": { 
            "score": number
         },
         "slots": { 
            "string" : "string" 
         }
      }
   ],
   "botVersion": "string",
   "dialogState": "string",
   "intentName": "string",
   "message": "string",
   "messageFormat": "string",
   "nluIntentConfidence": { 
      "score": number
   },
   "responseCard": { 
      "contentType": "string",
      "genericAttachments": [ 
         { 
            "attachmentLinkUrl": "string",
            "buttons": [ 
               { 
                  "text": "string",
                  "value": "string"
               }
            ],
            "imageUrl": "string",
            "subTitle": "string",
            "title": "string"
         }
      ],
      "version": "string"
   },
   "sentimentResponse": { 
      "sentimentLabel": "string",
      "sentimentScore": "string"
   },
   "sessionAttributes": { 
      "string" : "string" 
   },
   "sessionId": "string",
   "slots": { 
      "string" : "string" 
   },
   "slotToElicit": "string"
}
```

## Elementos de resposta
<a name="API_runtime_PostText_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_PostText_ResponseSyntax) **   <a name="lex-runtime_PostText-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.

 ** [alternativeIntents](#API_runtime_PostText_ResponseSyntax) **   <a name="lex-runtime_PostText-response-alternativeIntents"></a>
Uma a quatro intenções alternativas que podem ser aplicáveis à intenção do usuário.  
Cada alternativa inclui uma pontuação que indica o grau de confiança do Amazon Lex de que a intenção corresponde à intenção do usuário. As intenções são classificadas pela pontuação de confiança.  
Tipo: matriz de objetos [PredictedIntent](API_runtime_PredictedIntent.md)  
Membros da matriz: número máximo de 4 itens.

 ** [botVersion](#API_runtime_PostText_ResponseSyntax) **   <a name="lex-runtime_PostText-response-botVersion"></a>
A versão do bot que respondeu à conversa. Você pode usar essas informações para ajudar a determinar se uma versão de um bot tem um desempenho melhor do que outra versão.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 64.  
Padrão: `[0-9]+|\$LATEST` 

 ** [dialogState](#API_runtime_PostText_ResponseSyntax) **   <a name="lex-runtime_PostText-response-dialogState"></a>
 Identifica o estado atual da interação do usuário. O Amazon Lex retorna um dos seguintes valores como `dialogState`. Opcionalmente, o cliente pode usar essas informações para personalizar a interface do usuário.   
+  `ElicitIntent` - O Amazon Lex quer obter a intenção do usuário. 

  Por exemplo, um usuário pode expressar uma intenção (“Quero pedir uma pizza”). Se o Amazon Lex não puder deduzir a intenção do usuário a partir dessa declaração, ele retornará esse dialogState.
+  `ConfirmIntent` - O Amazon Lex espera uma resposta “sim” ou “não”. 

   Por exemplo, o Amazon Lex quer a confirmação do usuário antes de atender uma intenção. 

  Em vez de um “sim” ou “não”, um usuário pode responder com informações adicionais. Por exemplo, “sim, mas peça uma pizza de massa grossa” ou “não, quero pedir uma bebida”. O Amazon Lex pode processar essas informações adicionais (nesses exemplos, atualizar o valor do slot do tipo de crosta ou alterar a intenção de OrderPizza para OrderDrink).
+  `ElicitSlot` - O Amazon Lex espera um valor de slot para a intenção atual. 

  Por exemplo, suponha que, na resposta, o Amazon Lex envie esta mensagem: “Qual tamanho de pizza você gostaria?”. Um usuário pode responder com o valor de slot (por exemplo, “média”). O usuário também pode fornecer informações adicionais na resposta (por exemplo, “pizza média de massa grossa”). O Amazon Lex pode processar essas informações adicionais de forma adequada. 
+  `Fulfilled` - Transmite que a função do Lambda configurada para a intenção atendeu com sucesso a intenção. 
+  `ReadyForFulfillment` - Transmite que o cliente deve atender à solicitação. 
+  `Failed` - Transmite que a conversa com o usuário falhou. 

   Isso pode acontecer por vários motivos, incluindo o fato de o usuário não ter fornecido uma resposta adequada aos prompts do serviço (você pode configurar quantas vezes o Amazon Lex pode solicitar informações específicas a um usuário) ou se a função do Lambda não atendeu à intenção. 
Tipo: String  
Valores válidos: `ElicitIntent | ConfirmIntent | ElicitSlot | Fulfilled | ReadyForFulfillment | Failed` 

 ** [intentName](#API_runtime_PostText_ResponseSyntax) **   <a name="lex-runtime_PostText-response-intentName"></a>
A intenção atual do usuário que o Amazon Lex conhece.  
Tipo: String

 ** [message](#API_runtime_PostText_ResponseSyntax) **   <a name="lex-runtime_PostText-response-message"></a>
A mensagem a ser transmitida ao usuário. A mensagem pode vir da configuração do bot ou de uma função do Lambda.  
Se a intenção não estiver configurada com uma função do Lambda, ou se a função do Lambda tiver retornado `Delegate` como `dialogAction.type` em sua resposta, o Amazon Lex decide o próximo curso de ação e seleciona uma mensagem apropriada da configuração do bot com base no contexto de interação atual. Por exemplo, se o Amazon Lex não conseguir entender a entrada do usuário, ele usa uma mensagem de prompt de esclarecimento.  
Ao criar uma intenção, você pode atribuir mensagens a grupos. Quando as mensagens são atribuídas a grupos, o Amazon Lex retorna uma mensagem de cada grupo na resposta. O campo de mensagem é uma string JSON de escape que contém as mensagens. Para obter mais informações sobre a estrutura da string JSON retornada, consulte [Formatos de mensagem suportados](howitworks-manage-prompts.md#msg-prompts-formats).  
Se a função do Lambda retornar uma mensagem, o Amazon Lex a enviará para o cliente em sua resposta.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.024.

 ** [messageFormat](#API_runtime_PostText_ResponseSyntax) **   <a name="lex-runtime_PostText-response-messageFormat"></a>
O formato da mensagem de resposta. Um dos seguintes valores:  
+  `PlainText` - A mensagem contém texto sem formatação UTF-8.
+  `CustomPayload` - A mensagem é um formato personalizado definido pela função do Lambda.
+  `SSML` - A mensagem contém texto formatado para saída de voz.
+  `Composite` - A mensagem contém um objeto JSON de escape que contém uma ou mais mensagens dos grupos aos quais as mensagens foram atribuídas quando a intenção foi criada.
Tipo: String  
Valores válidos: `PlainText | CustomPayload | SSML | Composite` 

 ** [nluIntentConfidence](#API_runtime_PostText_ResponseSyntax) **   <a name="lex-runtime_PostText-response-nluIntentConfidence"></a>
Fornece uma pontuação que indica o quanto o Amazon Lex tem certeza de que a intenção retornada é aquela que corresponde à intenção do usuário. A pontuação está entre 0,0 e 1,0. Para obter mais informações, consulte [Pontuações de confiança](https://docs.aws.amazon.com/lex/latest/dg/confidence-scores.html).  
A pontuação é relativa, não absoluta. A pontuação pode mudar com base nas melhorias no Amazon Lex.  
Tipo: objeto [IntentConfidence](API_runtime_IntentConfidence.md)

 ** [responseCard](#API_runtime_PostText_ResponseSyntax) **   <a name="lex-runtime_PostText-response-responseCard"></a>
Representa as opções que o usuário tem para responder ao prompt atual. O cartão de resposta pode vir da configuração do bot (no console Amazon Lex, escolha o botão de configurações ao lado de um slot) ou de um hook de código (função do Lambda).   
Tipo: objeto [ResponseCard](API_runtime_ResponseCard.md)

 ** [sentimentResponse](#API_runtime_PostText_ResponseSyntax) **   <a name="lex-runtime_PostText-response-sentimentResponse"></a>
O sentimento expresso em uma declaração.  
Quando o bot está configurado para enviar declarações ao Amazon Comprehend para análise de sentimentos, esse campo contém o resultado da análise.  
Tipo: objeto [SentimentResponse](API_runtime_SentimentResponse.md)

 ** [sessionAttributes](#API_runtime_PostText_ResponseSyntax) **   <a name="lex-runtime_PostText-response-sessionAttributes"></a>
Um mapa de pares de chaves/valores que representam as informações de contexto específicas da sessão.  
Tipo: mapa de string para string

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

 ** [slots](#API_runtime_PostText_ResponseSyntax) **   <a name="lex-runtime_PostText-response-slots"></a>
 Os slots de intenção que o Amazon Lex detectou a partir da entrada do usuário na conversa.   
O Amazon Lex cria uma lista de resolução que contém valores prováveis para um slot. O valor que ele retorna é determinado pelo `valueSelectionStrategy` selecionado quando o tipo de slot foi criado ou atualizado. Se `valueSelectionStrategy` for definido como `ORIGINAL_VALUE`, o valor fornecido pelo usuário será retornado, se o valor do usuário for semelhante ao valor de slot. Se `valueSelectionStrategy` estiver definido como `TOP_RESOLUTION`, o Amazon Lex retornará o primeiro valor na lista de resolução ou, se não houver lista de resolução, nulo. Se `valueSelectionStrategy` não for especificado, o padrão será `ORIGINAL_VALUE`.  
Tipo: mapa de string para string

 ** [slotToElicit](#API_runtime_PostText_ResponseSyntax) **   <a name="lex-runtime_PostText-response-slotToElicit"></a>
Se o valor `dialogState` for `ElicitSlot`, retornará o nome do slot para o qual o Amazon Lex está obtendo um valor.   
Tipo: string

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

 ** BadGatewayException **   
Ou o bot do Amazon Lex ainda está sendo construído ou um dos serviços dependentes (Amazon Polly, AWS Lambda) falhou com um erro interno de serviço.  
Código de status HTTP: 502

 ** 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

 ** ConflictException **   
 Dois clientes estão usando a mesma conta da AWS, o bot do Amazon Lex e o mesmo ID de usuário.   
Código de Status HTTP: 409

 ** DependencyFailedException **   
 Uma das dependências, como AWS Lambda ou Amazon Polly, gerou uma exceção. Por exemplo,   
+ Se o Amazon Lex não tiver permissões suficientes para chamar uma função do Lambda.
+ Se uma função do Lambda levar mais de 30 segundos para ser executada.
+ Se uma função do Lambda de atendimento retornar uma ação `Delegate` de diálogo sem remover nenhum valor de slot.
Código de status HTTP: 424

 ** 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

 ** LoopDetectedException **   
Essa exceção não é usada.  
Código de status HTTP: 508

 ** 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_PostText_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/PostText) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/runtime.lex-2016-11-28/PostText) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/PostText) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/runtime.lex-2016-11-28/PostText) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/PostText) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/runtime.lex-2016-11-28/PostText) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/runtime.lex-2016-11-28/PostText) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/runtime.lex-2016-11-28/PostText) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/runtime.lex-2016-11-28/PostText) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/PostText) 

# PutSession
<a name="API_runtime_PutSession"></a>

Cria uma nova sessão ou modifica uma sessão existente com um bot do Amazon Lex. Use essa operação para permitir que seu aplicativo defina o estado do bot.

Para obter mais informações, consulte [Gerenciamento de sessões](https://docs.aws.amazon.com/lex/latest/dg/how-session-api.html).

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

```
POST /bot/botName/alias/botAlias/user/userId/session HTTP/1.1
Accept: accept
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" 
   }
}
```

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

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

 ** [accept](#API_runtime_PutSession_RequestSyntax) **   <a name="lex-runtime_PutSession-request-accept"></a>
A mensagem que o Amazon Lex retorna na resposta pode ser texto ou fala dependendo do valor deste campo.  
+ Se o valor for `text/plain; charset=utf-8`, o Amazon Lex retornará o texto na resposta.
+ Se o valor começar com `audio/`, o Amazon Lex retornará a fala na resposta. O Amazon Lex usa o Amazon Polly para gerar a fala na configuração que você especificar. Por exemplo, se você especificar `audio/mpeg` como valor, o Amazon Lex retornará a fala no formato MPEG.
+ Se o valor for `audio/pcm`, a fala será retornada como `audio/pcm` no formato little-endian de 16 bits.
+ Os valores aceitos são os seguintes:
  +  `audio/mpeg` 
  +  `audio/ogg` 
  +  `audio/pcm` 
  +  `audio/*` (o padrão é mpeg)
  +  `text/plain; charset=utf-8` 

 ** [botAlias](#API_runtime_PutSession_RequestSyntax) **   <a name="lex-runtime_PutSession-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_PutSession_RequestSyntax) **   <a name="lex-runtime_PutSession-request-uri-botName"></a>
O nome do bot que contém os dados da sessão.  
Obrigatório: Sim

 ** [userId](#API_runtime_PutSession_RequestSyntax) **   <a name="lex-runtime_PutSession-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_PutSession_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [activeContexts](#API_runtime_PutSession_RequestSyntax) **   <a name="lex-runtime_PutSession-request-activeContexts"></a>
Uma lista de contextos ativos para a solicitação. Um contexto pode ser ativado quando uma intenção anterior é atendida ou incluindo o contexto na solicitação,  
Se você não especificar uma lista de contextos, o Amazon Lex usará a lista atual de contextos para a sessão. Se você especificar uma lista vazia, todos os contextos da sessão serão apagados.  
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.  
Obrigatório: não

 ** [dialogAction](#API_runtime_PutSession_RequestSyntax) **   <a name="lex-runtime_PutSession-request-dialogAction"></a>
Define a próxima ação que o bot deve realizar para atender a conversa.  
Tipo: objeto [DialogAction](API_runtime_DialogAction.md)  
Obrigatório: Não

 ** [recentIntentSummaryView](#API_runtime_PutSession_RequestSyntax) **   <a name="lex-runtime_PutSession-request-recentIntentSummaryView"></a>
Um resumo das intenções recentes do bot. Você pode usar a visualização de resumo de intenções para definir um rótulo de ponto de verificação em uma intenção e modificar os atributos das intenções. Você também pode usá-la para remover ou adicionar objetos de resumo de intenção à lista.  
A intenção que você modifica ou adiciona à lista deve fazer sentido para o bot. Por exemplo, o nome da intenção deve ser válida para o bot. Você deve fornecer valores válidos para:  
+  `intentName` 
+ nomes de slot
+  `slotToElict` 
Se você enviar o parâmetro `recentIntentSummaryView` em uma solicitação `PutSession`, o conteúdo da nova visualização de resumo substituirá a antiga visualização de resumo. Por exemplo, se uma solicitação `GetSession` retornar três intenções na exibição de resumo e você chamar `PutSession` com uma intenção na visualização de resumo, a próxima chamada `GetSession` retornará apenas uma intenção.  
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.  
Obrigatório: não

 ** [sessionAttributes](#API_runtime_PutSession_RequestSyntax) **   <a name="lex-runtime_PutSession-request-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  
Obrigatório: Não

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

```
HTTP/1.1 200
Content-Type: contentType
x-amz-lex-intent-name: intentName
x-amz-lex-slots: slots
x-amz-lex-session-attributes: sessionAttributes
x-amz-lex-message: message
x-amz-lex-encoded-message: encodedMessage
x-amz-lex-message-format: messageFormat
x-amz-lex-dialog-state: dialogState
x-amz-lex-slot-to-elicit: slotToElicit
x-amz-lex-session-id: sessionId
x-amz-lex-active-contexts: activeContexts

audioStream
```

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

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

A resposta retorna os cabeçalhos HTTP a seguir.

 ** [activeContexts](#API_runtime_PutSession_ResponseSyntax) **   <a name="lex-runtime_PutSession-response-activeContexts"></a>
Uma lista de contextos ativos para a sessão.

 ** [contentType](#API_runtime_PutSession_ResponseSyntax) **   <a name="lex-runtime_PutSession-response-contentType"></a>
Tipo de conteúdo conforme especificado no cabeçalho HTTP `Accept` na solicitação.

 ** [dialogState](#API_runtime_PutSession_ResponseSyntax) **   <a name="lex-runtime_PutSession-response-dialogState"></a>
  
+  `ConfirmIntent` - O Amazon Lex espera uma resposta “sim” ou “não” para confirmar a intenção antes de atendê-la.
+  `ElicitIntent` - O Amazon Lex quer obter a intenção do usuário.
+  `ElicitSlot` - O Amazon Lex espera o valor de um slot para a intenção atual.
+  `Failed` - Transmite que a conversa com o usuário falhou. Isso pode acontecer por vários motivos, incluindo o usuário não fornecer uma resposta adequada aos prompts do serviço ou a função do Lambda não atender a intenção.
+  `Fulfilled` - Transmite que a função do Lambda atendeu com sucesso a intenção.
+  `ReadyForFulfillment` - Transmite que o cliente deve atender à solicitação.
Valores válidos: `ElicitIntent | ConfirmIntent | ElicitSlot | Fulfilled | ReadyForFulfillment | Failed` 

 ** [encodedMessage](#API_runtime_PutSession_ResponseSyntax) **   <a name="lex-runtime_PutSession-response-encodedMessage"></a>
A próxima mensagem que deve ser apresentada ao usuário.  
O campo `encodedMessage` é codificado em base 64. Você deve decodificar o campo antes de poder usar o valor.  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.366.

 ** [intentName](#API_runtime_PutSession_ResponseSyntax) **   <a name="lex-runtime_PutSession-response-intentName"></a>
O nome da intenção atual.

 ** [message](#API_runtime_PutSession_ResponseSyntax) **   <a name="lex-runtime_PutSession-response-message"></a>
 *Esse cabeçalho foi descontinuado.*   
A próxima mensagem que deve ser apresentada ao usuário.  
Você só pode usar esse campo nas localidades de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR e it-IT. Em todas as outras localidades, o campo `message` é nulo. Em vez disso, use o campo `encodedMessage`.  
Restrições de comprimento: tamanho mínimo de 1. Tamanho máximo de 1.024.

 ** [messageFormat](#API_runtime_PutSession_ResponseSyntax) **   <a name="lex-runtime_PutSession-response-messageFormat"></a>
O formato da mensagem de resposta. Um dos seguintes valores:  
+  `PlainText` - A mensagem contém texto sem formatação UTF-8.
+  `CustomPayload` - A mensagem é um formato personalizado para o cliente.
+  `SSML` - A mensagem contém texto formatado para saída de voz.
+  `Composite` - A mensagem contém um objeto JSON de escape que contém uma ou mais mensagens dos grupos aos quais as mensagens foram atribuídas quando a intenção foi criada.
Valores válidos: `PlainText | CustomPayload | SSML | Composite` 

 ** [sessionAttributes](#API_runtime_PutSession_ResponseSyntax) **   <a name="lex-runtime_PutSession-response-sessionAttributes"></a>
Mapa de key/value pares representando informações de contexto específicas da sessão.

 ** [sessionId](#API_runtime_PutSession_ResponseSyntax) **   <a name="lex-runtime_PutSession-response-sessionId"></a>
Um identificador exclusivo da sessão.

 ** [slots](#API_runtime_PutSession_ResponseSyntax) **   <a name="lex-runtime_PutSession-response-slots"></a>
Mapa de zero ou mais slots de intenção do Amazon Lex detectados na entrada do usuário durante a conversação.  
O Amazon Lex cria uma lista de resolução que contém valores prováveis para um slot. O valor que ele retorna é determinado pelo `valueSelectionStrategy` selecionado quando o tipo de slot foi criado ou atualizado. Se `valueSelectionStrategy` for definido como `ORIGINAL_VALUE`, o valor fornecido pelo usuário será retornado, se o valor do usuário for semelhante ao valor de slot. Se `valueSelectionStrategy` estiver definido como `TOP_RESOLUTION`, o Amazon Lex retornará o primeiro valor na lista de resolução ou, se não houver lista de resolução, nulo. Se `valueSelectionStrategy` não for especificado, o padrão será `ORIGINAL_VALUE`. 

 ** [slotToElicit](#API_runtime_PutSession_ResponseSyntax) **   <a name="lex-runtime_PutSession-response-slotToElicit"></a>
Se o `dialogState` for `ElicitSlot`, retornará o nome do slot para o qual o Amazon Lex está obtendo um valor.

A resposta retorna as informações a seguir como corpo HTTP.

 ** [audioStream](#API_runtime_PutSession_ResponseSyntax) **   <a name="lex-runtime_PutSession-response-audioStream"></a>
A versão em áudio da mensagem a ser transmitida ao usuário.

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

 ** BadGatewayException **   
Ou o bot do Amazon Lex ainda está sendo construído ou um dos serviços dependentes (Amazon Polly, AWS Lambda) falhou com um erro interno de serviço.  
Código de status HTTP: 502

 ** 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

 ** ConflictException **   
 Dois clientes estão usando a mesma conta da AWS, o bot do Amazon Lex e o mesmo ID de usuário.   
Código de Status HTTP: 409

 ** DependencyFailedException **   
 Uma das dependências, como AWS Lambda ou Amazon Polly, gerou uma exceção. Por exemplo,   
+ Se o Amazon Lex não tiver permissões suficientes para chamar uma função do Lambda.
+ Se uma função do Lambda levar mais de 30 segundos para ser executada.
+ Se uma função do Lambda de atendimento retornar uma ação `Delegate` de diálogo sem remover nenhum valor de slot.
Código de status HTTP: 424

 ** 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

 ** NotAcceptableException **   
O cabeçalho de aceitação na solicitação não tem um valor válido.  
Código de status HTTP: 406

 ** 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_PutSession_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/PutSession) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/runtime.lex-2016-11-28/PutSession) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/PutSession) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/runtime.lex-2016-11-28/PutSession) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/PutSession) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/runtime.lex-2016-11-28/PutSession) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/runtime.lex-2016-11-28/PutSession) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/runtime.lex-2016-11-28/PutSession) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/runtime.lex-2016-11-28/PutSession) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/PutSession) 