Skip to content

CancelFlowExecutionsRequest

Source code in docs_src/capo_appflow/types/cancel_flow_executions_request.py 
14
15
16
17
18
class CancelFlowExecutionsRequest(TypedDict, closed=True):
    flow_name: "capo_appflow.types.flow_name.FlowName"
    """<p>The name of a flow with active runs that you want to cancel.</p>"""
    execution_ids: NotRequired["capo_appflow.types.execution_ids.ExecutionIds"]
    """<p>The ID of each active run to cancel. These runs must belong to the flow you specify in your request.</p> <p>If you omit this parameter, your request ends all active runs that belong to the flow.</p>"""

execution_ids instance-attribute 

execution_ids: NotRequired[ExecutionIds]

The ID of each active run to cancel. These runs must belong to the flow you specify in your request.

If you omit this parameter, your request ends all active runs that belong to the flow.

flow_name instance-attribute 

flow_name: FlowName

The name of a flow with active runs that you want to cancel.