Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1442228254.5 KB

Creates a new version of the bot based on the $LATEST version. If the $LATEST version of this resource hasn't changed since you created the last version, Amazon Lex doesn't create a new version. It returns the last created version.

You can update only the $LATEST version of the bot. You can't update the numbered versions that you create with the CreateBotVersion operation.

When you create the first version of a bot, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro.

This operation requires permission for the lex:CreateBotVersion action.

post/bots/{name}/versions

Path parameters

namestring required

The name of the bot that you want to create a new version of. The name is case sensitive.

Request body

checksumstring

Identifies a specific revision of the <code>$LATEST</code> version of the bot. If you specify a checksum and the <code>$LATEST</code> version of the bot has a different checksum, a <code>PreconditionFailedException</code> exception is returned and Amazon Lex doesn't publish a new version. If you don't specify a checksum, Amazon Lex publishes the <code>$LATEST</code> version.

Response

Success

namestring

The name of the bot.

descriptionstring

A description of the bot.

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

When you send a request to create or update a bot, Amazon Lex sets the <code>status</code> response element to <code>BUILDING</code>. After Amazon Lex builds the bot, it sets <code>status</code> to <code>READY</code>. If Amazon Lex can't build the bot, it sets <code>status</code> to <code>FAILED</code>. Amazon Lex returns the reason for the failure in the <code>failureReason</code> response element.

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 when the <code>$LATEST</code> version of this bot was updated.

createdDatestring date-time

The date when the bot version 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 interactions with the user.

checksumstring

Checksum identifying the version of the bot that was created.

versionstring

The version of the bot.

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'

Specifies 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>
enableModelImprovementsboolean

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

detectSentimentboolean

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

All 42 operations