Struct aws_sdk_synthetics::client::fluent_builders::StartCanary

pub struct StartCanary<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Fluent builder constructing a request to StartCanary.

Use this operation to run a canary that has already been created. The frequency of the canary runs is determined by the value of the canary's Schedule. To see a canary's schedule, use GetCanary.

Implementations

impl<C, M, R> StartCanary<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(self) -> Result<StartCanaryOutput, SdkError<StartCanaryError>> where
    R::Policy: SmithyRetryPolicy<StartCanaryInputOperationOutputAlias, StartCanaryOutput, StartCanaryError, StartCanaryInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn name(self, input: impl Into<String>) -> Self

The name of the canary that you want to run. To find canary names, use DescribeCanaries.

pub fn set_name(self, input: Option<String>) -> Self

The name of the canary that you want to run. To find canary names, use DescribeCanaries.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for StartCanary<C, M, R>

fn clone(&self) -> StartCanary<C, M, R>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for StartCanary<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.