aws_sdk_synthetics/client/

delete_canary.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DeleteCanary`](crate::operation::delete_canary::builders::DeleteCanaryFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`name(impl Into<String>)`](crate::operation::delete_canary::builders::DeleteCanaryFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::delete_canary::builders::DeleteCanaryFluentBuilder::set_name):<br>required: **true**<br><p>The name of the canary that you want to delete. To find the names of your canaries, use <a href="https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html">DescribeCanaries</a>.</p><br>
    ///   - [`delete_lambda(bool)`](crate::operation::delete_canary::builders::DeleteCanaryFluentBuilder::delete_lambda) / [`set_delete_lambda(Option<bool>)`](crate::operation::delete_canary::builders::DeleteCanaryFluentBuilder::set_delete_lambda):<br>required: **false**<br><p>Specifies whether to also delete the Lambda functions and layers used by this canary. The default is <code>false</code>.</p> <p>Your setting for this parameter is used only if the canary doesn't have <code>AUTOMATIC</code> for its <code>ProvisionedResourceCleanup</code> field. If that field is set to <code>AUTOMATIC</code>, then the Lambda functions and layers will be deleted when this canary is deleted.</p> <p>Type: Boolean</p><br>
    /// - On success, responds with [`DeleteCanaryOutput`](crate::operation::delete_canary::DeleteCanaryOutput)
    /// - On failure, responds with [`SdkError<DeleteCanaryError>`](crate::operation::delete_canary::DeleteCanaryError)
    pub fn delete_canary(&self) -> crate::operation::delete_canary::builders::DeleteCanaryFluentBuilder {
        crate::operation::delete_canary::builders::DeleteCanaryFluentBuilder::new(self.handle.clone())
    }
}