StartCanary
Use this operation to run a canary that has already been created.
The frequency of the canary runs is determined by the value of the canary's Schedule. To see a canary's schedule,
use GetCanary.
Request Syntax
POST /canary/name/start HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- name
-
The name of the canary that you want to run. To find canary names, use DescribeCanaries.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[0-9a-z_\-]+$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
A conflicting operation is already in progress.
HTTP Status Code: 409
- InternalServerException
-
An unknown internal error occurred.
HTTP Status Code: 500
- ResourceNotFoundException
-
One of the specified resources was not found.
HTTP Status Code: 404
- ValidationException
-
A parameter could not be validated.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
