DescribeCanaries
This operation returns a list of the canaries in your account, along with full details about each canary.
This operation does not have resource-level authorization, so if a user is able to
use
DescribeCanaries
, the user can see all of the canaries in the account. A
deny policy can only be used to restrict access to all canaries. It cannot be used
on
specific resources.
Request Syntax
POST /canaries HTTP/1.1
Content-type: application/json
{
"MaxResults": number
,
"NextToken": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- MaxResults
-
Specify this parameter to limit how many canaries are returned each time you use the
DescribeCanaries
operation. If you omit this parameter, the default of 100 is used.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 20.
Required: No
- NextToken
-
A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 252.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Canaries": [
{
"ArtifactS3Location": "string",
"Code": {
"Handler": "string",
"SourceLocationArn": "string"
},
"EngineArn": "string",
"ExecutionRoleArn": "string",
"FailureRetentionPeriodInDays": number,
"Id": "string",
"Name": "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
},
"VpcConfig": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ],
"VpcId": "string"
}
}
],
"NextToken": "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.
- Canaries
-
Returns an array. Each item in the array contains the full information about one canary.
Type: Array of Canary objects
- NextToken
-
A token that indicates that there is more data available. You can use this token in a subsequent
DescribeCanaries
operation to retrieve the next set of results.Type: String
Length Constraints: Minimum length of 4. Maximum length of 252.
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: