AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Permanently deletes the specified canary.
If the canary's ProvisionedResourceCleanup field is set to AUTOMATIC
or you specify DeleteLambda in this operation as true, CloudWatch Synthetics
also deletes the Lambda functions and layers that are used by the canary.
Other resources used and created by the canary are not automatically deleted. After you delete a canary, you should also delete the following:
The CloudWatch alarms created for this canary. These alarms have a name of Synthetics-Alarm-first-198-characters-of-canary-name-canaryId-alarm
number
Amazon S3 objects and buckets, such as the canary's artifact location.
IAM roles created for the canary. If they were created in the console, these roles
have the name role/service-role/CloudWatchSyntheticsRole-First-21-Characters-of-CanaryName
CloudWatch Logs log groups created for the canary. These logs groups have the name
/aws/lambda/cwsyn-First-21-Characters-of-CanaryName
Before you delete a canary, you might want to use GetCanary to display the
information about this canary. Make note of the information returned by this operation
so that you can delete these resources after you delete the canary.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDeleteCanary and EndDeleteCanary.
Namespace: Amazon.Synthetics
Assembly: AWSSDK.Synthetics.dll
Version: 3.x.y.z
public abstract Task<DeleteCanaryResponse> DeleteCanaryAsync( DeleteCanaryRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the DeleteCanary service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| ConflictException | A conflicting operation is already in progress. |
| InternalServerException | An unknown internal error occurred. |
| ResourceNotFoundException | One of the specified resources was not found. |
| ValidationException | A parameter could not be validated. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer