Skip to content

FulfillmentCodeHookSettings

Source code in docs_src/capo_lex_models_v2/types/fulfillment_code_hook_settings.py
class FulfillmentCodeHookSettings(TypedDict, closed=True):
    enabled: "capo_lex_models_v2.types.boolean.Boolean"
    """<p>Indicates whether a Lambda function should be invoked to fulfill a specific intent.</p>"""
    post_fulfillment_status_specification: NotRequired[
        "capo_lex_models_v2.types.post_fulfillment_status_specification.PostFulfillmentStatusSpecification"
    ]
    """<p>Provides settings for messages sent to the user for after the Lambda fulfillment function completes. Post-fulfillment messages can be sent for both streaming and non-streaming conversations.</p>"""
    fulfillment_updates_specification: NotRequired[
        "capo_lex_models_v2.types.fulfillment_updates_specification.FulfillmentUpdatesSpecification"
    ]
    """<p>Provides settings for update messages sent to the user for long-running Lambda fulfillment functions. Fulfillment updates can be used only with streaming conversations.</p>"""
    active: NotRequired["capo_lex_models_v2.types.boxed_boolean.BoxedBoolean"]
    """<p>Determines whether the fulfillment code hook is used. When <code>active</code> is false, the code hook doesn't run.</p>"""

active instance-attribute

active: NotRequired[BoxedBoolean]

Determines whether the fulfillment code hook is used. When active is false, the code hook doesn't run.

enabled instance-attribute

enabled: Boolean

Indicates whether a Lambda function should be invoked to fulfill a specific intent.

fulfillment_updates_specification instance-attribute

fulfillment_updates_specification: NotRequired[FulfillmentUpdatesSpecification]

Provides settings for update messages sent to the user for long-running Lambda fulfillment functions. Fulfillment updates can be used only with streaming conversations.

post_fulfillment_status_specification instance-attribute

post_fulfillment_status_specification: NotRequired[PostFulfillmentStatusSpecification]

Provides settings for messages sent to the user for after the Lambda fulfillment function completes. Post-fulfillment messages can be sent for both streaming and non-streaming conversations.