Stop Experiment

fis_stop_experiment

R Documentation

Stops the specified experiment

Description

Stops the specified experiment.

Usage

fis_stop_experiment(id)

Arguments

id

[required] The ID of 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"|"cancelled",
      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,
    experimentReportConfiguration = list(
      outputs = list(
        s3Configuration = list(
          bucketName = "string",
          prefix = "string"
        )
      ),
      dataSources = list(
        cloudWatchDashboards = list(
          list(
            dashboardIdentifier = "string"
          )
        )
      ),
      preExperimentDuration = "string",
      postExperimentDuration = "string"
    ),
    experimentReport = list(
      state = list(
        status = "pending"|"running"|"completed"|"cancelled"|"failed",
        reason = "string",
        error = list(
          code = "string"
        )
      ),
      s3Reports = list(
        list(
          arn = "string",
          reportType = "string"
        )
      )
    )
  )
)

Request syntax

svc$stop_experiment(
  id = "string"
)