Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14107861793.8 KB

Provides metadata about a version of a bot.

get/bots/{botId}/botversions/{botVersion}/

Path parameters

botIdstring required

The identifier of the bot containing the version to return metadata for.

botVersionstring required

The version of the bot to return metadata for.

Response

Success

botIdstring

The identifier of the bot that contains the version.

botNamestring

The name of the bot that contains the version.

botVersionstring

The version of the bot that was described.

descriptionstring

The description specified for the bot.

roleArnstring

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

idleSessionTTLInSecondsinteger

The number of seconds that a session with the bot remains active before it is discarded by Amazon Lex.

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

The current status of the bot. When the status is <code>Available</code>, the bot version is ready for use.

failureReasonsFailureReason[]

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

creationDateTimestring date-time

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

botType'Bot' | 'BotNetwork'

The type of the bot in the version that was described.