Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetCanaryRuns

Retrieves a list of runs for a specified canary.

Request Syntax


POST /canary/name/runs HTTP/1.1
Content-type: application/json

{
   "DryRunId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "RunType": "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 255.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

DryRunId

The DryRunId associated with an existing canary’s dry run. You can use this DryRunId to retrieve information about the dry run.

Type: String

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Required: No

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.

Note

When auto retry is enabled for the canary, the first subsequent retry is suffixed with *1 indicating its the first retry and the next subsequent try is suffixed with *2.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 252.

Required: No

RunType

When you provide RunType=CANARY_RUN and dryRunId, you will get an exception
When a value is not provided for RunType, the default value is CANARY_RUN
When CANARY_RUN is provided, all canary runs excluding dry runs are returned
When DRY_RUN is provided, all dry runs excluding canary runs are returned

Type: String

Valid Values: CANARY_RUN | DRY_RUN

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CanaryRuns": [ 
      { 
         "ArtifactS3Location": "string",
         "BrowserType": "string",
         "DryRunConfig": { 
            "DryRunId": "string"
         },
         "Id": "string",
         "Name": "string",
         "RetryAttempt": number,
         "ScheduledRunId": "string",
         "Status": { 
            "State": "string",
            "StateReason": "string",
            "StateReasonCode": "string",
            "TestResult": "string"
         },
         "Timeline": { 
            "Completed": number,
            "MetricTimestampForRunAndRetries": 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

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

ResourceNotFoundException

One of the specified resources was not found.

HTTP Status Code: 404

ValidationException

A parameter could not be validated.

HTTP Status Code: 400