aws_sdk_codepipeline/client/
stop_pipeline_execution.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`StopPipelineExecution`](crate::operation::stop_pipeline_execution::builders::StopPipelineExecutionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`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):<br>required: **true**<br><p>The name of the pipeline to stop.</p><br>
7    ///   - [`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):<br>required: **true**<br><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><br>
8    ///   - [`abandon(bool)`](crate::operation::stop_pipeline_execution::builders::StopPipelineExecutionFluentBuilder::abandon) / [`set_abandon(Option<bool>)`](crate::operation::stop_pipeline_execution::builders::StopPipelineExecutionFluentBuilder::set_abandon):<br>required: **false**<br><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><br>
9    ///   - [`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):<br>required: **false**<br><p>Use this option to enter comments, such as the reason the pipeline was stopped.</p><br>
10    /// - On success, responds with [`StopPipelineExecutionOutput`](crate::operation::stop_pipeline_execution::StopPipelineExecutionOutput) with field(s):
11    ///   - [`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>
12    /// - On failure, responds with [`SdkError<StopPipelineExecutionError>`](crate::operation::stop_pipeline_execution::StopPipelineExecutionError)
13    pub fn stop_pipeline_execution(&self) -> crate::operation::stop_pipeline_execution::builders::StopPipelineExecutionFluentBuilder {
14        crate::operation::stop_pipeline_execution::builders::StopPipelineExecutionFluentBuilder::new(self.handle.clone())
15    }
16}
aws_sdk_codepipeline/client/stop_pipeline_execution.rs

aws_sdk_codepipeline/client/
stop_pipeline_execution.rs
