Skip to content

PutBotAliasRequest

Source code in docs_src/capo_lex_model_building_service/types/put_bot_alias_request.py
class PutBotAliasRequest(TypedDict, closed=True):
    name: "capo_lex_model_building_service.types.alias_name.AliasName"
    """<p>The name of the alias. The name is <i>not</i> case sensitive.</p>"""
    description: NotRequired[
        "capo_lex_model_building_service.types.description.Description"
    ]
    """<p>A description of the alias.</p>"""
    bot_version: "capo_lex_model_building_service.types.version.Version"
    """<p>The version of the bot.</p>"""
    bot_name: "capo_lex_model_building_service.types.bot_name.BotName"
    """<p>The name of the bot.</p>"""
    checksum: NotRequired["capo_lex_model_building_service.types.string.String"]
    """<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>"""
    conversation_logs: NotRequired[
        "capo_lex_model_building_service.types.conversation_logs_request.ConversationLogsRequest"
    ]
    """<p>Settings for conversation logs for the alias.</p>"""
    tags: NotRequired["capo_lex_model_building_service.types.tag_list.TagList"]
    """<p>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>PutBotAlias</code> operation to update the tags on a bot alias. To update tags, use the <code>TagResource</code> operation.</p>"""

bot_name instance-attribute

bot_name: BotName

The name of the bot.

bot_version instance-attribute

bot_version: Version

The version of the bot.

checksum instance-attribute

checksum: NotRequired[String]

Identifies a specific revision of the $LATEST version.

When you create a new bot alias, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.

When you want to update a bot alias, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.

conversation_logs instance-attribute

conversation_logs: NotRequired[ConversationLogsRequest]

Settings for conversation logs for the alias.

description instance-attribute

description: NotRequired[Description]

A description of the alias.

name instance-attribute

name: AliasName

The name of the alias. The name is not case sensitive.

tags instance-attribute

tags: NotRequired[TagList]

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 PutBotAlias operation to update the tags on a bot alias. To update tags, use the TagResource operation.