Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14107861793.8 KB

Updates the configuration of an existing bot.

put/bots/{botId}/

Path parameters

botIdstring required

The unique identifier of the bot to update. This identifier is returned by the <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateBot.html">CreateBot</a> operation.

Request body

botNamestring required

The new name of the bot. The name must be unique in the account that creates the bot.

descriptionstring

A description of the bot.

roleArnstring required

The Amazon Resource Name (ARN) of an IAM role that has permissions to access the bot.

idleSessionTTLInSecondsinteger required
<p>The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.</p> <p>A user interaction 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.</p> <p>You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.</p>
botType'Bot' | 'BotNetwork'

The type of the bot to be updated.

Response

Success

botIdstring

The unique identifier of the bot that was updated.

botNamestring

The name of the bot after the update.

descriptionstring

The description of the bot after the update.

roleArnstring

The Amazon Resource Name (ARN) of the IAM role used by the bot after the update.

idleSessionTTLInSecondsinteger

The session timeout, in seconds, for the bot after the update.

botStatus'Creating' | 'Available' | 'Inactive' | 'Deleting' | 'Failed' | 'Versioning' | 'Importing' | 'Updating'

Shows the current status of the bot. The bot is first in the <code>Creating</code> status. Once the bot is read for use, it changes to the <code>Available</code> status. After the bot is created, you can use the <code>DRAFT</code> version of the bot.

creationDateTimestring date-time

A timestamp of the date and time that the bot was created.

lastUpdatedDateTimestring date-time

A timestamp of the date and time that the bot was last updated.

botType'Bot' | 'BotNetwork'

The type of the bot that was updated.