probeFault Injection Simulator

get_experiment

Gets information about the specified experiment

Try it in Reliably

Activity as code

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

Typeprobe
Modulechaosaws.fis.probes
Nameget_experiment
Returnmapping

Usage

JSON

{
  "name": "get-experiment",
  "type": "probe",
  "provider": {
    "type": "python",
    "module": "chaosaws.fis.probes",
    "func": "get_experiment",
    "arguments": {
      "experiment_id": ""
    }
  }
}

YAML

name: get-experiment
provider:
  arguments:
    experiment_id: ""
  func: get_experiment
  module: chaosaws.fis.probes
  type: python
type: probe

Arguments

NameTypeDefaultRequiredTitleDescription
experiment_idstringYesExperiment IDFIS experiment identifier

Returns an AWSResponse representing the response from FIS upon retrieving the experiment information

> get_experiment(experiment_id="EXPTUCK2dxepXgkR38")
{
  "ResponseMetadata": {
    "RequestId": "0665fe39-2213-400b-b7ff-5f1ab9b7a5ea",
    "HTTPStatusCode": 200,
    "HTTPHeaders": {
      "date": "Fri, 20 Aug 2021 11:08:27 GMT",
      ...
    }
  },
  "experiment": {
    "id": "EXPTUCK2dxepXgkR38",
    "experimentTemplateId": "EXT6oWVA1WrLNy4XS",
    ...
  }
}

Signature

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

Related activities