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