Synthetics / Client / stop_canary

stop_canary#

Synthetics.Client.stop_canary(**kwargs)#

Stops the canary to prevent all future runs. If the canary is currently running,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.

See also: AWS API Documentation

Request Syntax

response = client.stop_canary(
    Name='string'
)
Parameters:

Name (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • Synthetics.Client.exceptions.InternalServerException

  • Synthetics.Client.exceptions.ValidationException

  • Synthetics.Client.exceptions.ResourceNotFoundException

  • Synthetics.Client.exceptions.ConflictException