aws_sdk_synthetics/client/
get_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 [`GetCanary`](crate::operation::get_canary::builders::GetCanaryFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`name(impl Into<String>)`](crate::operation::get_canary::builders::GetCanaryFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::get_canary::builders::GetCanaryFluentBuilder::set_name):<br>required: **true**<br><p>The name of the canary that you want details for.</p><br>
7    ///   - [`dry_run_id(impl Into<String>)`](crate::operation::get_canary::builders::GetCanaryFluentBuilder::dry_run_id) / [`set_dry_run_id(Option<String>)`](crate::operation::get_canary::builders::GetCanaryFluentBuilder::set_dry_run_id):<br>required: **false**<br><p>The DryRunId associated with an existing canary’s dry run. You can use this DryRunId to retrieve information about the dry run.</p><br>
8    /// - On success, responds with [`GetCanaryOutput`](crate::operation::get_canary::GetCanaryOutput) with field(s):
9    ///   - [`canary(Option<Canary>)`](crate::operation::get_canary::GetCanaryOutput::canary): <p>A structure that contains the full information about the canary.</p>
10    /// - On failure, responds with [`SdkError<GetCanaryError>`](crate::operation::get_canary::GetCanaryError)
11    pub fn get_canary(&self) -> crate::operation::get_canary::builders::GetCanaryFluentBuilder {
12        crate::operation::get_canary::builders::GetCanaryFluentBuilder::new(self.handle.clone())
13    }
14}