v1

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

Starts a notebook export in Amazon SageMaker Unified Studio. This operation exports a notebook to a specified file format and stores the output in Amazon Simple Storage Service.

post/v2/domains/{domainIdentifier}/notebook-exports

Path parameters

domainIdentifierstring required

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

Request body

notebookIdentifierstring required

The identifier of the notebook to export.

owningProjectIdentifierstring required

The identifier of the project that owns the notebook.

fileFormat'PDF' | 'IPYNB' required

The file format for a notebook export in Amazon SageMaker Unified Studio.

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 export.

domainIdstring required

The identifier of the Amazon SageMaker Unified Studio domain.

owningProjectIdstring required

The identifier of the project that owns the notebook.

notebookIdstring required

The identifier of the notebook.

fileFormat'PDF' | 'IPYNB' required

The file format of the notebook export.

status'IN_PROGRESS' | 'SUCCEEDED' | 'FAILED' required

The status of the notebook export.

createdAtstring date-time

The timestamp of when the notebook export was started.

createdBystring

The identifier of the user who started the notebook export.