Skip to content

DeactivatePipelineInput

Source code in docs_src/capo_data_pipeline/types/deactivate_pipeline_input.py 
14
15
16
17
18
class DeactivatePipelineInput(TypedDict, closed=True):
    pipeline_id: "capo_data_pipeline.types.id.id"
    """<p>The ID of the pipeline.</p>"""
    cancel_active: NotRequired["capo_data_pipeline.types.cancel_active.cancelActive"]
    """<p>Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to <code>CANCELED</code>. If this value is false, the pipeline is deactivated after all running objects finish.</p>"""

cancel_active instance-attribute 

cancel_active: NotRequired[cancelActive]

Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED. If this value is false, the pipeline is deactivated after all running objects finish.

pipeline_id instance-attribute 

pipeline_id: id

The ID of the pipeline.