Skip to content

DescribeBotResponse

Source code in docs_src/capo_lex_models_v2/types/describe_bot_response.py
class DescribeBotResponse(TypedDict, closed=True):
    bot_id: NotRequired["capo_lex_models_v2.types.id.Id"]
    """<p>The unique identifier of the bot.</p>"""
    bot_name: NotRequired["capo_lex_models_v2.types.name.Name"]
    """<p>The name of the bot.</p>"""
    description: NotRequired["capo_lex_models_v2.types.description.Description"]
    """<p>The description of the bot. </p>"""
    role_arn: NotRequired["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: NotRequired["capo_lex_models_v2.types.data_privacy.DataPrivacy"]
    """<p>Settings for managing data privacy of the bot and its conversations with users.</p>"""
    idle_session_ttl_in_seconds: NotRequired[
        "capo_lex_models_v2.types.session_ttl.SessionTTL"
    ]
    """<p>The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.</p>"""
    bot_status: NotRequired["capo_lex_models_v2.types.bot_status.BotStatus"]
    """<p>The current status of the bot. When the status is <code>Available</code> the bot is ready to be used in conversations with users.</p>"""
    creation_date_time: NotRequired["capo_lex_models_v2.types.timestamp.Timestamp"]
    """<p>A timestamp of the date and time that the bot was created.</p>"""
    last_updated_date_time: NotRequired["capo_lex_models_v2.types.timestamp.Timestamp"]
    """<p>A timestamp of the date and time that the bot was last updated.</p>"""
    bot_type: NotRequired["capo_lex_models_v2.types.bot_type.BotType"]
    """<p>The type of the bot that was described.</p>"""
    bot_members: NotRequired["capo_lex_models_v2.types.bot_members.BotMembers"]
    """<p>The list of bots in the network that was described.</p>"""
    failure_reasons: NotRequired[
        "capo_lex_models_v2.types.failure_reasons.FailureReasons"
    ]
    """<p>If the <code>botStatus</code> is <code>Failed</code>, this contains a list of reasons that the bot couldn't be built.</p>"""
    error_log_settings: NotRequired[
        "capo_lex_models_v2.types.error_log_settings.ErrorLogSettings"
    ]
    """<p>Contains the configuration for error logging that specifies where and how bot errors are recorded, including destinations like CloudWatch Logs.</p>"""

bot_id instance-attribute

bot_id: NotRequired[Id]

The unique identifier of the bot.

bot_members instance-attribute

bot_members: NotRequired[BotMembers]

The list of bots in the network that was described.

bot_name instance-attribute

bot_name: NotRequired[Name]

The name of the bot.

bot_status instance-attribute

bot_status: NotRequired[BotStatus]

The current status of the bot. When the status is Available the bot is ready to be used in conversations with users.

bot_type instance-attribute

bot_type: NotRequired[BotType]

The type of the bot that was described.

creation_date_time instance-attribute

creation_date_time: NotRequired[Timestamp]

A timestamp of the date and time that the bot was created.

data_privacy instance-attribute

data_privacy: NotRequired[DataPrivacy]

Settings for managing data privacy of the bot and its conversations with users.

description instance-attribute

description: NotRequired[Description]

The description of the bot.

error_log_settings instance-attribute

error_log_settings: NotRequired[ErrorLogSettings]

Contains the configuration for error logging that specifies where and how bot errors are recorded, including destinations like CloudWatch Logs.

failure_reasons instance-attribute

failure_reasons: NotRequired[FailureReasons]

If the botStatus is Failed, this contains a list of reasons that the bot couldn't be built.

idle_session_ttl_in_seconds instance-attribute

idle_session_ttl_in_seconds: NotRequired[SessionTTL]

The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.

last_updated_date_time instance-attribute

last_updated_date_time: NotRequired[Timestamp]

A timestamp of the date and time that the bot was last updated.

role_arn instance-attribute

role_arn: NotRequired[RoleArn]

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