Skip to content

start_sandbox

start_sandbox(
    *,
    config_overrides: Optional[CodeBuildClientConfig] = None,
    project_name: Optional[NonEmptyString] = None,
    idempotency_token: Optional[SensitiveString] = None,
) -> StartSandboxOutput

Starts a sandbox.

Parameters:

Raises:

Source code in docs_src/capo_codebuild/_services/code_build.py
def start_sandbox(
    self,
    *,
    config_overrides: Optional[CodeBuildClientConfig] = None,
    project_name: Optional[
        "capo_codebuild.types.non_empty_string.NonEmptyString"
    ] = None,
    idempotency_token: Optional[
        "capo_codebuild.types.sensitive_string.SensitiveString"
    ] = None,
) -> "capo_codebuild.types.start_sandbox_output.StartSandboxOutput":
    """<p>Starts a sandbox.</p>

    Args:
        project_name: <p>The CodeBuild project name.</p>
        idempotency_token: <p>A unique client token.</p>

    Raises:
        capo_codebuild.errors.account_suspended_exception.AccountSuspendedException: <p>The CodeBuild access has been suspended for the calling Amazon Web Services account.</p>
        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.start_sandbox_input.StartSandboxInput]",
    ) -> OperationResponse[
        "capo_codebuild.types.start_sandbox_output.StartSandboxOutput"
    ]:
        import capo_codebuild._operations.code_build_20161006.start_sandbox

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

    def _redact_input(
        input_: "capo_codebuild.types.start_sandbox_input.StartSandboxInput",
    ) -> dict[str, Any]:
        import capo_codebuild.types.start_sandbox_input

        return capo_codebuild.types.start_sandbox_input.redact_sensitive(input_)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("StartSandbox", redact_input=_redact_input),
    )
    input_: capo_codebuild.types.start_sandbox_input.StartSandboxInput = {}
    if project_name is not None:
        input_["project_name"] = project_name
    if idempotency_token is not None:
        input_["idempotency_token"] = idempotency_token

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