Start Experiment

fis_start_experiment

R Documentation

Starts running an experiment from the specified experiment template

Description

Starts running an experiment from the specified experiment template.

Usage

fis_start_experiment(clientToken, experimentTemplateId,
  experimentOptions, tags)

Arguments

clientToken

[required] Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

experimentTemplateId

[required] The ID of the experiment template.

experimentOptions

The experiment options for running the experiment.

tags

The tags to apply to the experiment.

Value

A list with the following syntax:

list(
  experiment = list(
    id = "string",
    arn = "string",
    experimentTemplateId = "string",
    roleArn = "string",
    state = list(
      status = "pending"|"initiating"|"running"|"completed"|"stopping"|"stopped"|"failed",
      reason = "string",
      error = list(
        accountId = "string",
        code = "string",
        location = "string"
      )
    ),
    targets = list(
      list(
        resourceType = "string",
        resourceArns = list(
          "string"
        ),
        resourceTags = list(
          "string"
        ),
        filters = list(
          list(
            path = "string",
            values = list(
              "string"
            )
          )
        ),
        selectionMode = "string",
        parameters = list(
          "string"
        )
      )
    ),
    actions = list(
      list(
        actionId = "string",
        description = "string",
        parameters = list(
          "string"
        ),
        targets = list(
          "string"
        ),
        startAfter = list(
          "string"
        ),
        state = list(
          status = "pending"|"initiating"|"running"|"completed"|"cancelled"|"stopping"|"stopped"|"failed"|"skipped",
          reason = "string"
        ),
        startTime = as.POSIXct(
          "2015-01-01"
        ),
        endTime = as.POSIXct(
          "2015-01-01"
        )
      )
    ),
    stopConditions = list(
      list(
        source = "string",
        value = "string"
      )
    ),
    creationTime = as.POSIXct(
      "2015-01-01"
    ),
    startTime = as.POSIXct(
      "2015-01-01"
    ),
    endTime = as.POSIXct(
      "2015-01-01"
    ),
    tags = list(
      "string"
    ),
    logConfiguration = list(
      cloudWatchLogsConfiguration = list(
        logGroupArn = "string"
      ),
      s3Configuration = list(
        bucketName = "string",
        prefix = "string"
      ),
      logSchemaVersion = 123
    ),
    experimentOptions = list(
      accountTargeting = "single-account"|"multi-account",
      emptyTargetResolutionMode = "fail"|"skip",
      actionsMode = "skip-all"|"run-all"
    ),
    targetAccountConfigurationsCount = 123
  )
)

Request syntax

svc$start_experiment(
  clientToken = "string",
  experimentTemplateId = "string",
  experimentOptions = list(
    actionsMode = "skip-all"|"run-all"
  ),
  tags = list(
    "string"
  )
)