---
title: "POST /v2/domains/{domainIdentifier}/notebooks"
method: POST
path: "/v2/domains/{domainIdentifier}/notebooks"
---

# POST /v2/domains/{domainIdentifier}/notebooks

`POST /v2/domains/{domainIdentifier}/notebooks`

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.

## Path parameters

- `domainIdentifier` string, required

## Request body

- object
  - `owningProjectIdentifier` string, required — The identifier of the project that owns the notebook.
  - `name` string, password, required — The name of the notebook. The name must be between 1 and 256 characters.
  - `description` string, password — The description of the notebook.
  - `metadata` object — 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.
  - `parameters` object — 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.
  - `clientToken` string — A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

## Response `201`

Success

- CreateNotebookOutput
  - `id` string, required — The identifier of the notebook.
  - `name` string, password, required — The name of the notebook.
  - `owningProjectId` string, required — The identifier of the project that owns the notebook.
  - `domainId` string, required — The identifier of the Amazon SageMaker Unified Studio domain.
  - `cellOrder` CellInformation[], required — The ordered list of cells in the notebook.
  - `status` 'ACTIVE' | 'ARCHIVED', required — The status of the notebook.
  - `description` string, password — The description of the notebook.
  - `createdAt` string, date-time — The timestamp of when the notebook was created.
  - `createdBy` string — The identifier of the user who created the notebook.
  - `updatedAt` string, date-time — The timestamp of when the notebook was last updated.
  - `updatedBy` string — The identifier of the user who last updated the notebook.
  - `lockedBy` string — The identifier of the user who locked the notebook.
  - `lockedAt` string, date-time — The timestamp of when the notebook was locked.
  - `lockExpiresAt` string, date-time — The timestamp of when the notebook lock expires.
  - `computeId` string — The identifier of the compute associated with the notebook.
  - `metadata` object — The metadata of the notebook.
  - `parameters` object — The sensitive parameters of the notebook.
  - `environmentConfiguration` object — The environment configuration of the notebook.
    - `imageVersion` string — The image version for the notebook run environment.
    - `packageConfig` object — The package configuration for the notebook run environment.
      - `packageManager` 'UV', required — The package manager for the notebook run environment. The default value is <code>UV</code>.
      - `packageSpecification` string — The package specification content for the notebook run environment. The maximum length is 10240 characters.
  - `error` object — The error details if the notebook creation failed.
    - `message` string, required — The error message. The maximum length is 256 characters.

## Other responses

- `480` — InternalServerException
- `481` — ResourceNotFoundException
- `482` — AccessDeniedException
- `483` — ThrottlingException
- `484` — ServiceQuotaExceededException
- `485` — ConflictException
- `486` — ValidationException
- `487` — UnauthorizedException

---

[API](https://skmtc.net/aws/apis/datazone.md) · [All operations](https://skmtc.net/aws/apis/datazone/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/datazone/versions/055599054b53/schema)