Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1442228254.5 KB

Returns metadata information for a specific bot. You must provide the bot name and the bot version or alias.

This operation requires permissions for the lex:GetBot action.

get/bots/{name}/versions/{versionoralias}

Path parameters

namestring required

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

versionoraliasstring required

The version or alias of the bot.

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'
<p>The status of the bot. </p> <p>When the status is <code>BUILDING</code> Amazon Lex is building the bot for testing and use.</p> <p>If the status of the bot is <code>READY_BASIC_TESTING</code>, you can test the bot using the exact utterances specified in the bot's intents. When the bot is ready for full testing or to run, the status is <code>READY</code>.</p> <p>If there was a problem with building the bot, the status is <code>FAILED</code> and the <code>failureReason</code> field explains why the bot did not build.</p> <p>If the bot was saved but not built, the status is <code>NOT_BUILT</code>.</p>
failureReasonstring

If <code>status</code> is <code>FAILED</code>, Amazon Lex explains why 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 time in seconds 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 used to identify a specific revision of the bot's <code>$LATEST</code> version.

versionstring

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

locale'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'

The target locale for the bot.

childDirectedboolean
<p>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 <b>is</b> 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 <b>is not</b> 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.</p> <p>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> </p>
detectSentimentboolean

Indicates whether user utterances should be sent to Amazon Comprehend for sentiment analysis.

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