Skip to content

stop_experiment

stop_experiment(
    id: ExperimentId, *, config_overrides: Optional[fisClientConfig] = None
) -> StopExperimentResponse

Stops the specified experiment.

Parameters:

Raises:

Source code in docs_src/capo_fis/_services/fis.py
def stop_experiment(
    self,
    id: "capo_fis.types.experiment_id.ExperimentId",
    *,
    config_overrides: Optional[fisClientConfig] = None,
) -> "capo_fis.types.stop_experiment_response.StopExperimentResponse":
    """<p>Stops the specified experiment.</p>

    Args:
        id: <p>The ID of the experiment.</p>

    Raises:
        capo_fis.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource cannot be found.</p>
        capo_fis.errors.validation_exception.ValidationException: <p>The specified input is not valid, or fails to satisfy the constraints for the request.</p>
        capo_fis.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_fis.types.stop_experiment_request.StopExperimentRequest]",
    ) -> OperationResponse[
        "capo_fis.types.stop_experiment_response.StopExperimentResponse"
    ]:
        import capo_fis._operations.fault_injection_simulator.stop_experiment

        output, http_response = (
            capo_fis._operations.fault_injection_simulator.stop_experiment.stop_experiment(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopExperiment")
    )
    input_: capo_fis.types.stop_experiment_request.StopExperimentRequest = {
        "id": id
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output