CreateBotVersionResponse ¶

class CreateBotVersionResponse(TypedDict, closed=True):
    name: NotRequired["capo_lex_model_building_service.types.bot_name.BotName"]
    """<p>The name of the bot.</p>"""
    description: NotRequired[
        "capo_lex_model_building_service.types.description.Description"
    ]
    """<p>A description of the bot.</p>"""
    intents: NotRequired["capo_lex_model_building_service.types.intent_list.IntentList"]
    """<p>An array of <code>Intent</code> objects. For more information, see <a>PutBot</a>.</p>"""
    clarification_prompt: NotRequired[
        "capo_lex_model_building_service.types.prompt.Prompt"
    ]
    """<p>The message that Amazon Lex uses when it doesn't understand the user's request. For more information, see <a>PutBot</a>. </p>"""
    abort_statement: NotRequired[
        "capo_lex_model_building_service.types.statement.Statement"
    ]
    """<p>The message that Amazon Lex uses to cancel a conversation. For more information, see <a>PutBot</a>.</p>"""
    status: NotRequired["capo_lex_model_building_service.types.status.Status"]
    """<p> When you send a request to create or update a bot, Amazon Lex sets the <code>status</code> response element to <code>BUILDING</code>. After Amazon Lex builds the bot, it sets <code>status</code> to <code>READY</code>. If Amazon Lex can't build the bot, it sets <code>status</code> to <code>FAILED</code>. Amazon Lex returns the reason for the failure in the <code>failureReason</code> response element. </p>"""
    failure_reason: NotRequired["capo_lex_model_building_service.types.string.String"]
    """<p>If <code>status</code> is <code>FAILED</code>, Amazon Lex provides the reason that it failed to build the bot.</p>"""
    last_updated_date: NotRequired[
        "capo_lex_model_building_service.types.timestamp.Timestamp"
    ]
    """<p>The date when the <code>$LATEST</code> version of this bot was updated. </p>"""
    created_date: NotRequired[
        "capo_lex_model_building_service.types.timestamp.Timestamp"
    ]
    """<p>The date when the bot version was created.</p>"""
    idle_session_ttl_in_seconds: NotRequired[
        "capo_lex_model_building_service.types.session_ttl.SessionTTL"
    ]
    """<p>The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see <a>PutBot</a>.</p>"""
    voice_id: NotRequired["capo_lex_model_building_service.types.string.String"]
    """<p>The Amazon Polly voice ID that Amazon Lex uses for voice interactions with the user.</p>"""
    checksum: NotRequired["capo_lex_model_building_service.types.string.String"]
    """<p>Checksum identifying the version of the bot that was created.</p>"""
    version: NotRequired["capo_lex_model_building_service.types.version.Version"]
    """<p>The version of the bot. </p>"""
    locale: NotRequired["capo_lex_model_building_service.types.locale.Locale"]
    """<p> Specifies the target locale for the bot. </p>"""
    child_directed: NotRequired["capo_lex_model_building_service.types.boolean.Boolean"]
    """<p>For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying <code>true</code> or <code>false</code> in the <code>childDirected</code> field. By specifying <code>true</code> in the <code>childDirected</code> field, you confirm that your use of Amazon Lex <b>is</b> related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying <code>false</code> in the <code>childDirected</code> field, you confirm that your use of Amazon Lex <b>is not</b> related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the <code>childDirected</code> field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.</p> <p>If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the <a href="https://aws.amazon.com/lex/faqs#data-security">Amazon Lex FAQ.</a> </p>"""
    enable_model_improvements: NotRequired[
        "capo_lex_model_building_service.types.boolean.Boolean"
    ]
    """<p>Indicates whether the bot uses accuracy improvements. <code>true</code> indicates that the bot is using the improvements, otherwise, <code>false</code>.</p>"""
    detect_sentiment: NotRequired[
        "capo_lex_model_building_service.types.boolean.Boolean"
    ]
    """<p>Indicates whether utterances entered by the user should be sent to Amazon Comprehend for sentiment analysis.</p>"""