Get Canary Runs

synthetics_get_canary_runs

R Documentation

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)

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.

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.

Value¶

A list with the following syntax:

list(
  CanaryRuns = list(
    list(
      Id = "string",
      Name = "string",
      Status = list(
        State = "RUNNING"|"PASSED"|"FAILED",
        StateReason = "string",
        StateReasonCode = "CANARY_FAILURE"|"EXECUTION_FAILURE"
      ),
      Timeline = list(
        Started = as.POSIXct(
          "2015-01-01"
        ),
        Completed = as.POSIXct(
          "2015-01-01"
        )
      ),
      ArtifactS3Location = "string"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$get_canary_runs(
  Name = "string",
  NextToken = "string",
  MaxResults = 123
)