Skip to content

UpdateBotRequest

Source code in docs_src/capo_lex_models_v2/types/update_bot_request.py
class UpdateBotRequest(TypedDict, closed=True):
    bot_id: "capo_lex_models_v2.types.id.Id"
    """<p>The unique identifier of the bot to update. This identifier is returned by the <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateBot.html">CreateBot</a> operation.</p>"""
    bot_name: "capo_lex_models_v2.types.name.Name"
    """<p>The new name of the bot. The name must be unique in the account that creates the bot.</p>"""
    description: NotRequired["capo_lex_models_v2.types.description.Description"]
    """<p>A description of the bot.</p>"""
    role_arn: "capo_lex_models_v2.types.role_arn.RoleArn"
    """<p>The Amazon Resource Name (ARN) of an IAM role that has permissions to access the bot.</p>"""
    data_privacy: "capo_lex_models_v2.types.data_privacy.DataPrivacy"
    """<p>Provides information on additional privacy protections Amazon Lex should use with the bot's data.</p>"""
    idle_session_ttl_in_seconds: "capo_lex_models_v2.types.session_ttl.SessionTTL"
    """<p>The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.</p> <p>A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.</p> <p>You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.</p>"""
    bot_type: NotRequired["capo_lex_models_v2.types.bot_type.BotType"]
    """<p>The type of the bot to be updated.</p>"""
    bot_members: NotRequired["capo_lex_models_v2.types.bot_members.BotMembers"]
    """<p>The list of bot members in the network associated with the update action.</p>"""
    error_log_settings: NotRequired[
        "capo_lex_models_v2.types.error_log_settings.ErrorLogSettings"
    ]
    """<p>Allows you to modify how Amazon Lex logs errors during bot interactions, including destinations for error logs and the types of errors to be captured.</p>"""

bot_id instance-attribute

bot_id: Id

The unique identifier of the bot to update. This identifier is returned by the CreateBot operation.

bot_members instance-attribute

bot_members: NotRequired[BotMembers]

The list of bot members in the network associated with the update action.

bot_name instance-attribute

bot_name: Name

The new name of the bot. The name must be unique in the account that creates the bot.

bot_type instance-attribute

bot_type: NotRequired[BotType]

The type of the bot to be updated.

data_privacy instance-attribute

data_privacy: DataPrivacy

Provides information on additional privacy protections Amazon Lex should use with the bot's data.

description instance-attribute

description: NotRequired[Description]

A description of the bot.

error_log_settings instance-attribute

error_log_settings: NotRequired[ErrorLogSettings]

Allows you to modify how Amazon Lex logs errors during bot interactions, including destinations for error logs and the types of errors to be captured.

idle_session_ttl_in_seconds instance-attribute

idle_session_ttl_in_seconds: SessionTTL

The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.

You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.

role_arn instance-attribute

role_arn: RoleArn

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