actionFault Injection Simulator

stop_experiment

Stops the specified experiment

Try it in Reliably

Activity as code

Below are the details and signature of the activity Python module.

Typeaction
Modulechaosaws.fis.actions
Namestop_experiment
Returnmapping

Usage

JSON

{
  "name": "stop-experiment",
  "type": "action",
  "provider": {
    "type": "python",
    "module": "chaosaws.fis.actions",
    "func": "stop_experiment",
    "arguments": {
      "experiment_id": ""
    }
  }
}

YAML

name: stop-experiment
provider:
  arguments:
    experiment_id: ""
  func: stop_experiment
  module: chaosaws.fis.actions
  type: python
type: action

Arguments

NameTypeDefaultRequiredTitleDescription
experiment_idstringYesExperiment IDFIS experiment identifier

Example

> stop_experiment(experiment_id="EXPTUCK2dxepXgkR38")
{
  "ResponseMetadata": {
    "RequestId": "e5e9f9a9-f4d0-4d72-8704-1f26cc8b6ad6",
    "HTTPStatusCode": 200,
    "HTTPHeaders": {
      "date": "Fri, 13 Aug 2021 09:12:17 GMT",
      ...
    },
    "experiment": {
      "id": "EXPTUCK2dxepXgkR38",
      "experimentTemplateId": "EXT6oWVA1WrLNy4XS",
      ...
    }
  }
}

Signature

def stop_experiment(
        experiment_id: str,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> Dict[str, Any]:
    pass

Related activities

  • probeFault Injection Simulator

    get_experiment

    Gets information about the specified experiment
  • actionFault Injection Simulator

    start_experiment

    Starts running an experiment from the specified experiment template