Skip to content

StopPipelineExecutionInput

Source code in docs_src/capo_codepipeline/types/stop_pipeline_execution_input.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
class StopPipelineExecutionInput(TypedDict, closed=True):
    pipeline_name: "capo_codepipeline.types.pipeline_name.PipelineName"
    """<p>The name of the pipeline to stop.</p>"""
    pipeline_execution_id: (
        "capo_codepipeline.types.pipeline_execution_id.PipelineExecutionId"
    )
    """<p>The ID of the pipeline execution to be stopped in the current stage. Use the <code>GetPipelineState</code> action to retrieve the current pipelineExecutionId.</p>"""
    abandon: "capo_codepipeline.types.boolean.Boolean"
    """<p>Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.</p> <note> <p>This option can lead to failed or out-of-sequence tasks.</p> </note>"""
    reason: NotRequired[
        "capo_codepipeline.types.stop_pipeline_execution_reason.StopPipelineExecutionReason"
    ]
    """<p>Use this option to enter comments, such as the reason the pipeline was stopped.</p>"""

abandon instance-attribute 

abandon: Boolean

Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.

This option can lead to failed or out-of-sequence tasks.

pipeline_execution_id instance-attribute 

pipeline_execution_id: PipelineExecutionId

The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.

pipeline_name instance-attribute 

pipeline_name: PipelineName

The name of the pipeline to stop.

reason instance-attribute 

reason: NotRequired[StopPipelineExecutionReason]

Use this option to enter comments, such as the reason the pipeline was stopped.