pub struct StopPipelineExecution { /* private fields */ }
Expand description
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
sourceimpl StopPipelineExecution
impl StopPipelineExecution
sourcepub async fn send(
self
) -> Result<StopPipelineExecutionOutput, SdkError<StopPipelineExecutionError>>
pub async fn send(
self
) -> Result<StopPipelineExecutionOutput, SdkError<StopPipelineExecutionError>>
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.
sourcepub fn pipeline_name(self, input: impl Into<String>) -> Self
pub fn pipeline_name(self, input: impl Into<String>) -> Self
The name of the pipeline to stop.
sourcepub fn set_pipeline_name(self, input: Option<String>) -> Self
pub fn set_pipeline_name(self, input: Option<String>) -> Self
The name of the pipeline to stop.
sourcepub fn pipeline_execution_id(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_pipeline_execution_id(self, input: Option<String>) -> Self
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.
sourcepub fn abandon(self, input: bool) -> Self
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.
sourcepub fn set_abandon(self, input: Option<bool>) -> Self
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.
sourcepub fn reason(self, input: impl Into<String>) -> Self
pub fn reason(self, input: impl Into<String>) -> Self
Use this option to enter comments, such as the reason the pipeline was stopped.
sourcepub fn set_reason(self, input: Option<String>) -> Self
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
sourceimpl Clone for StopPipelineExecution
impl Clone for StopPipelineExecution
sourcefn clone(&self) -> StopPipelineExecution
fn clone(&self) -> StopPipelineExecution
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for StopPipelineExecution
impl Send for StopPipelineExecution
impl Sync for StopPipelineExecution
impl Unpin for StopPipelineExecution
impl !UnwindSafe for StopPipelineExecution
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more