Skip to content

UpdateIntentRequest

Source code in docs_src/capo_lex_models_v2/types/update_intent_request.py
class UpdateIntentRequest(TypedDict, closed=True):
    intent_id: "capo_lex_models_v2.types.id.Id"
    """<p>The unique identifier of the intent to update.</p>"""
    intent_name: "capo_lex_models_v2.types.name.Name"
    """<p>The new name for the intent.</p>"""
    intent_display_name: NotRequired[
        "capo_lex_models_v2.types.display_name.DisplayName"
    ]
    """<p>The new display name for the intent.</p>"""
    description: NotRequired["capo_lex_models_v2.types.description.Description"]
    """<p>The new description of the intent.</p>"""
    parent_intent_signature: NotRequired[
        "capo_lex_models_v2.types.intent_signature.IntentSignature"
    ]
    """<p>The signature of the new built-in intent to use as the parent of this intent.</p>"""
    sample_utterances: NotRequired[
        "capo_lex_models_v2.types.sample_utterances_list.SampleUtterancesList"
    ]
    """<p>New utterances used to invoke the intent.</p>"""
    dialog_code_hook: NotRequired[
        "capo_lex_models_v2.types.dialog_code_hook_settings.DialogCodeHookSettings"
    ]
    """<p>The new Lambda function to use between each turn of the conversation with the bot.</p>"""
    fulfillment_code_hook: NotRequired[
        "capo_lex_models_v2.types.fulfillment_code_hook_settings.FulfillmentCodeHookSettings"
    ]
    """<p>The new Lambda function to call when all of the intents required slots are provided and the intent is ready for fulfillment.</p>"""
    slot_priorities: NotRequired[
        "capo_lex_models_v2.types.slot_priorities_list.SlotPrioritiesList"
    ]
    """<p>A new list of slots and their priorities that are contained by the intent.</p>"""
    intent_confirmation_setting: NotRequired[
        "capo_lex_models_v2.types.intent_confirmation_setting.IntentConfirmationSetting"
    ]
    """<p>New prompts that Amazon Lex sends to the user to confirm the completion of an intent.</p>"""
    intent_closing_setting: NotRequired[
        "capo_lex_models_v2.types.intent_closing_setting.IntentClosingSetting"
    ]
    """<p>The new response that Amazon Lex sends the user when the intent is closed.</p>"""
    input_contexts: NotRequired[
        "capo_lex_models_v2.types.input_contexts_list.InputContextsList"
    ]
    """<p>A new list of contexts that must be active in order for Amazon Lex to consider the intent.</p>"""
    output_contexts: NotRequired[
        "capo_lex_models_v2.types.output_contexts_list.OutputContextsList"
    ]
    """<p>A new list of contexts that Amazon Lex activates when the intent is fulfilled.</p>"""
    kendra_configuration: NotRequired[
        "capo_lex_models_v2.types.kendra_configuration.KendraConfiguration"
    ]
    """<p>New configuration settings for connecting to an Amazon Kendra index.</p>"""
    bot_id: "capo_lex_models_v2.types.id.Id"
    """<p>The identifier of the bot that contains the intent.</p>"""
    bot_version: "capo_lex_models_v2.types.draft_bot_version.DraftBotVersion"
    """<p>The version of the bot that contains the intent. Must be <code>DRAFT</code>.</p>"""
    locale_id: "capo_lex_models_v2.types.locale_id.LocaleId"
    """<p>The identifier of the language and locale where this intent is used. 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>"""
    initial_response_setting: NotRequired[
        "capo_lex_models_v2.types.initial_response_setting.InitialResponseSetting"
    ]
    """<p>Configuration settings for a response sent to the user before Amazon Lex starts eliciting slots.</p>"""
    qn_a_intent_configuration: NotRequired[
        "capo_lex_models_v2.types.qn_a_intent_configuration.QnAIntentConfiguration"
    ]
    """<p>Specifies the configuration of the built-in <code>Amazon.QnAIntent</code>. The <code>AMAZON.QnAIntent</code> intent is called when Amazon Lex can't determine another intent to invoke. If you specify this field, you can't specify the <code>kendraConfiguration</code> field.</p>"""
    q_in_connect_intent_configuration: NotRequired[
        "capo_lex_models_v2.types.q_in_connect_intent_configuration.QInConnectIntentConfiguration"
    ]
    """<p>Qinconnect intent configuration details for the update intent request.</p>"""

bot_id instance-attribute

bot_id: Id

The identifier of the bot that contains the intent.

bot_version instance-attribute

bot_version: DraftBotVersion

The version of the bot that contains the intent. Must be DRAFT.

description instance-attribute

description: NotRequired[Description]

The new description of the intent.

dialog_code_hook instance-attribute

dialog_code_hook: NotRequired[DialogCodeHookSettings]

The new Lambda function to use between each turn of the conversation with the bot.

fulfillment_code_hook instance-attribute

fulfillment_code_hook: NotRequired[FulfillmentCodeHookSettings]

The new Lambda function to call when all of the intents required slots are provided and the intent is ready for fulfillment.

initial_response_setting instance-attribute

initial_response_setting: NotRequired[InitialResponseSetting]

Configuration settings for a response sent to the user before Amazon Lex starts eliciting slots.

input_contexts instance-attribute

input_contexts: NotRequired[InputContextsList]

A new list of contexts that must be active in order for Amazon Lex to consider the intent.

intent_closing_setting instance-attribute

intent_closing_setting: NotRequired[IntentClosingSetting]

The new response that Amazon Lex sends the user when the intent is closed.

intent_confirmation_setting instance-attribute

intent_confirmation_setting: NotRequired[IntentConfirmationSetting]

New prompts that Amazon Lex sends to the user to confirm the completion of an intent.

intent_display_name instance-attribute

intent_display_name: NotRequired[DisplayName]

The new display name for the intent.

intent_id instance-attribute

intent_id: Id

The unique identifier of the intent to update.

intent_name instance-attribute

intent_name: Name

The new name for the intent.

kendra_configuration instance-attribute

kendra_configuration: NotRequired[KendraConfiguration]

New configuration settings for connecting to an Amazon Kendra index.

locale_id instance-attribute

locale_id: LocaleId

The identifier of the language and locale where this intent is used. The string must match one of the supported locales. For more information, see Supported languages.

output_contexts instance-attribute

output_contexts: NotRequired[OutputContextsList]

A new list of contexts that Amazon Lex activates when the intent is fulfilled.

parent_intent_signature instance-attribute

parent_intent_signature: NotRequired[IntentSignature]

The signature of the new built-in intent to use as the parent of this intent.

q_in_connect_intent_configuration instance-attribute

q_in_connect_intent_configuration: NotRequired[QInConnectIntentConfiguration]

Qinconnect intent configuration details for the update intent request.

qn_a_intent_configuration instance-attribute

qn_a_intent_configuration: NotRequired[QnAIntentConfiguration]

Specifies the configuration of the built-in Amazon.QnAIntent. The AMAZON.QnAIntent intent is called when Amazon Lex can't determine another intent to invoke. If you specify this field, you can't specify the kendraConfiguration field.

sample_utterances instance-attribute

sample_utterances: NotRequired[SampleUtterancesList]

New utterances used to invoke the intent.

slot_priorities instance-attribute

slot_priorities: NotRequired[SlotPrioritiesList]

A new list of slots and their priorities that are contained by the intent.