Skip to content

stop_sandbox

stop_sandbox(
    id: NonEmptyString, *, config_overrides: Optional[CodeBuildClientConfig] = None
) -> StopSandboxOutput

Stops a sandbox.

Parameters:

Raises:

Source code in docs_src/capo_codebuild/_services/code_build.py
def stop_sandbox(
    self,
    id: "capo_codebuild.types.non_empty_string.NonEmptyString",
    *,
    config_overrides: Optional[CodeBuildClientConfig] = None,
) -> "capo_codebuild.types.stop_sandbox_output.StopSandboxOutput":
    """<p>Stops a sandbox.</p>

    Args:
        id: <p>Information about the requested sandbox ID.</p>

    Raises:
        capo_codebuild.errors.invalid_input_exception.InvalidInputException: <p>The input value that was provided is not valid.</p>
        capo_codebuild.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified Amazon Web Services resource cannot be found.</p>
        capo_codebuild.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_codebuild.types.stop_sandbox_input.StopSandboxInput]",
    ) -> OperationResponse[
        "capo_codebuild.types.stop_sandbox_output.StopSandboxOutput"
    ]:
        import capo_codebuild._operations.code_build_20161006.stop_sandbox

        output, http_response = (
            capo_codebuild._operations.code_build_20161006.stop_sandbox.stop_sandbox(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopSandbox")
    )
    input_: capo_codebuild.types.stop_sandbox_input.StopSandboxInput = {"id": id}

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