aws_sdk_synthetics/client/
stop_canary.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 [`StopCanary`](crate::operation::stop_canary::builders::StopCanaryFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`name(impl Into<String>)`](crate::operation::stop_canary::builders::StopCanaryFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::stop_canary::builders::StopCanaryFluentBuilder::set_name):<br>required: **true**<br><p>The name of the canary that you want to stop. To find the names of your canaries, use <a href="https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html">ListCanaries</a>.</p><br>
7    /// - On success, responds with [`StopCanaryOutput`](crate::operation::stop_canary::StopCanaryOutput)
8    /// - On failure, responds with [`SdkError<StopCanaryError>`](crate::operation::stop_canary::StopCanaryError)
9    pub fn stop_canary(&self) -> crate::operation::stop_canary::builders::StopCanaryFluentBuilder {
10        crate::operation::stop_canary::builders::StopCanaryFluentBuilder::new(self.handle.clone())
11    }
12}