Skip to content

CreateBotRequest

Source code in docs_src/capo_lex_models_v2/types/create_bot_request.py
class CreateBotRequest(TypedDict, closed=True):
    bot_name: "capo_lex_models_v2.types.name.Name"
    """<p>The name of the bot. The bot 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. It appears in lists to help you identify a particular bot.</p>"""
    role_arn: "capo_lex_models_v2.types.role_arn.RoleArn"
    """<p>The Amazon Resource Name (ARN) of an IAM role that has permission 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_tags: NotRequired["capo_lex_models_v2.types.tag_map.TagMap"]
    """<p>A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the <code>UpdateBot</code> operation to update tags. To update tags, use the <code>TagResource</code> operation.</p>"""
    test_bot_alias_tags: NotRequired["capo_lex_models_v2.types.tag_map.TagMap"]
    """<p>A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can't use the <code>UpdateAlias</code> operation to update tags. To update tags on the test alias, use the <code>TagResource</code> operation.</p>"""
    bot_type: NotRequired["capo_lex_models_v2.types.bot_type.BotType"]
    """<p>The type of a bot to create.</p>"""
    bot_members: NotRequired["capo_lex_models_v2.types.bot_members.BotMembers"]
    """<p>The list of bot members in a network to be created.</p>"""
    error_log_settings: NotRequired[
        "capo_lex_models_v2.types.error_log_settings.ErrorLogSettings"
    ]
    """<p>Specifies the configuration for error logging during bot creation.</p>"""

bot_members instance-attribute

bot_members: NotRequired[BotMembers]

The list of bot members in a network to be created.

bot_name instance-attribute

bot_name: Name

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

bot_tags instance-attribute

bot_tags: NotRequired[TagMap]

A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.

bot_type instance-attribute

bot_type: NotRequired[BotType]

The type of a bot to create.

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. It appears in lists to help you identify a particular bot.

error_log_settings instance-attribute

error_log_settings: NotRequired[ErrorLogSettings]

Specifies the configuration for error logging during bot creation.

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 permission to access the bot.

test_bot_alias_tags instance-attribute

test_bot_alias_tags: NotRequired[TagMap]

A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.