Skip to content

CreateBotAliasRequest

Source code in docs_src/capo_lex_models_v2/types/create_bot_alias_request.py
class CreateBotAliasRequest(TypedDict, closed=True):
    bot_alias_name: "capo_lex_models_v2.types.name.Name"
    """<p>The alias to create. The name must be unique for the bot.</p>"""
    description: NotRequired["capo_lex_models_v2.types.description.Description"]
    """<p>A description of the alias. Use this description to help identify the alias.</p>"""
    bot_version: NotRequired[
        "capo_lex_models_v2.types.numerical_bot_version.NumericalBotVersion"
    ]
    """<p>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.</p>"""
    bot_alias_locale_settings: NotRequired[
        "capo_lex_models_v2.types.bot_alias_locale_settings_map.BotAliasLocaleSettingsMap"
    ]
    """<p>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.</p>"""
    conversation_log_settings: NotRequired[
        "capo_lex_models_v2.types.conversation_log_settings.ConversationLogSettings"
    ]
    """<p>Specifies whether Amazon Lex logs text and audio for a conversation with the bot. When you enable conversation logs, text logs store text input, transcripts of audio input, and associated metadata in Amazon CloudWatch Logs. Audio logs store audio input in Amazon S3.</p>"""
    sentiment_analysis_settings: NotRequired[
        "capo_lex_models_v2.types.sentiment_analysis_settings.SentimentAnalysisSettings"
    ]
    bot_id: "capo_lex_models_v2.types.id.Id"
    """<p>The unique identifier of the bot that the alias applies to.</p>"""
    tags: NotRequired["capo_lex_models_v2.types.tag_map.TagMap"]
    """<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>UpdateBotAlias</code> operation to update the tags on a bot alias. To update tags, use the <code>TagResource</code> operation.</p>"""

bot_alias_locale_settings instance-attribute

bot_alias_locale_settings: NotRequired[BotAliasLocaleSettingsMap]

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.

bot_alias_name instance-attribute

bot_alias_name: Name

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

bot_id instance-attribute

bot_id: Id

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

bot_version instance-attribute

bot_version: NotRequired[NumericalBotVersion]

The version of the bot that this alias points to. You can use the UpdateBotAlias operation to change the bot version associated with the alias.

conversation_log_settings instance-attribute

conversation_log_settings: NotRequired[ConversationLogSettings]

Specifies whether Amazon Lex logs text and audio for a conversation with the bot. When you enable conversation logs, text logs store text input, transcripts of audio input, and associated metadata in Amazon CloudWatch Logs. Audio logs store audio input in Amazon S3.

description instance-attribute

description: NotRequired[Description]

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

sentiment_analysis_settings instance-attribute

sentiment_analysis_settings: NotRequired[SentimentAnalysisSettings]

tags instance-attribute

tags: NotRequired[TagMap]

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