Retrieves a list of runs for a specified canary¶

Description¶

Retrieves a list of runs for a specified canary.

Usage¶

synthetics_get_canary_runs(Name, NextToken, MaxResults, DryRunId,
  RunType)

Arguments¶

• Name

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

• NextToken

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

  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.

• MaxResults

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

• DryRunId

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

• 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

Value¶

A list with the following syntax:

list(
  CanaryRuns = list(
    list(
      Id = "string",
      ScheduledRunId = "string",
      RetryAttempt = 123,
      Name = "string",
      Status = list(
        State = "RUNNING"|"PASSED"|"FAILED",
        StateReason = "string",
        StateReasonCode = "CANARY_FAILURE"|"EXECUTION_FAILURE",
        TestResult = "PASSED"|"FAILED"|"UNKNOWN"
      ),
      Timeline = list(
        Started = as.POSIXct(
          "2015-01-01"
        ),
        Completed = as.POSIXct(
          "2015-01-01"
        ),
        MetricTimestampForRunAndRetries = as.POSIXct(
          "2015-01-01"
        )
      ),
      ArtifactS3Location = "string",
      DryRunConfig = list(
        DryRunId = "string"
      ),
      BrowserType = "CHROME"|"FIREFOX",
      Location = "string"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$get_canary_runs(
  Name = "string",
  NextToken = "string",
  MaxResults = 123,
  DryRunId = "string",
  RunType = "CANARY_RUN"|"DRY_RUN"
)