aws_sdk_pipes/client/
stop_pipe.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 [`StopPipe`](crate::operation::stop_pipe::builders::StopPipeFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`name(impl Into<String>)`](crate::operation::stop_pipe::builders::StopPipeFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::stop_pipe::builders::StopPipeFluentBuilder::set_name):<br>required: **true**<br><p>The name of the pipe.</p><br>
7    /// - On success, responds with [`StopPipeOutput`](crate::operation::stop_pipe::StopPipeOutput) with field(s):
8    ///   - [`arn(Option<String>)`](crate::operation::stop_pipe::StopPipeOutput::arn): <p>The ARN of the pipe.</p>
9    ///   - [`name(Option<String>)`](crate::operation::stop_pipe::StopPipeOutput::name): <p>The name of the pipe.</p>
10    ///   - [`desired_state(Option<RequestedPipeState>)`](crate::operation::stop_pipe::StopPipeOutput::desired_state): <p>The state the pipe should be in.</p>
11    ///   - [`current_state(Option<PipeState>)`](crate::operation::stop_pipe::StopPipeOutput::current_state): <p>The state the pipe is in.</p>
12    ///   - [`creation_time(Option<DateTime>)`](crate::operation::stop_pipe::StopPipeOutput::creation_time): <p>The time the pipe was created.</p>
13    ///   - [`last_modified_time(Option<DateTime>)`](crate::operation::stop_pipe::StopPipeOutput::last_modified_time): <p>When the pipe was last updated, in <a href="https://www.w3.org/TR/NOTE-datetime">ISO-8601 format</a> (YYYY-MM-DDThh:mm:ss.sTZD).</p>
14    /// - On failure, responds with [`SdkError<StopPipeError>`](crate::operation::stop_pipe::StopPipeError)
15    pub fn stop_pipe(&self) -> crate::operation::stop_pipe::builders::StopPipeFluentBuilder {
16        crate::operation::stop_pipe::builders::StopPipeFluentBuilder::new(self.handle.clone())
17    }
18}