GetCanaryRuns - Amazon CloudWatch Synthetics

GetCanaryRuns

Retrieves a list of runs for a specified canary.

Request Syntax

POST /canary/name/runs HTTP/1.1 Content-type: application/json { "MaxResults": number, "NextToken": "string" }

URI Request Parameters

The request uses the following URI parameters.

name

The name of the canary that you want to see runs for.

Length Constraints: Minimum length of 1. Maximum length of 21.

Pattern: ^[0-9a-z_\-]+$

Required: Yes

Request Body

The request accepts the following data in JSON format.

MaxResults

Specify this parameter to limit how many runs are returned each time you use the GetCanaryRuns operation. If you omit this parameter, the default of 100 is used.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

A token that indicates that there is more data available. You can use this token in a subsequent GetCanaryRuns operation to retrieve the next set of results.

Type: String

Pattern: ^[a-zA-Z0-9=/+_.-]{4,252}$

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "CanaryRuns": [ { "ArtifactS3Location": "string", "Name": "string", "Status": { "State": "string", "StateReason": "string", "StateReasonCode": "string" }, "Timeline": { "Completed": number, "Started": number } } ], "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.

CanaryRuns

An array of structures. Each structure contains the details of one of the retrieved canary runs.

Type: Array of CanaryRun objects

NextToken

A token that indicates that there is more data available. You can use this token in a subsequent GetCanaryRuns operation to retrieve the next set of results.

Type: String

Pattern: ^[a-zA-Z0-9=/+_.-]{4,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

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: