Struct aws_sdk_datapipeline::client::fluent_builders::DeactivatePipeline

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

Fluent builder constructing a request to DeactivatePipeline.

Deactivates the specified running pipeline. The pipeline is set to the DEACTIVATING state until the deactivation process completes.

To resume a deactivated pipeline, use ActivatePipeline. By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline.

Implementations

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

pub async fn send(
    self
) -> Result<DeactivatePipelineOutput, SdkError<DeactivatePipelineError>> where
    R::Policy: SmithyRetryPolicy<DeactivatePipelineInputOperationOutputAlias, DeactivatePipelineOutput, DeactivatePipelineError, DeactivatePipelineInputOperationRetryAlias>, 

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_id(self, input: impl Into<String>) -> Self

The ID of the pipeline.

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

The ID of the pipeline.

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

Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED. If this value is false, the pipeline is deactivated after all running objects finish.

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

Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED. If this value is false, the pipeline is deactivated after all running objects finish.

Trait Implementations

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

fn clone(&self) -> DeactivatePipeline<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 DeactivatePipeline<C, M, R>

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

Formats the value using the given formatter.