aws_sdk_datapipeline/client/
deactivate_pipeline.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DeactivatePipeline`](crate::operation::deactivate_pipeline::builders::DeactivatePipelineFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`pipeline_id(impl Into<String>)`](crate::operation::deactivate_pipeline::builders::DeactivatePipelineFluentBuilder::pipeline_id) / [`set_pipeline_id(Option<String>)`](crate::operation::deactivate_pipeline::builders::DeactivatePipelineFluentBuilder::set_pipeline_id):<br>required: **true**<br><p>The ID of the pipeline.</p><br>
    ///   - [`cancel_active(bool)`](crate::operation::deactivate_pipeline::builders::DeactivatePipelineFluentBuilder::cancel_active) / [`set_cancel_active(Option<bool>)`](crate::operation::deactivate_pipeline::builders::DeactivatePipelineFluentBuilder::set_cancel_active):<br>required: **false**<br><p>Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to <code>CANCELED</code>. If this value is false, the pipeline is deactivated after all running objects finish.</p><br>
    /// - On success, responds with [`DeactivatePipelineOutput`](crate::operation::deactivate_pipeline::DeactivatePipelineOutput)
    /// - On failure, responds with [`SdkError<DeactivatePipelineError>`](crate::operation::deactivate_pipeline::DeactivatePipelineError)
    pub fn deactivate_pipeline(&self) -> crate::operation::deactivate_pipeline::builders::DeactivatePipelineFluentBuilder {
        crate::operation::deactivate_pipeline::builders::DeactivatePipelineFluentBuilder::new(self.handle.clone())
    }
}