stop_job ¶

def stop_job(
    self,
    app_id: "capo_amplify.types.app_id.AppId",
    branch_name: "capo_amplify.types.branch_name.BranchName",
    job_id: "capo_amplify.types.job_id.JobId",
    *,
    config_overrides: Optional[AmplifyClientConfig] = None,
) -> "capo_amplify.types.stop_job_result.StopJobResult":
    """<p> Stops a job that is in progress for a branch of an Amplify app. </p>

    Args:
        app_id: <p> The unique ID for an Amplify app. </p>
        branch_name: <p>The name of the branch to use for the stop job request. </p>
        job_id: <p> The unique id for the job. </p>

    Raises:
        capo_amplify.errors.bad_request_exception.BadRequestException: <p>A request contains unexpected data. </p>
        capo_amplify.errors.internal_failure_exception.InternalFailureException: <p>The service failed to perform an operation due to an internal issue. </p>
        capo_amplify.errors.limit_exceeded_exception.LimitExceededException: <p>A resource could not be created because service quotas were exceeded. </p>
        capo_amplify.errors.not_found_exception.NotFoundException: <p>An entity was not found during an operation. </p>
        capo_amplify.errors.unauthorized_exception.UnauthorizedException: <p>An operation failed due to a lack of access. </p>
        capo_amplify.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_amplify.types.stop_job_request.StopJobRequest]",
    ) -> OperationResponse["capo_amplify.types.stop_job_result.StopJobResult"]:
        import capo_amplify._operations.amplify.stop_job

        output, http_response = capo_amplify._operations.amplify.stop_job.stop_job(
            req.options, req.input
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopJob")
    )
    input_: capo_amplify.types.stop_job_request.StopJobRequest = {
        "app_id": app_id,
        "branch_name": branch_name,
        "job_id": job_id,
    }

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