Skip to content

StopExperimentRunRequest

Source code in docs_src/capo_appconfig/types/stop_experiment_run_request.py
class StopExperimentRunRequest(TypedDict, closed=True):
    application_identifier: "capo_appconfig.types.identifier.Identifier"
    """<p>The application ID or name.</p>"""
    experiment_definition_identifier: "capo_appconfig.types.identifier.Identifier"
    """<p>The experiment definition ID or name.</p>"""
    run: "capo_appconfig.types.positive_integer.PositiveInteger"
    """<p>The run number to stop.</p>"""
    result: NotRequired[
        "capo_appconfig.types.experiment_run_result.ExperimentRunResult"
    ]
    """<p>The result of the experiment run, including an executive summary and reasons for or against launching.</p>"""
    deployment_parameters: NotRequired[
        "capo_appconfig.types.deployment_parameters.DeploymentParameters"
    ]
    """<p>The deployment parameters for the stop operation.</p>"""

application_identifier instance-attribute

application_identifier: Identifier

The application ID or name.

deployment_parameters instance-attribute

deployment_parameters: NotRequired[DeploymentParameters]

The deployment parameters for the stop operation.

experiment_definition_identifier instance-attribute

experiment_definition_identifier: Identifier

The experiment definition ID or name.

result instance-attribute

result: NotRequired[ExperimentRunResult]

The result of the experiment run, including an executive summary and reasons for or against launching.

run instance-attribute

The run number to stop.