Skip to content

DescribeIntentResponse

Source code in docs_src/capo_lex_models_v2/types/describe_intent_response.py
class DescribeIntentResponse(TypedDict, closed=True):
    intent_id: NotRequired["capo_lex_models_v2.types.id.Id"]
    """<p>The unique identifier assigned to the intent when it was created.</p>"""
    intent_name: NotRequired["capo_lex_models_v2.types.name.Name"]
    """<p>The name specified for the intent.</p>"""
    intent_display_name: NotRequired[
        "capo_lex_models_v2.types.display_name.DisplayName"
    ]
    """<p>The display name specified for the intent.</p>"""
    description: NotRequired["capo_lex_models_v2.types.description.Description"]
    """<p>The description of the intent.</p>"""
    parent_intent_signature: NotRequired[
        "capo_lex_models_v2.types.intent_signature.IntentSignature"
    ]
    """<p>The identifier of the built-in intent that this intent is derived from, if any.</p>"""
    sample_utterances: NotRequired[
        "capo_lex_models_v2.types.sample_utterances_list.SampleUtterancesList"
    ]
    """<p>User utterances that trigger this intent.</p>"""
    dialog_code_hook: NotRequired[
        "capo_lex_models_v2.types.dialog_code_hook_settings.DialogCodeHookSettings"
    ]
    """<p>The Lambda function called during each turn of a conversation with the intent.</p>"""
    fulfillment_code_hook: NotRequired[
        "capo_lex_models_v2.types.fulfillment_code_hook_settings.FulfillmentCodeHookSettings"
    ]
    """<p>The Lambda function called when the intent is complete and ready for fulfillment.</p>"""
    slot_priorities: NotRequired[
        "capo_lex_models_v2.types.slot_priorities_list.SlotPrioritiesList"
    ]
    """<p>The list that determines the priority that slots should be elicited from the user.</p>"""
    intent_confirmation_setting: NotRequired[
        "capo_lex_models_v2.types.intent_confirmation_setting.IntentConfirmationSetting"
    ]
    """<p>Prompts that Amazon Lex sends to the user to confirm completion of an intent.</p>"""
    intent_closing_setting: NotRequired[
        "capo_lex_models_v2.types.intent_closing_setting.IntentClosingSetting"
    ]
    """<p>The response that Amazon Lex sends to when the intent is closed.</p>"""
    input_contexts: NotRequired[
        "capo_lex_models_v2.types.input_contexts_list.InputContextsList"
    ]
    """<p>A list of contexts that must be active for the intent to be considered for sending to the user.</p>"""
    output_contexts: NotRequired[
        "capo_lex_models_v2.types.output_contexts_list.OutputContextsList"
    ]
    """<p>A list of contexts that are activated when the intent is fulfilled.</p>"""
    kendra_configuration: NotRequired[
        "capo_lex_models_v2.types.kendra_configuration.KendraConfiguration"
    ]
    """<p>Configuration information required to use the <code>AMAZON.KendraSearchIntent</code> intent.</p>"""
    bot_id: NotRequired["capo_lex_models_v2.types.id.Id"]
    """<p>The identifier of the bot associated with the intent.</p>"""
    bot_version: NotRequired[
        "capo_lex_models_v2.types.draft_bot_version.DraftBotVersion"
    ]
    """<p>The version of the bot associated with the intent.</p>"""
    locale_id: NotRequired["capo_lex_models_v2.types.locale_id.LocaleId"]
    """<p>The language and locale specified for the intent.</p>"""
    creation_date_time: NotRequired["capo_lex_models_v2.types.timestamp.Timestamp"]
    """<p>A timestamp of the date and time that the intent 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 intent was last updated.</p>"""
    initial_response_setting: NotRequired[
        "capo_lex_models_v2.types.initial_response_setting.InitialResponseSetting"
    ]
    """<p>Configuration setting 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>Details about the configuration of the built-in <code>Amazon.QnAIntent</code>.</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 describe intent response.</p>"""

bot_id instance-attribute

bot_id: NotRequired[Id]

The identifier of the bot associated with the intent.

bot_version instance-attribute

bot_version: NotRequired[DraftBotVersion]

The version of the bot associated with the intent.

creation_date_time instance-attribute

creation_date_time: NotRequired[Timestamp]

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

description instance-attribute

description: NotRequired[Description]

The description of the intent.

dialog_code_hook instance-attribute

dialog_code_hook: NotRequired[DialogCodeHookSettings]

The Lambda function called during each turn of a conversation with the intent.

fulfillment_code_hook instance-attribute

fulfillment_code_hook: NotRequired[FulfillmentCodeHookSettings]

The Lambda function called when the intent is complete and ready for fulfillment.

initial_response_setting instance-attribute

initial_response_setting: NotRequired[InitialResponseSetting]

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

input_contexts instance-attribute

input_contexts: NotRequired[InputContextsList]

A list of contexts that must be active for the intent to be considered for sending to the user.

intent_closing_setting instance-attribute

intent_closing_setting: NotRequired[IntentClosingSetting]

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

intent_confirmation_setting instance-attribute

intent_confirmation_setting: NotRequired[IntentConfirmationSetting]

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

intent_display_name instance-attribute

intent_display_name: NotRequired[DisplayName]

The display name specified for the intent.

intent_id instance-attribute

intent_id: NotRequired[Id]

The unique identifier assigned to the intent when it was created.

intent_name instance-attribute

intent_name: NotRequired[Name]

The name specified for the intent.

kendra_configuration instance-attribute

kendra_configuration: NotRequired[KendraConfiguration]

Configuration information required to use the AMAZON.KendraSearchIntent intent.

last_updated_date_time instance-attribute

last_updated_date_time: NotRequired[Timestamp]

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

locale_id instance-attribute

locale_id: NotRequired[LocaleId]

The language and locale specified for the intent.

output_contexts instance-attribute

output_contexts: NotRequired[OutputContextsList]

A list of contexts that are activated when the intent is fulfilled.

parent_intent_signature instance-attribute

parent_intent_signature: NotRequired[IntentSignature]

The identifier of the built-in intent that this intent is derived from, if any.

q_in_connect_intent_configuration instance-attribute

q_in_connect_intent_configuration: NotRequired[QInConnectIntentConfiguration]

Qinconnect intent configuration details for the describe intent response.

qn_a_intent_configuration instance-attribute

qn_a_intent_configuration: NotRequired[QnAIntentConfiguration]

Details about the configuration of the built-in Amazon.QnAIntent.

sample_utterances instance-attribute

sample_utterances: NotRequired[SampleUtterancesList]

User utterances that trigger this intent.

slot_priorities instance-attribute

slot_priorities: NotRequired[SlotPrioritiesList]

The list that determines the priority that slots should be elicited from the user.