Amazon DataZone Datazone Notebooks API
The Datazone Notebooks API from Amazon DataZone — 2 operation(s) for datazone notebooks.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-datazone:amazon-datazone-notebooks-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Amazon DataZone Notebooks API
version: '2018-05-10'
description: Generated from AWS's published Smithy model for Amazon DataZone. 5 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://datazone.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
tags:
- name: Notebooks
paths:
/v2/domains/{domainIdentifier}/notebooks:
post:
operationId: CreateNotebook
summary: Create Notebook
description: Creates a notebook in Amazon SageMaker Unified Studio. A notebook is a collaborative document within a project that contains code cells for interactive computing.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateNotebookOutput'
'403':
description: AccessDeniedException; AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'402':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'429':
description: ThrottlingException; ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateNotebookInput'
tags:
- Notebooks
get:
operationId: ListNotebooks
summary: List Notebooks
description: Lists notebooks in Amazon SageMaker Unified Studio.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListNotebooksOutput'
'403':
description: AccessDeniedException; AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'429':
description: ThrottlingException; ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListNotebooksInput'
tags:
- Notebooks
/v2/domains/{domainIdentifier}/notebooks/{identifier}:
get:
operationId: GetNotebook
summary: Get Notebook
description: Gets the details of a notebook in Amazon SageMaker Unified Studio.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetNotebookOutput'
'403':
description: AccessDeniedException; AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException; ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetNotebookInput'
tags:
- Notebooks
patch:
operationId: UpdateNotebook
summary: Update Notebook
description: Updates a notebook in Amazon SageMaker Unified Studio.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateNotebookOutput'
'403':
description: AccessDeniedException; AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException; ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateNotebookInput'
tags:
- Notebooks
delete:
operationId: DeleteNotebook
summary: Delete Notebook
description: Deletes a notebook in Amazon SageMaker Unified Studio.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteNotebookOutput'
'403':
description: AccessDeniedException; AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'429':
description: ThrottlingException; ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteNotebookInput'
tags:
- Notebooks
components:
schemas:
GitMetadata:
type: object
properties:
connectionId:
type: string
description: The identifier of the Git connection.
repository:
type: string
description: The name of the Git repository.
branch:
type: string
description: The name of the Git branch.
commitHash:
type: string
description: The commit hash in the Git repository.
fileName:
type: string
description: The name of the file in the Git repository.
committedAt:
type: string
description: The timestamp of when the commit was made.
commitMessage:
type: string
description: The commit message associated with the Git commit.
required:
- connectionId
- repository
- branch
- commitHash
ValidationException:
type: object
properties:
message:
type: string
required:
- message
DeleteNotebookInput:
type: object
properties:
domainIdentifier:
type: string
description: The identifier of the Amazon SageMaker Unified Studio domain in which the notebook exists.
identifier:
type: string
description: The identifier of the notebook to delete.
required:
- domainIdentifier
- identifier
DeleteNotebookOutput:
type: object
properties: {}
ListNotebooksOutput:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/NotebookSummary'
description: The results of the ListNotebooks action.
nextToken:
type: string
description: When the number of notebooks is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of notebooks, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListNotebooks to list the next set of notebooks.
ListNotebooksInput:
type: object
properties:
domainIdentifier:
type: string
description: The identifier of the Amazon SageMaker Unified Studio domain in which to list notebooks.
owningProjectIdentifier:
type: string
description: The identifier of the project that owns the notebooks.
maxResults:
type: integer
description: The maximum number of notebooks to return in a single call. When the number of notebooks exceeds the value of MaxResults, the response contains a NextToken value.
sortOrder:
type: string
enum:
- ASCENDING
- DESCENDING
description: The sort order for the results.
sortBy:
type: string
enum:
- CREATED_AT
- UPDATED_AT
description: The field to sort the results by.
status:
type: string
enum:
- ACTIVE
- ARCHIVED
- SYNC_IN_PROGRESS
- SYNC_FAILED
description: The status to filter notebooks by.
type:
type: string
enum:
- DATA
- SQL
description: The type to filter notebooks by.
nextToken:
type: string
description: When the number of notebooks is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of notebooks, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListNotebooks to list the next set of notebooks.
required:
- domainIdentifier
- owningProjectIdentifier
UnauthorizedException:
type: object
properties:
message:
type: string
required:
- message
EnvironmentConfig:
type: object
properties:
imageVersion:
type: string
description: The image version for the notebook run environment.
packageConfig:
$ref: '#/components/schemas/PackageConfig'
ThrottlingException:
type: object
properties:
message:
type: string
required:
- message
CellInformation:
type: object
properties: {}
GetNotebookOutput:
type: object
properties:
id:
type: string
description: The identifier of the notebook.
name:
type: string
description: The name of the notebook.
owningProjectId:
type: string
description: The identifier of the project that owns the notebook.
domainId:
type: string
description: The identifier of the Amazon SageMaker Unified Studio domain.
cellOrder:
type: array
items:
$ref: '#/components/schemas/CellInformation'
description: The ordered list of cells in the notebook.
status:
type: string
enum:
- ACTIVE
- ARCHIVED
- SYNC_IN_PROGRESS
- SYNC_FAILED
description: The status of the notebook.
type:
type: string
enum:
- DATA
- SQL
description: The type of the notebook.
description:
type: string
description: The description of the notebook.
createdAt:
type: string
format: date-time
description: The timestamp of when the notebook was created.
createdBy:
type: string
description: The identifier of the user who created the notebook.
updatedAt:
type: string
format: date-time
description: The timestamp of when the notebook was last updated.
updatedBy:
type: string
description: The identifier of the user who last updated the notebook.
lockedBy:
type: string
description: The identifier of the user who locked the notebook.
lockedAt:
type: string
description: The timestamp of when the notebook was locked.
lockExpiresAt:
type: string
description: The timestamp of when the notebook lock expires.
computeId:
type: string
description: The identifier of the compute associated with the notebook.
metadata:
type: object
additionalProperties:
type: string
description: The metadata of the notebook.
parameters:
type: object
additionalProperties:
type: string
description: The sensitive parameters of the notebook.
environmentConfiguration:
$ref: '#/components/schemas/EnvironmentConfig'
error:
$ref: '#/components/schemas/NotebookError'
gitMetadata:
$ref: '#/components/schemas/GitMetadata'
required:
- id
- name
- owningProjectId
- domainId
- cellOrder
- status
NotebookError:
type: object
properties:
message:
type: string
description: The error message. The maximum length is 256 characters.
required:
- message
CreateNotebookInput:
type: object
properties:
domainIdentifier:
type: string
description: The identifier of the Amazon SageMaker Unified Studio domain in which to create the notebook.
owningProjectIdentifier:
type: string
description: The identifier of the project that owns the notebook.
name:
type: string
description: The name of the notebook. The name must be between 1 and 256 characters.
description:
type: string
description: The description of the notebook.
type:
type: string
enum:
- DATA
- SQL
description: The type of the notebook.
metadata:
type: object
additionalProperties:
type: string
description: 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:
type: object
additionalProperties:
type: string
description: 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:
type: string
description: A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.
required:
- domainIdentifier
- owningProjectIdentifier
- name
UpdateNotebookOutput:
type: object
properties:
id:
type: string
description: The identifier of the notebook.
name:
type: string
description: The name of the notebook.
owningProjectId:
type: string
description: The identifier of the project that owns the notebook.
domainId:
type: string
description: The identifier of the Amazon SageMaker Unified Studio domain.
cellOrder:
type: array
items:
$ref: '#/components/schemas/CellInformation'
description: The ordered list of cells in the notebook.
status:
type: string
enum:
- ACTIVE
- ARCHIVED
- SYNC_IN_PROGRESS
- SYNC_FAILED
description: The status of the notebook.
type:
type: string
enum:
- DATA
- SQL
description: The type of the notebook.
description:
type: string
description: The description of the notebook.
createdAt:
type: string
format: date-time
description: The timestamp of when the notebook was created.
createdBy:
type: string
description: The identifier of the user who created the notebook.
updatedAt:
type: string
format: date-time
description: The timestamp of when the notebook was last updated.
updatedBy:
type: string
description: The identifier of the user who last updated the notebook.
lockedBy:
type: string
description: The identifier of the user who locked the notebook.
lockedAt:
type: string
description: The timestamp of when the notebook was locked.
lockExpiresAt:
type: string
description: The timestamp of when the notebook lock expires.
computeId:
type: string
description: The identifier of the compute associated with the notebook.
metadata:
type: object
additionalProperties:
type: string
description: The metadata of the notebook.
parameters:
type: object
additionalProperties:
type: string
description: The sensitive parameters of the notebook.
environmentConfiguration:
$ref: '#/components/schemas/EnvironmentConfig'
error:
$ref: '#/components/schemas/NotebookError'
gitMetadata:
$ref: '#/components/schemas/GitMetadata'
required:
- id
- name
- owningProjectId
- domainId
- cellOrder
- status
UpdateNotebookInput:
type: object
properties:
domainIdentifier:
type: string
description: The identifier of the Amazon SageMaker Unified Studio domain in which the notebook exists.
identifier:
type: string
description: The identifier of the notebook to update.
description:
type: string
description: The updated description of the notebook.
status:
type: string
enum:
- ACTIVE
- ARCHIVED
- SYNC_IN_PROGRESS
- SYNC_FAILED
description: The updated status of the notebook.
name:
type: string
description: The updated name of the notebook.
cellOrder:
type: array
items:
$ref: '#/components/schemas/CellInformation'
description: The updated ordered list of cells in the notebook.
type:
type: string
enum:
- DATA
- SQL
description: The updated type of the notebook.
metadata:
type: object
additionalProperties:
type: string
description: The updated metadata for the notebook, specified as key-value pairs.
parameters:
type: object
additionalProperties:
type: string
description: The updated sensitive parameters for the notebook, specified as key-value pairs.
environmentConfiguration:
$ref: '#/components/schemas/EnvironmentConfig'
clientToken:
type: string
description: A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.
required:
- domainIdentifier
- identifier
CreateNotebookOutput:
type: object
properties:
id:
type: string
description: The identifier of the notebook.
name:
type: string
description: The name of the notebook.
owningProjectId:
type: string
description: The identifier of the project that owns the notebook.
domainId:
type: string
description: The identifier of the Amazon SageMaker Unified Studio domain.
cellOrder:
type: array
items:
$ref: '#/components/schemas/CellInformation'
description: The ordered list of cells in the notebook.
status:
type: string
enum:
- ACTIVE
- ARCHIVED
- SYNC_IN_PROGRESS
- SYNC_FAILED
description: The status of the notebook.
type:
type: string
enum:
- DATA
- SQL
description: The type of the notebook.
description:
type: string
description: The description of the notebook.
createdAt:
type: string
format: date-time
description: The timestamp of when the notebook was created.
createdBy:
type: string
description: The identifier of the user who created the notebook.
updatedAt:
type: string
format: date-time
description: The timestamp of when the notebook was last updated.
updatedBy:
type: string
description: The identifier of the user who last updated the notebook.
lockedBy:
type: string
description: The identifier of the user who locked the notebook.
lockedAt:
type: string
description: The timestamp of when the notebook was locked.
lockExpiresAt:
type: string
description: The timestamp of when the notebook lock expires.
computeId:
type: string
description: The identifier of the compute associated with the notebook.
metadata:
type: object
additionalProperties:
type: string
description: The metadata of the notebook.
parameters:
type: object
additionalProperties:
type: string
description: The sensitive parameters of the notebook.
environmentConfiguration:
$ref: '#/components/schemas/EnvironmentConfig'
error:
$ref: '#/components/schemas/NotebookError'
gitMetadata:
$ref: '#/components/schemas/GitMetadata'
required:
- id
- name
- owningProjectId
- domainId
- cellOrder
- status
AccessDeniedException:
type: object
properties:
message:
type: string
required:
- message
NotebookSummary:
type: object
properties:
id:
type: string
description: The identifier of the notebook.
name:
type: string
description: The name of the notebook.
owningProjectId:
type: string
description: The identifier of the project that owns the notebook.
domainId:
type: string
description: The identifier of the Amazon SageMaker Unified Studio domain.
status:
type: string
enum:
- ACTIVE
- ARCHIVED
- SYNC_IN_PROGRESS
- SYNC_FAILED
description: The status of the notebook.
type:
type: string
enum:
- DATA
- SQL
description: The type of the notebook.
description:
type: string
description: The description of the notebook.
createdAt:
type: string
format: date-time
description: The timestamp of when the notebook was created.
createdBy:
type: string
description: The identifier of the user who created the notebook.
updatedAt:
type: string
format: date-time
description: The timestamp of when the notebook was last updated.
updatedBy:
type: string
description: The identifier of the user who last updated the notebook.
required:
- id
- name
- owningProjectId
- domainId
- status
InternalServerException:
type: object
properties:
message:
type: string
required:
- message
ResourceNotFoundException:
type: object
properties:
message:
type: string
required:
- message
PackageConfig:
type: object
properties:
packageManager:
type: string
enum:
- UV
description: The package manager for the notebook run environment. The default value is UV.
packageSpecification:
type: string
description: The package specification content for the notebook run environment. The maximum length is 10240 characters.
required:
- packageManager
ServiceQuotaExceededException:
type: object
properties:
message:
type: string
required:
- message
GetNotebookInput:
type: object
properties:
domainIdentifier:
type: string
description: The identifier of the Amazon SageMaker Unified Studio domain in which the notebook exists.
identifier:
type: string
description: The identifier of the notebook.
required:
- domainIdentifier
- identifier
ConflictException:
type: object
properties:
message:
type: string
required:
- message
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: datazone
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/datazone/service/2018-05-10/datazone-2018-05-10.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)