Skip to content

PipeTargetStateMachineParameters

Source code in docs_src/capo_pipes/types/pipe_target_state_machine_parameters.py 
11
12
13
14
15
class PipeTargetStateMachineParameters(TypedDict, closed=True):
    invocation_type: NotRequired[
        "capo_pipes.types.pipe_target_invocation_type.PipeTargetInvocationType"
    ]
    """<p>Specify whether to invoke the Step Functions state machine synchronously or asynchronously.</p> <ul> <li> <p> <code>REQUEST_RESPONSE</code> (default) - Invoke synchronously. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartSyncExecution.html">StartSyncExecution</a> in the <i>Step Functions API Reference</i>.</p> <note> <p> <code>REQUEST_RESPONSE</code> is not supported for <code>STANDARD</code> state machine workflows.</p> </note> </li> <li> <p> <code>FIRE_AND_FORGET</code> - Invoke asynchronously. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html">StartExecution</a> in the <i>Step Functions API Reference</i>.</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html#pipes-invocation">Invocation types</a> in the <i>Amazon EventBridge User Guide</i>.</p>"""

invocation_type instance-attribute 

invocation_type: NotRequired[PipeTargetInvocationType]

Specify whether to invoke the Step Functions state machine synchronously or asynchronously.

  • REQUEST_RESPONSE (default) - Invoke synchronously. For more information, see StartSyncExecution in the Step Functions API Reference.

    REQUEST_RESPONSE is not supported for STANDARD state machine workflows.

  • FIRE_AND_FORGET - Invoke asynchronously. For more information, see StartExecution in the Step Functions API Reference.

For more information, see Invocation types in the Amazon EventBridge User Guide.