Skip to content

FulfillmentUpdatesSpecification

Source code in docs_src/capo_lex_models_v2/types/fulfillment_updates_specification.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class FulfillmentUpdatesSpecification(TypedDict, closed=True):
    active: "capo_lex_models_v2.types.boxed_boolean.BoxedBoolean"
    """<p>Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.</p> <p>If the <code>active</code> field is set to true, the <code>startResponse</code>, <code>updateResponse</code>, and <code>timeoutInSeconds</code> fields are required.</p>"""
    start_response: NotRequired[
        "capo_lex_models_v2.types.fulfillment_start_response_specification.FulfillmentStartResponseSpecification"
    ]
    """<p>Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.</p>"""
    update_response: NotRequired[
        "capo_lex_models_v2.types.fulfillment_update_response_specification.FulfillmentUpdateResponseSpecification"
    ]
    """<p>Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running.</p>"""
    timeout_in_seconds: NotRequired[
        "capo_lex_models_v2.types.fulfillment_timeout.FulfillmentTimeout"
    ]
    """<p>The length of time that the fulfillment Lambda function should run before it times out.</p>"""

active instance-attribute 

active: BoxedBoolean

Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.

If the active field is set to true, the startResponse, updateResponse, and timeoutInSeconds fields are required.

start_response instance-attribute 

start_response: NotRequired[FulfillmentStartResponseSpecification]

Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.

timeout_in_seconds instance-attribute 

timeout_in_seconds: NotRequired[FulfillmentTimeout]

The length of time that the fulfillment Lambda function should run before it times out.

update_response instance-attribute 

update_response: NotRequired[FulfillmentUpdateResponseSpecification]

Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running.