Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14107861793.8 KB

Provides metadata information about a bot.

get/bots/{botId}/

Path parameters

botIdstring required

The unique identifier of the bot to describe.

Response

Success

botIdstring

The unique identifier of the bot.

botNamestring

The name of the bot.

descriptionstring

The description of the bot.

roleArnstring

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

idleSessionTTLInSecondsinteger

The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.

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

The current status of the bot. When the status is <code>Available</code> the bot is ready to be used in conversations with users.

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 described.

failureReasonsFailureReason[]

If the <code>botStatus</code> is <code>Failed</code>, this contains a list of reasons that the bot couldn't be built.