GetCanary
Retrieves complete information about one canary. You must specify the name of the canary that you want. To get a list of canaries and their names, use DescribeCanaries.
Request Syntax
GET /canary/name HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- name
-
The name of the canary that you want details for.
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
Content-type: application/json
{
"Canary": {
"ArtifactConfig": {
"S3Encryption": {
"EncryptionMode": "string",
"KmsKeyArn": "string"
}
},
"ArtifactS3Location": "string",
"Code": {
"Handler": "string",
"SourceLocationArn": "string"
},
"EngineArn": "string",
"ExecutionRoleArn": "string",
"FailureRetentionPeriodInDays": number,
"Id": "string",
"Name": "string",
"ProvisionedResourceCleanup": "string",
"RunConfig": {
"ActiveTracing": boolean,
"MemoryInMB": number,
"TimeoutInSeconds": number
},
"RuntimeVersion": "string",
"Schedule": {
"DurationInSeconds": number,
"Expression": "string"
},
"Status": {
"State": "string",
"StateReason": "string",
"StateReasonCode": "string"
},
"SuccessRetentionPeriodInDays": number,
"Tags": {
"string" : "string"
},
"Timeline": {
"Created": number,
"LastModified": number,
"LastStarted": number,
"LastStopped": number
},
"VisualReference": {
"BaseCanaryRunId": "string",
"BaseScreenshots": [
{
"IgnoreCoordinates": [ "string" ],
"ScreenshotName": "string"
}
]
},
"VpcConfig": {
"Ipv6AllowedForDualStack": boolean,
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ],
"VpcId": "string"
}
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerException
-
An unknown internal error occurred.
HTTP Status Code: 500
- 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:
