Skip to content

GetIntentResponse

Source code in docs_src/capo_lex_model_building_service/types/get_intent_response.py
class GetIntentResponse(TypedDict, closed=True):
    name: NotRequired["capo_lex_model_building_service.types.intent_name.IntentName"]
    """<p>The name of the intent.</p>"""
    description: NotRequired[
        "capo_lex_model_building_service.types.description.Description"
    ]
    """<p>A description of the intent.</p>"""
    slots: NotRequired["capo_lex_model_building_service.types.slot_list.SlotList"]
    """<p>An array of intent slots configured for the intent.</p>"""
    sample_utterances: NotRequired[
        "capo_lex_model_building_service.types.intent_utterance_list.IntentUtteranceList"
    ]
    """<p>An array of sample utterances configured for the intent.</p>"""
    confirmation_prompt: NotRequired[
        "capo_lex_model_building_service.types.prompt.Prompt"
    ]
    """<p>If defined in the bot, Amazon Lex uses prompt to confirm the intent before fulfilling the user's request. For more information, see <a>PutIntent</a>. </p>"""
    rejection_statement: NotRequired[
        "capo_lex_model_building_service.types.statement.Statement"
    ]
    """<p>If the user answers "no" to the question defined in <code>confirmationPrompt</code>, Amazon Lex responds with this statement to acknowledge that the intent was canceled. </p>"""
    follow_up_prompt: NotRequired[
        "capo_lex_model_building_service.types.follow_up_prompt.FollowUpPrompt"
    ]
    """<p>If defined in the bot, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled. For more information, see <a>PutIntent</a>.</p>"""
    conclusion_statement: NotRequired[
        "capo_lex_model_building_service.types.statement.Statement"
    ]
    """<p>After the Lambda function specified in the <code>fulfillmentActivity</code> element fulfills the intent, Amazon Lex conveys this statement to the user.</p>"""
    dialog_code_hook: NotRequired[
        "capo_lex_model_building_service.types.code_hook.CodeHook"
    ]
    """<p>If defined in the bot, Amazon Amazon Lex invokes this Lambda function for each user input. For more information, see <a>PutIntent</a>. </p>"""
    fulfillment_activity: NotRequired[
        "capo_lex_model_building_service.types.fulfillment_activity.FulfillmentActivity"
    ]
    """<p>Describes how the intent is fulfilled. For more information, see <a>PutIntent</a>. </p>"""
    parent_intent_signature: NotRequired[
        "capo_lex_model_building_service.types.builtin_intent_signature.BuiltinIntentSignature"
    ]
    """<p>A unique identifier for a built-in intent.</p>"""
    last_updated_date: NotRequired[
        "capo_lex_model_building_service.types.timestamp.Timestamp"
    ]
    """<p>The date that the intent was updated. When you create a resource, the creation date and the last updated date are the same. </p>"""
    created_date: NotRequired[
        "capo_lex_model_building_service.types.timestamp.Timestamp"
    ]
    """<p>The date that the intent was created.</p>"""
    version: NotRequired["capo_lex_model_building_service.types.version.Version"]
    """<p>The version of the intent.</p>"""
    checksum: NotRequired["capo_lex_model_building_service.types.string.String"]
    """<p>Checksum of the intent.</p>"""
    kendra_configuration: NotRequired[
        "capo_lex_model_building_service.types.kendra_configuration.KendraConfiguration"
    ]
    """<p>Configuration information, if any, to connect to an Amazon Kendra index with the <code>AMAZON.KendraSearchIntent</code> intent.</p>"""
    input_contexts: NotRequired[
        "capo_lex_model_building_service.types.input_context_list.InputContextList"
    ]
    """<p>An array of <code>InputContext</code> objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.</p>"""
    output_contexts: NotRequired[
        "capo_lex_model_building_service.types.output_context_list.OutputContextList"
    ]
    """<p>An array of <code>OutputContext</code> objects that lists the contexts that the intent activates when the intent is fulfilled.</p>"""

checksum instance-attribute

checksum: NotRequired[String]

Checksum of the intent.

conclusion_statement instance-attribute

conclusion_statement: NotRequired[Statement]

After the Lambda function specified in the fulfillmentActivity element fulfills the intent, Amazon Lex conveys this statement to the user.

confirmation_prompt instance-attribute

confirmation_prompt: NotRequired[Prompt]

If defined in the bot, Amazon Lex uses prompt to confirm the intent before fulfilling the user's request. For more information, see PutIntent.

created_date instance-attribute

created_date: NotRequired[Timestamp]

The date that the intent was created.

description instance-attribute

description: NotRequired[Description]

A description of the intent.

dialog_code_hook instance-attribute

dialog_code_hook: NotRequired[CodeHook]

If defined in the bot, Amazon Amazon Lex invokes this Lambda function for each user input. For more information, see PutIntent.

follow_up_prompt instance-attribute

follow_up_prompt: NotRequired[FollowUpPrompt]

If defined in the bot, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled. For more information, see PutIntent.

fulfillment_activity instance-attribute

fulfillment_activity: NotRequired[FulfillmentActivity]

Describes how the intent is fulfilled. For more information, see PutIntent.

input_contexts instance-attribute

input_contexts: NotRequired[InputContextList]

An array of InputContext objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.

kendra_configuration instance-attribute

kendra_configuration: NotRequired[KendraConfiguration]

Configuration information, if any, to connect to an Amazon Kendra index with the AMAZON.KendraSearchIntent intent.

last_updated_date instance-attribute

last_updated_date: NotRequired[Timestamp]

The date that the intent was updated. When you create a resource, the creation date and the last updated date are the same.

name instance-attribute

name: NotRequired[IntentName]

The name of the intent.

output_contexts instance-attribute

output_contexts: NotRequired[OutputContextList]

An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.

parent_intent_signature instance-attribute

parent_intent_signature: NotRequired[BuiltinIntentSignature]

A unique identifier for a built-in intent.

rejection_statement instance-attribute

rejection_statement: NotRequired[Statement]

If the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled.

sample_utterances instance-attribute

sample_utterances: NotRequired[IntentUtteranceList]

An array of sample utterances configured for the intent.

slots instance-attribute

slots: NotRequired[SlotList]

An array of intent slots configured for the intent.

version instance-attribute

version: NotRequired[Version]

The version of the intent.