Skip to content

DescribeBotRecommendationResponse

Source code in docs_src/capo_lex_models_v2/types/describe_bot_recommendation_response.py
class DescribeBotRecommendationResponse(TypedDict, closed=True):
    bot_id: NotRequired["capo_lex_models_v2.types.id.Id"]
    """<p>The identifier of the bot associated with the bot recommendation.</p>"""
    bot_version: NotRequired[
        "capo_lex_models_v2.types.draft_bot_version.DraftBotVersion"
    ]
    """<p>The version of the bot associated with 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 describe.</p>"""
    bot_recommendation_status: NotRequired[
        "capo_lex_models_v2.types.bot_recommendation_status.BotRecommendationStatus"
    ]
    """<p>The status of the bot recommendation. 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 being described.</p>"""
    failure_reasons: NotRequired[
        "capo_lex_models_v2.types.failure_reasons.FailureReasons"
    ]
    """<p>If botRecommendationStatus is Failed, Amazon Lex explains why.</p>"""
    creation_date_time: NotRequired["capo_lex_models_v2.types.timestamp.Timestamp"]
    """<p>The date and time that the bot recommendation was created.</p>"""
    last_updated_date_time: NotRequired["capo_lex_models_v2.types.timestamp.Timestamp"]
    """<p>The date and time that the bot recommendation was last updated.</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_recommendation_results: NotRequired[
        "capo_lex_models_v2.types.bot_recommendation_results.BotRecommendationResults"
    ]
    """<p>The object representing the URL of the bot definition, the URL of the associated transcript and a statistical summary of the bot recommendation results.</p>"""

bot_id instance-attribute

bot_id: NotRequired[Id]

The identifier of the bot associated with the bot recommendation.

bot_recommendation_id instance-attribute

bot_recommendation_id: NotRequired[Id]

The identifier of the bot recommendation being described.

bot_recommendation_results instance-attribute

bot_recommendation_results: NotRequired[BotRecommendationResults]

The object representing the URL of the bot definition, the URL of the associated transcript and a statistical summary of the bot recommendation results.

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 associated with the bot recommendation.

creation_date_time instance-attribute

creation_date_time: NotRequired[Timestamp]

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.

failure_reasons instance-attribute

failure_reasons: NotRequired[FailureReasons]

If botRecommendationStatus is Failed, Amazon Lex explains why.

last_updated_date_time instance-attribute

last_updated_date_time: NotRequired[Timestamp]

The date and time that the bot recommendation was last updated.

locale_id instance-attribute

locale_id: NotRequired[LocaleId]

The identifier of the language and locale of the bot recommendation to describe.

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.