Struct aws_sdk_codepipeline::client::fluent_builders::StopPipelineExecution

pub struct StopPipelineExecution<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to StopPipelineExecution.

Stops the specified pipeline execution. You choose to either stop the pipeline execution by completing in-progress actions without starting subsequent actions, or by abandoning in-progress actions. While completing or abandoning in-progress actions, the pipeline execution is in a Stopping state. After all in-progress actions are completed or abandoned, the pipeline execution is in a Stopped state.

Implementations

impl<C, M, R> StopPipelineExecution<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<StopPipelineExecutionOutput, SdkError<StopPipelineExecutionError>> where
    R::Policy: SmithyRetryPolicy<StopPipelineExecutionInputOperationOutputAlias, StopPipelineExecutionOutput, StopPipelineExecutionError, StopPipelineExecutionInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn pipeline_name(self, input: impl Into<String>) -> Self

The name of the pipeline to stop.

pub fn set_pipeline_name(self, input: Option<String>) -> Self

The name of the pipeline to stop.

pub fn pipeline_execution_id(self, input: impl Into<String>) -> Self

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

pub fn set_pipeline_execution_id(self, input: Option<String>) -> Self

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

pub fn abandon(self, input: bool) -> Self

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.

pub fn set_abandon(self, input: Option<bool>) -> Self

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.

pub fn reason(self, input: impl Into<String>) -> Self

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

pub fn set_reason(self, input: Option<String>) -> Self

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

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for StopPipelineExecution<C, M, R>

fn clone(&self) -> StopPipelineExecution<C, M, R>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for StopPipelineExecution<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.