Sign in

v1

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

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

put/v2/domains/{domainIdentifier}/notebook-runs/{identifier}/stop

Path parameters

domainIdentifierstring required

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

identifierstring required

The identifier of the notebook run to stop.

Request body

clientTokenstring

A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

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.

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

The status of the notebook run.