Struct aws_sdk_synthetics::client::fluent_builders::StopCanary

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

Fluent builder constructing a request to StopCanary.

Stops the canary to prevent all future runs. If the canary is currently running, Synthetics stops waiting for the current run of the specified canary to complete. The run that is in progress completes on its own, publishes metrics, and uploads artifacts, but it is not recorded in Synthetics as a completed run.

You can use StartCanary to start it running again with the canary’s current schedule at any point in the future.

Implementations

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

pub async fn send(self) -> Result<StopCanaryOutput, SdkError<StopCanaryError>> where
    R::Policy: SmithyRetryPolicy<StopCanaryInputOperationOutputAlias, StopCanaryOutput, StopCanaryError, StopCanaryInputOperationRetryAlias>, 

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 stop. To find the names of your canaries, use DescribeCanaries.

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

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

Trait Implementations

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

fn clone(&self) -> StopCanary<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 StopCanary<C, M, R>

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

Formats the value using the given formatter.