> [!WARNING]
>
> **Preview**
>
>
> This feature is
>
> subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the
> [Service Specific
> Terms](https://docs.cloud.google.com/terms/service-terms#1).
>
> Pre-GA features are available "as is" and might have limited support.
>
> For more information, see the
> [launch stage descriptions](https://cloud.google.com/products/#product-launch-stages).

Cancels a BatchPredictionJob. Starts asynchronous cancellation on the
BatchPredictionJob. The server makes the best effort to cancel the job,
but success is not guaranteed. Clients can use
JobService.GetBatchPredictionJob or other methods to check whether the
cancellation succeeded or whether the job completed despite
cancellation. On a successful cancellation, the BatchPredictionJob is
not deleted;instead its BatchPredictionJob.state is set to `CANCELLED`.
Any files already outputted by the job are not deleted.

## Arguments

| Parameters ||
|---|---|
| `name` | `string` Required. The name of the BatchPredictionJob to cancel. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}` |
| `region` | `string` Required. Region of the HTTP endpoint. For example, if region is set to `us-central1`, the endpoint https://us-central1-integrations.googleapis.com will be used. See [service endpoints](https://cloud.google.com/vertex-ai/docs/reference/rest#rest_endpoints). |

## Raised exceptions

| Exceptions ||
|---|---|
| `ConnectionError` | In case of a network problem (such as DNS failure or refused connection). |
| `HttpError` | If the response status is \>= 400 (excluding 429 and 503). |
| `TimeoutError` | If a long-running operation takes longer to finish than the specified timeout limit. |
| `TypeError` | If an operation or function receives an argument of the wrong type. |
| `ValueError` | If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout. |

## Response

If successful, the response will be empty.

## Subworkflow snippet

Some fields might be optional or required.
To identify required fields, refer to the [API documentation](https://cloud.google.com/vertex-ai/docs/reference/rest/v1beta1/projects.locations.batchPredictionJobs/cancel).

### YAML

```yaml
- cancel:
    call: googleapis.aiplatform.v1beta1.projects.locations.batchPredictionJobs.cancel
    args:
        name: ...
        region: ...
    result: cancelResult
```

### JSON

```json
[
  {
    "cancel": {
      "call": "googleapis.aiplatform.v1beta1.projects.locations.batchPredictionJobs.cancel",
      "args": {
        "name": "...",
        "region": "..."
      },
      "result": "cancelResult"
    }
  }
]
```