> [!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).

Assigns a NotebookRuntime to a user for a particular Notebook file. This
method will either returns an existing assignment or generates a new
one.

This method waits---the workflow execution is paused---until the operation is
complete, fails, or times out. The default timeout value is `1800` seconds (30
minutes) and can be changed to a maximum value of `31536000` seconds (one year)
for long-running operations using the `connector_params` field. See the
[Connectors reference](https://docs.cloud.google.com/workflows/docs/reference/googleapis.md.txt).

The connector uses polling to monitor the long-running operation, which might
generate additional billable steps. For more information about retries and
long-running operations, refer to [Understand connectors](https://docs.cloud.google.com/workflows/docs/connectors.md.txt).

The polling policy for the long-running operation can be configured. To set the
connector-specific parameters (`connector_params`), refer to
[Invoke a connector call](https://docs.cloud.google.com/workflows/docs/reference/googleapis.md.txt#invoke_a_connector_call).

## Arguments

| Parameters ||
|---|---|
| `parent` | `string` Required. The resource name of the Location to get the NotebookRuntime assignment. Format: `projects/{project}/locations/{location}` |
| `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). |
| `body` | `object (GoogleCloudAiplatformV1beta1AssignNotebookRuntimeRequest)` Required. |

## 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. |
| `OperationError` | If the long-running operation finished unsuccessfully. |
| `ResponseTypeError` | If the long-running operation returned a response of the wrong type. |

## Response

If successful, the response contains an instance of [`GoogleLongrunningOperation`](https://cloud.google.com/workflows/docs/reference/googleapis/aiplatform/v1beta1/Overview#GoogleLongrunningOperation).

## 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.notebookRuntimes/assign).

### YAML

```yaml
- assign:
    call: googleapis.aiplatform.v1beta1.projects.locations.notebookRuntimes.assign
    args:
        parent: ...
        region: ...
        body:
            notebookRuntime:
                description: ...
                displayName: ...
                networkTags: ...
                runtimeUser: ...
            notebookRuntimeId: ...
            notebookRuntimeTemplate: ...
    result: assignResult
```

### JSON

```json
[
  {
    "assign": {
      "call": "googleapis.aiplatform.v1beta1.projects.locations.notebookRuntimes.assign",
      "args": {
        "parent": "...",
        "region": "...",
        "body": {
          "notebookRuntime": {
            "description": "...",
            "displayName": "...",
            "networkTags": "...",
            "runtimeUser": "..."
          },
          "notebookRuntimeId": "...",
          "notebookRuntimeTemplate": "..."
        }
      },
      "result": "assignResult"
    }
  }
]
```