Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1471501483.8 KB

Creates an Amazon Lex conversational bot.

put/bots/

Request body

botNamestring required

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

descriptionstring

A description of the bot. It appears in lists to help you identify a particular bot.

roleArnstring required

The Amazon Resource Name (ARN) of an IAM role that has permission 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>
botTagsobject

A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the <code>UpdateBot</code> operation to update tags. To update tags, use the <code>TagResource</code> operation.

testBotAliasTagsobject

A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can't use the <code>UpdateAlias</code> operation to update tags. To update tags on the test alias, use the <code>TagResource</code> operation.

botType'Bot' | 'BotNetwork'

The type of a bot to create.

Response

Success

botIdstring

A unique identifier for a particular bot. You use this to identify the bot when you call other Amazon Lex API operations.

botNamestring

The name specified for the bot.

descriptionstring

The description specified for the bot.

roleArnstring

The IAM role specified for the bot.

idleSessionTTLInSecondsinteger

The session idle time specified for the bot.

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 indicating the date and time that the bot was created.

botTagsobject

A list of tags associated with the bot.

testBotAliasTagsobject

A list of tags associated with the test alias for the bot.

botType'Bot' | 'BotNetwork'

The type of a bot that was created.