v1

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

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

get/v2/domains/{domainIdentifier}/notebook-runs#owningProjectIdentifier

Path parameters

domainIdentifierstring required

The identifier of the Amazon SageMaker Unified Studio domain in which to list notebook runs.

Query parameters

owningProjectIdentifierstring required

The identifier of the project that owns the notebook runs.

notebookIdentifierstring

The identifier of the notebook to filter runs by.

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

The status of a notebook run in Amazon SageMaker Unified Studio.

The status to filter notebook runs by.

scheduleIdentifierstring

The identifier of the schedule to filter notebook runs by.

maxResultsinteger

The maximum number of notebook runs to return in a single call. When the number of notebook runs exceeds the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value.

sortOrder'ASCENDING' | 'DESCENDING'

The sort order for the results.

nextTokenstring

When the number of notebook runs is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of notebook runs, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListNotebookRuns</code> to list the next set of notebook runs.

Response

Success

nextTokenstring

When the number of notebook runs is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of notebook runs, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListNotebookRuns</code> to list the next set of notebook runs.