Sign in

v1

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

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

patch/v2/domains/{domainIdentifier}/notebooks/{identifier}

Path parameters

domainIdentifierstring required

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

identifierstring required

The identifier of the notebook to update.

Request body

descriptionstring password

The updated description of the notebook.

status'ACTIVE' | 'ARCHIVED'

The status of a notebook in Amazon SageMaker Unified Studio.

namestring password

The updated name of the notebook.

cellOrderCellInformation[]

The updated ordered list of cells in the notebook.

metadataobject

The updated metadata for the notebook, specified as key-value pairs.

parametersobject

The updated sensitive parameters for the notebook, specified as key-value pairs.

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.

namestring password required

The name of the notebook.

owningProjectIdstring required

The identifier of the project that owns the notebook.

domainIdstring required

The identifier of the Amazon SageMaker Unified Studio domain.

cellOrderCellInformation[] required

The ordered list of cells in the notebook.

status'ACTIVE' | 'ARCHIVED' required

The status of the notebook.

descriptionstring password

The description of the notebook.

createdAtstring date-time

The timestamp of when the notebook was created.

createdBystring

The identifier of the user who created the notebook.

updatedAtstring date-time

The timestamp of when the notebook was last updated.

updatedBystring

The identifier of the user who last updated the notebook.

lockedBystring

The identifier of the user who locked the notebook.

lockedAtstring date-time

The timestamp of when the notebook was locked.

lockExpiresAtstring date-time

The timestamp of when the notebook lock expires.

computeIdstring

The identifier of the compute associated with the notebook.

metadataobject

The metadata of the notebook.

parametersobject

The sensitive parameters of the notebook.