Skip to content

StartBotRecommendationResponse

Source code in docs_src/capo_lex_models_v2/types/start_bot_recommendation_response.py
class StartBotRecommendationResponse(TypedDict, closed=True):
    bot_id: NotRequired["capo_lex_models_v2.types.id.Id"]
    """<p>The unique identifier of the bot containing the bot recommendation.</p>"""
    bot_version: NotRequired[
        "capo_lex_models_v2.types.draft_bot_version.DraftBotVersion"
    ]
    """<p>The version of the bot containing the bot recommendation.</p>"""
    locale_id: NotRequired["capo_lex_models_v2.types.locale_id.LocaleId"]
    """<p>The identifier of the language and locale of the bot recommendation to start. The string must match one of the supported locales. For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a> </p>"""
    bot_recommendation_status: NotRequired[
        "capo_lex_models_v2.types.bot_recommendation_status.BotRecommendationStatus"
    ]
    """<p>The status of the bot recommendation.</p> <p>If the status is Failed, then the reasons for the failure are listed in the failureReasons field. </p>"""
    bot_recommendation_id: NotRequired["capo_lex_models_v2.types.id.Id"]
    """<p>The identifier of the bot recommendation that you have created.</p>"""
    creation_date_time: NotRequired["capo_lex_models_v2.types.timestamp.Timestamp"]
    """<p>A timestamp of the date and time that the bot recommendation was created.</p>"""
    transcript_source_setting: NotRequired[
        "capo_lex_models_v2.types.transcript_source_setting.TranscriptSourceSetting"
    ]
    """<p>The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.</p>"""
    encryption_setting: NotRequired[
        "capo_lex_models_v2.types.encryption_setting.EncryptionSetting"
    ]
    """<p>The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.</p>"""

bot_id instance-attribute

bot_id: NotRequired[Id]

The unique identifier of the bot containing the bot recommendation.

bot_recommendation_id instance-attribute

bot_recommendation_id: NotRequired[Id]

The identifier of the bot recommendation that you have created.

bot_recommendation_status instance-attribute

bot_recommendation_status: NotRequired[BotRecommendationStatus]

The status of the bot recommendation.

If the status is Failed, then the reasons for the failure are listed in the failureReasons field.

bot_version instance-attribute

bot_version: NotRequired[DraftBotVersion]

The version of the bot containing the bot recommendation.

creation_date_time instance-attribute

creation_date_time: NotRequired[Timestamp]

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

encryption_setting instance-attribute

encryption_setting: NotRequired[EncryptionSetting]

The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.

locale_id instance-attribute

locale_id: NotRequired[LocaleId]

The identifier of the language and locale of the bot recommendation to start. The string must match one of the supported locales. For more information, see Supported languages

transcript_source_setting instance-attribute

transcript_source_setting: NotRequired[TranscriptSourceSetting]

The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.