Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141891,2951.1 MB

Gets the details of a <a href="https://docs.aws.amazon.com/sagemaker-unified-studio/latest/userguide/notebooks.html">notebook run</a> in Amazon SageMaker Unified Studio.

get/v2/domains/{domainIdentifier}/notebook-runs/{identifier}

Path parameters

domainIdentifierstring required

The identifier of the Amazon SageMaker Unified Studio domain in which the notebook run exists.

identifierstring required

The identifier of the notebook run.

Response

Success

idstring required

The identifier of the notebook run.

domainIdstring required

The identifier of the Amazon SageMaker Unified Studio domain.

owningProjectIdstring required

The identifier of the project that owns the notebook run.

notebookIdstring required

The identifier of the notebook.

scheduleIdstring

The identifier of the schedule associated with the notebook run.

status'QUEUED' | 'STARTING' | 'RUNNING' | 'STOPPING' | 'STOPPED' | 'SUCCEEDED' | 'FAILED' required

The status of the notebook run.

cellOrderCellInformation[]

The ordered list of cells in the notebook run.

metadataobject

The metadata of the notebook run.

parametersobject

The sensitive parameters of the notebook run.

createdAtstring date-time

The timestamp of when the notebook run was created.

createdBystring

The identifier of the user who created the notebook run.

updatedAtstring date-time

The timestamp of when the notebook run was last updated.

updatedBystring

The identifier of the user who last updated the notebook run.

startedAtstring date-time

The timestamp of when the notebook run started executing.

completedAtstring date-time

The timestamp of when the notebook run completed.