Skip to content

DeleteCanaryRequest

Source code in docs_src/capo_synthetics/types/delete_canary_request.py 
12
13
14
15
16
class DeleteCanaryRequest(TypedDict, closed=True):
    name: "capo_synthetics.types.canary_name.CanaryName"
    """<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>"""
    delete_lambda: "capo_synthetics.types.boolean.boolean"
    """<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>"""

delete_lambda instance-attribute 

delete_lambda: boolean

Specifies whether to also delete the Lambda functions and layers used by this canary. The default is false.

Your setting for this parameter is used only if the canary doesn't have AUTOMATIC for its ProvisionedResourceCleanup field. If that field is set to AUTOMATIC, then the Lambda functions and layers will be deleted when this canary is deleted.

Type: Boolean

name instance-attribute 

name: CanaryName

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