Skip to content

List Experiments

fis_list_experiments R Documentation

Lists your experiments

Description

Lists your experiments.

Usage

fis_list_experiments(maxResults, nextToken, experimentTemplateId)

Arguments

maxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

nextToken

The token for the next page of results.

experimentTemplateId

The ID of the experiment template.

Value

A list with the following syntax:

list(
  experiments = list(
    list(
      id = "string",
      arn = "string",
      experimentTemplateId = "string",
      state = list(
        status = "pending"|"initiating"|"running"|"completed"|"stopping"|"stopped"|"failed",
        reason = "string",
        error = list(
          accountId = "string",
          code = "string",
          location = "string"
        )
      ),
      creationTime = as.POSIXct(
        "2015-01-01"
      ),
      tags = list(
        "string"
      ),
      experimentOptions = list(
        accountTargeting = "single-account"|"multi-account",
        emptyTargetResolutionMode = "fail"|"skip",
        actionsMode = "skip-all"|"run-all"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_experiments(
  maxResults = 123,
  nextToken = "string",
  experimentTemplateId = "string"
)