Sign in

v1

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

Creates a <a href="https://docs.aws.amazon.com/sagemaker-unified-studio/latest/userguide/notebooks.html">notebook</a> in Amazon SageMaker Unified Studio. A notebook is a collaborative document within a project that contains code cells for interactive computing.

post/v2/domains/{domainIdentifier}/notebooks

Path parameters

domainIdentifierstring required

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

Request body

owningProjectIdentifierstring required

The identifier of the project that owns the notebook.

namestring password required

The name of the notebook. The name must be between 1 and 256 characters.

descriptionstring password

The description of the notebook.

metadataobject

The metadata for the notebook, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.

parametersobject

The sensitive parameters for the notebook, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.

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.