// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
/// Constructs a fluent builder for the [`StopPipelineExecution`](crate::operation::stop_pipeline_execution::builders::StopPipelineExecutionFluentBuilder) operation.
///
/// - The fluent builder is configurable:
/// - [`pipeline_name(impl Into<String>)`](crate::operation::stop_pipeline_execution::builders::StopPipelineExecutionFluentBuilder::pipeline_name) / [`set_pipeline_name(Option<String>)`](crate::operation::stop_pipeline_execution::builders::StopPipelineExecutionFluentBuilder::set_pipeline_name): <p>The name of the pipeline to stop.</p>
/// - [`pipeline_execution_id(impl Into<String>)`](crate::operation::stop_pipeline_execution::builders::StopPipelineExecutionFluentBuilder::pipeline_execution_id) / [`set_pipeline_execution_id(Option<String>)`](crate::operation::stop_pipeline_execution::builders::StopPipelineExecutionFluentBuilder::set_pipeline_execution_id): <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(bool)`](crate::operation::stop_pipeline_execution::builders::StopPipelineExecutionFluentBuilder::abandon) / [`set_abandon(bool)`](crate::operation::stop_pipeline_execution::builders::StopPipelineExecutionFluentBuilder::set_abandon): <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(impl Into<String>)`](crate::operation::stop_pipeline_execution::builders::StopPipelineExecutionFluentBuilder::reason) / [`set_reason(Option<String>)`](crate::operation::stop_pipeline_execution::builders::StopPipelineExecutionFluentBuilder::set_reason): <p>Use this option to enter comments, such as the reason the pipeline was stopped.</p>
/// - On success, responds with [`StopPipelineExecutionOutput`](crate::operation::stop_pipeline_execution::StopPipelineExecutionOutput) with field(s):
/// - [`pipeline_execution_id(Option<String>)`](crate::operation::stop_pipeline_execution::StopPipelineExecutionOutput::pipeline_execution_id): <p>The unique system-generated ID of the pipeline execution that was stopped.</p>
/// - On failure, responds with [`SdkError<StopPipelineExecutionError>`](crate::operation::stop_pipeline_execution::StopPipelineExecutionError)
pub fn stop_pipeline_execution(
&self,
) -> crate::operation::stop_pipeline_execution::builders::StopPipelineExecutionFluentBuilder
{
crate::operation::stop_pipeline_execution::builders::StopPipelineExecutionFluentBuilder::new(
self.handle.clone(),
)
}
}