> [!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 PipelineJob. Starts asynchronous cancellation on the
PipelineJob. The server makes a best effort to cancel the pipeline, but
success is not guaranteed. Clients can use
PipelineService.GetPipelineJob or other methods to check whether the
cancellation succeeded or whether the pipeline completed despite
cancellation. On successful cancellation, the PipelineJob is not
deleted; instead it becomes a pipeline with a PipelineJob.error value
with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`,
and PipelineJob.state is set to `CANCELLED`.

## Arguments

| Parameters ||
|---|---|
| `name` | `string` Required. The name of the PipelineJob to cancel. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_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/v1/projects.locations.pipelineJobs/cancel).

### YAML

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

### JSON

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