Skip to content

StartExperimentRequest

Source code in docs_src/capo_fis/types/start_experiment_request.py 
16
17
18
19
20
21
22
23
24
25
26
class StartExperimentRequest(TypedDict, closed=True):
    client_token: "capo_fis.types.client_token.ClientToken"
    """<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"""
    experiment_template_id: "capo_fis.types.experiment_template_id.ExperimentTemplateId"
    """<p>The ID of the experiment template.</p>"""
    experiment_options: NotRequired[
        "capo_fis.types.start_experiment_experiment_options_input.StartExperimentExperimentOptionsInput"
    ]
    """<p>The experiment options for running the experiment.</p>"""
    tags: NotRequired["capo_fis.types.tag_map.TagMap"]
    """<p>The tags to apply to the experiment.</p>"""

client_token instance-attribute 

client_token: ClientToken

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

experiment_options instance-attribute 

experiment_options: NotRequired[StartExperimentExperimentOptionsInput]

The experiment options for running the experiment.

experiment_template_id instance-attribute 

experiment_template_id: ExperimentTemplateId

The ID of the experiment template.

tags instance-attribute 

tags: NotRequired[TagMap]

The tags to apply to the experiment.