Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1442228254.5 KB

Creates an alias for the specified version of the bot or replaces an alias for the specified bot. To change the version of the bot that the alias points to, replace the alias. For more information about aliases, see versioning-aliases.

This operation requires permissions for the lex:PutBotAlias action.

put/bots/{botName}/aliases/{name}

Path parameters

namestring required

The name of the alias. The name is <i>not</i> case sensitive.

botNamestring required

The name of the bot.

Request body

descriptionstring

A description of the alias.

botVersionstring required

The version of the bot.

checksumstring
<p>Identifies a specific revision of the <code>$LATEST</code> version.</p> <p>When you create a new bot alias, leave the <code>checksum</code> field blank. If you specify a checksum you get a <code>BadRequestException</code> exception.</p> <p>When you want to update a bot alias, set the <code>checksum</code> field to the checksum of the most recent revision of the <code>$LATEST</code> version. If you don't specify the <code> checksum</code> field, or if the checksum does not match the <code>$LATEST</code> version, you get a <code>PreconditionFailedException</code> exception.</p>

Response

Success

namestring

The name of the alias.

descriptionstring

A description of the alias.

botVersionstring

The version of the bot that the alias points to.

botNamestring

The name of the bot that the alias points to.

lastUpdatedDatestring date-time

The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.

createdDatestring date-time

The date that the bot alias was created.

checksumstring

The checksum for the current version of the alias.