Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1471501483.8 KB

Creates an alias for the specified version of a bot. Use an alias to enable you to change the version of a bot without updating applications that use the bot.

For example, you can create an alias called "PROD" that your applications use to call the Amazon Lex bot.

put/bots/{botId}/botaliases/

Path parameters

botIdstring required

The unique identifier of the bot that the alias applies to.

Request body

botAliasNamestring required

The alias to create. The name must be unique for the bot.

descriptionstring

A description of the alias. Use this description to help identify the alias.

botVersionstring

The version of the bot that this alias points to. You can use the <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_UpdateBotAlias.html">UpdateBotAlias</a> operation to change the bot version associated with the alias.

botAliasLocaleSettingsobject

Maps configuration information to a specific locale. You can use this parameter to specify a specific Lambda function to run different functions in different locales.

tagsobject

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

Response

Success

botAliasIdstring

The unique identifier of the bot alias.

botAliasNamestring

The name specified for the bot alias.

descriptionstring

The description specified for the bot alias.

botVersionstring

The version of the bot associated with this alias.

botAliasLocaleSettingsobject

Configuration information for a specific locale.

botAliasStatus'Creating' | 'Available' | 'Deleting' | 'Failed'

The current status of the alias. The alias is first put into the <code>Creating</code> state. When the alias is ready to be used, it is put into the <code>Available</code> state. You can use the <code>DescribeBotAlias</code> operation to get the current state of an alias.

botIdstring

The unique identifier of the bot that this alias applies to.

creationDateTimestring date-time

A Unix timestamp indicating the date and time that the bot alias was created.

tagsobject

A list of tags associated with the bot alias.