Put botsnameversionsdollarlatest — lex-models

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1442228254.5 KB

Creates an Amazon Lex conversational bot or replaces an existing bot. When you create or update a bot you are only required to specify a name, a locale, and whether the bot is directed toward children under age 13. You can use this to add intents later, or to remove intents from an existing bot. When you create a bot with the minimum information, the bot is created or updated but Amazon Lex returns the response `FAILED`. You can build the bot after you add one or more intents. For more information about Amazon Lex bots, see how-it-works.

If you specify the name of an existing bot, the fields in the request replace the existing values in the `$LATEST` version of the bot. Amazon Lex removes any fields that you don't provide values for in the request, except for the `idleTTLInSeconds` and `privacySettings` fields, which are set to their default values. If you don't specify values for required fields, Amazon Lex throws an exception. This operation requires permissions for the `lex:PutBot` action. For more information, see security-iam.

put/bots/{name}/versions/$LATEST

Path parameters

namestring required

The name of the bot. The name is not case sensitive.

Request body

descriptionstring

A description of the bot.

enableModelImprovementsboolean

Set to <code>true</code> to enable access to natural language understanding improvements. When you set the <code>enableModelImprovements</code> parameter to <code>true</code> you can use the <code>nluIntentConfidenceThreshold</code> parameter to configure confidence scores. For more information, see <a href="https://docs.aws.amazon.com/lex/latest/dg/confidence-scores.html">Confidence Scores</a>. You can only set the <code>enableModelImprovements</code> parameter in certain Regions. If you set the parameter to <code>true</code>, your bot has access to accuracy improvements. The Regions where you can set the <code>enableModelImprovements</code> parameter to <code>true</code> are: <ul> <li> US East (N. Virginia) (us-east-1) </li> <li> US West (Oregon) (us-west-2) </li> <li> Asia Pacific (Sydney) (ap-southeast-2) </li> <li> EU (Ireland) (eu-west-1) </li> </ul> In other Regions, the <code>enableModelImprovements</code> parameter is set to <code>true</code> by default. In these Regions setting the parameter to <code>false</code> throws a <code>ValidationException</code> exception.

nluIntentConfidenceThresholdnumber double

Determines the threshold where Amazon Lex will insert the <code>AMAZON.FallbackIntent</code>, <code>AMAZON.KendraSearchIntent</code>, or both when returning alternative intents in a <a href="https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html">PostContent</a> or <a href="https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html">PostText</a> response. <code>AMAZON.FallbackIntent</code> and <code>AMAZON.KendraSearchIntent</code> are only inserted if they are configured for the bot. You must set the <code>enableModelImprovements</code> parameter to <code>true</code> to use confidence scores in the following regions. <ul> <li> US East (N. Virginia) (us-east-1) </li> <li> US West (Oregon) (us-west-2) </li> <li> Asia Pacific (Sydney) (ap-southeast-2) </li> <li> EU (Ireland) (eu-west-1) </li> </ul> In other Regions, the <code>enableModelImprovements</code> parameter is set to <code>true</code> by default. For example, suppose a bot is configured with the confidence threshold of 0.80 and the <code>AMAZON.FallbackIntent</code>. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the <code>PostText</code> operation would be: <ul> <li> AMAZON.FallbackIntent </li> <li> IntentA </li> <li> IntentB </li> <li> IntentC </li> </ul>

idleSessionTTLInSecondsinteger

The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. A user interaction session remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout. For example, suppose that a user chooses the OrderPizza intent, but gets sidetracked halfway through placing an order. If the user doesn't complete the order within the specified time, Amazon Lex discards the slot information that it gathered, and the user must start over. If you don't include the <code>idleSessionTTLInSeconds</code> element in a <code>PutBot</code> operation request, Amazon Lex uses the default value. This is also true if the request replaces an existing bot. The default is 300 seconds (5 minutes).

voiceIdstring

The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user. The locale configured for the voice must match the locale of the bot. For more information, see <a href="https://docs.aws.amazon.com/polly/latest/dg/voicelist.html">Voices in Amazon Polly</a> in the Amazon Polly Developer Guide.

checksumstring

Identifies a specific revision of the <code>$LATEST</code> version. When you create a new bot, leave the <code>checksum</code> field blank. If you specify a checksum you get a <code>BadRequestException</code> exception. When you want to update a bot, set the <code>checksum</code> field to the checksum of the most recent revision of the <code>$LATEST</code> version. If you don't specify the <code> checksum</code> field, or if the checksum does not match the <code>$LATEST</code> version, you get a <code>PreconditionFailedException</code> exception.

processBehavior'SAVE' | 'BUILD'

If you set the <code>processBehavior</code> element to <code>BUILD</code>, Amazon Lex builds the bot so that it can be run. If you set the element to <code>SAVE</code> Amazon Lex saves the bot, but doesn't build it. If you don't specify this value, the default value is <code>BUILD</code>.

Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot. The default is <code>en-US</code>.

childDirectedboolean required

For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying <code>true</code> or <code>false</code> in the <code>childDirected</code> field. By specifying <code>true</code> in the <code>childDirected</code> field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying <code>false</code> in the <code>childDirected</code> field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the <code>childDirected</code> field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the <a href="https://aws.amazon.com/lex/faqs#data-security">Amazon Lex FAQ.</a>

detectSentimentboolean

When set to <code>true</code> user utterances are sent to Amazon Comprehend for sentiment analysis. If you don't specify <code>detectSentiment</code>, the default is <code>false</code>.

createVersionboolean

When set to <code>true</code> a new numbered version of the bot is created. This is the same as calling the <code>CreateBotVersion</code> operation. If you don't specify <code>createVersion</code>, the default is <code>false</code>.

Response

Success

namestring

The name of the bot.

descriptionstring

A description of the bot.

enableModelImprovementsboolean

Indicates whether the bot uses accuracy improvements. <code>true</code> indicates that the bot is using the improvements, otherwise, <code>false</code>.

nluIntentConfidenceThresholdnumber double

The score that determines where Amazon Lex inserts the <code>AMAZON.FallbackIntent</code>, <code>AMAZON.KendraSearchIntent</code>, or both when returning alternative intents in a <a href="https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html">PostContent</a> or <a href="https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html">PostText</a> response. <code>AMAZON.FallbackIntent</code> is inserted if the confidence score for all intents is below this value. <code>AMAZON.KendraSearchIntent</code> is only inserted if it is configured for the bot.

status'BUILDING' | 'READY' | 'READY_BASIC_TESTING' | 'FAILED' | 'NOT_BUILT'

When you send a request to create a bot with <code>processBehavior</code> set to <code>BUILD</code>, Amazon Lex sets the <code>status</code> response element to <code>BUILDING</code>. In the <code>READY_BASIC_TESTING</code> state you can test the bot with user inputs that exactly match the utterances configured for the bot's intents and values in the slot types. If Amazon Lex can't build the bot, Amazon Lex sets <code>status</code> to <code>FAILED</code>. Amazon Lex returns the reason for the failure in the <code>failureReason</code> response element. When you set <code>processBehavior</code> to <code>SAVE</code>, Amazon Lex sets the status code to <code>NOT BUILT</code>. When the bot is in the <code>READY</code> state you can test and publish the bot.

failureReasonstring

If <code>status</code> is <code>FAILED</code>, Amazon Lex provides the reason that it failed to build the bot.

lastUpdatedDatestring date-time

The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.

createdDatestring date-time

The date that the bot was created.

idleSessionTTLInSecondsinteger

The maximum length of time that Amazon Lex retains the data gathered in a conversation. For more information, see <a>PutBot</a>.

voiceIdstring

The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see <a>PutBot</a>.

checksumstring

Checksum of the bot that you created.

versionstring

The version of the bot. For a new bot, the version is always <code>$LATEST</code>.

The target locale for the bot.

childDirectedboolean

createVersionboolean

<code>True</code> if a new version of the bot was created. If the <code>createVersion</code> field was not specified in the request, the <code>createVersion</code> field is set to false in the response.

detectSentimentboolean

<code>true</code> if the bot is configured to send user utterances to Amazon Comprehend for sentiment analysis. If the <code>detectSentiment</code> field was not specified in the request, the <code>detectSentiment</code> field is <code>false</code> in the response.

Example response

{
  "version": "$LATEST",
  "name": "DocOrderPizzaBot",
  "abortStatement": {
    "messages": [
      {
        "content": "I don't understand. Can you try again?",
        "contentType": "PlainText"
      },
      {
        "content": "I'm sorry, I don't understand.",
        "contentType": "PlainText"
      }
    ]
  },
  "checksum": "20172ee3-fa06-49b2-bbc5-667c090303e9",
  "childDirected": true,
  "clarificationPrompt": {
    "maxAttempts": 1,
    "messages": [
      {
        "content": "I'm sorry, I didn't hear that. Can you repeate what you just said?",
        "contentType": "PlainText"
      },
      {
        "content": "Can you say that again?",
        "contentType": "PlainText"
      }
    ]
  },
  "createdDate": 1494360160.133,
  "description": "Orders a pizza from a local pizzeria.",
  "idleSessionTTLInSeconds": 300,
  "intents": [
    {
      "intentName": "DocOrderPizza",
      "intentVersion": "$LATEST"
    }
  ],
  "lastUpdatedDate": 1494360160.133,
  "locale": "en-US",
  "status": "NOT_BUILT"
}