Vertex AI Notebook Execution Job

Vertex AI Notebook Execution Job is a managed service in Google Cloud that automates the execution of Jupyter notebooks. It allows users to schedule, run, and monitor notebook tasks in a scalable and reproducible way without manual intervention. This resource is useful for data processing, model training, and batch inference workflows.

gcp.aiplatform_notebook_execution_job

Fields

TitleIDTypeData TypeDescription
_keycorestring
ancestorscorearray<string>
create_timecoretimestampOutput only. Timestamp when this NotebookExecutionJob was created.
custom_environment_speccorejsonThe custom compute configuration for an execution job.
datadog_display_namecorestring
dataform_repository_sourcecorejsonThe Dataform Repository pointing to a single file notebook repository.
direct_notebook_sourcecorejsonThe contents of an input notebook file.
encryption_speccorejsonCustomer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec.
execution_timeoutcorestringMax running time of the execution job in seconds (default 86400s / 24 hrs).
execution_usercorestringThe user email to run the execution as. Only supported by Colab runtimes.
gcp_display_namecorestringThe display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
gcp_statuscorejsonOutput only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
gcs_notebook_sourcecorejsonThe Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
gcs_output_uricorestringThe Cloud Storage location to upload the result to. Format: `gs://bucket-name`
job_statecorestringOutput only. The state of the NotebookExecutionJob.
kernel_namecorestringThe name of the kernel to use during notebook execution. If unset, the default kernel is used.
labelscorearray<string>The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
namecorestringOutput only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
notebook_runtime_template_resource_namecorestringThe NotebookRuntimeTemplate to source compute configuration from.
organization_idcorestring
parentcorestring
project_idcorestring
project_numbercorestring
region_idcorestring
resource_namecorestring
schedule_resource_namecorestringThe Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
service_accountcorestringThe service account to run the execution as.
tagscorehstore_csv
update_timecoretimestampOutput only. Timestamp when this NotebookExecutionJob was most recently updated.
workbench_runtimecorejsonThe Workbench runtime configuration to use for the notebook execution.
zone_idcorestring