Amazon SageMaker

Amazon SageMaker Notebook Instances API

Operations for managing SageMaker notebook instances.

GitHub OpenAPI

Operations 3

POST /#CreateNotebookInstance Amazon SageMaker Create a Notebook Instance #
POST /#DescribeNotebookInstance Amazon SageMaker Describe a Notebook Instance #
POST /#ListNotebookInstances Amazon SageMaker List Notebook Instances #

Documentation

📖
Documentation
https://docs.aws.amazon.com/sagemaker/latest/APIReference/Welcome.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/amazon-sagemaker/refs/heads/main/openapi/amazon-sagemaker-notebook-instances-api-openapi.yml

Code Examples

💻
CodeExamples
https://github.com/aws/amazon-sagemaker-examples

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amazon-sagemaker/refs/heads/main/json-schema/amazon-sagemaker-notebook-instance-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amazon-sagemaker/refs/heads/main/json-schema/amazon-sagemaker-training-job-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amazon-sagemaker/refs/heads/main/json-schema/amazon-sagemaker-model-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amazon-sagemaker/refs/heads/main/json-schema/amazon-sagemaker-endpoint-schema.json

Other Resources

🔗
SDKs
https://pypi.org/project/sagemaker/
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/amazon-sagemaker/refs/heads/main/graphql/amazon-sagemaker-graphql.md

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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/amazon-sagemaker-notebook-instances-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-sagemaker-notebook-instances-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Amazon SageMaker Endpoints Notebook Instances API
  description: Amazon SageMaker is a fully managed machine learning platform that enables developers and data scientists to build, train, and deploy machine learning models at scale. This API provides programmatic access to SageMaker resources including notebook instances, training jobs, models, and endpoints.
  version: 2017-07-24
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/sagemaker/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://api.sagemaker.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
      description: The AWS region.
tags:
- name: Notebook Instances
  description: Operations for managing SageMaker notebook instances.
paths:
  /#CreateNotebookInstance:
    post:
      operationId: CreateNotebookInstance
      summary: Amazon SageMaker Create a Notebook Instance
      description: Creates an ML compute instance with a Jupyter notebook for exploring data and developing ML models.
      tags:
      - Notebook Instances
      parameters:
      - $ref: '#/components/parameters/XAmzTarget'
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              type: object
              required:
              - NotebookInstanceName
              - InstanceType
              - RoleArn
              properties:
                NotebookInstanceName:
                  type: string
                  description: The name of the notebook instance.
                InstanceType:
                  type: string
                  description: The type of ML compute instance to launch.
                RoleArn:
                  type: string
                  description: The Amazon Resource Name (ARN) of the IAM role.
                SubnetId:
                  type: string
                  description: The ID of the subnet in a VPC.
                SecurityGroupIds:
                  type: array
                  items:
                    type: string
                  description: The VPC security group IDs.
                VolumeSizeInGB:
                  type: integer
                  description: The size of the ML storage volume in GB.
                Tags:
                  type: array
                  items:
                    $ref: '#/components/schemas/Tag'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  NotebookInstanceArn:
                    type: string
              examples:
                CreateNotebookInstance200Example:
                  summary: Default CreateNotebookInstance 200 response
                  x-microcks-default: true
                  value:
                    Status: Success
                    RequestId: abc12345-def6-7890-ghij-klmnopqrstuv
                    RoleArn: arn:aws:iam::123456789012:role/SageMakerRole
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /#DescribeNotebookInstance:
    post:
      operationId: DescribeNotebookInstance
      summary: Amazon SageMaker Describe a Notebook Instance
      description: Returns information about a notebook instance.
      tags:
      - Notebook Instances
      parameters:
      - $ref: '#/components/parameters/XAmzTarget'
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              type: object
              required:
              - NotebookInstanceName
              properties:
                NotebookInstanceName:
                  type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotebookInstance'
              examples:
                DescribeNotebookInstance200Example:
                  summary: Default DescribeNotebookInstance 200 response
                  x-microcks-default: true
                  value:
                    Status: Success
                    RequestId: abc12345-def6-7890-ghij-klmnopqrstuv
                    RoleArn: arn:aws:iam::123456789012:role/SageMakerRole
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /#ListNotebookInstances:
    post:
      operationId: ListNotebookInstances
      summary: Amazon SageMaker List Notebook Instances
      description: Returns a list of the notebook instances in the requester's account.
      tags:
      - Notebook Instances
      parameters:
      - $ref: '#/components/parameters/XAmzTarget'
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              type: object
              properties:
                MaxResults:
                  type: integer
                NextToken:
                  type: string
                SortBy:
                  type: string
                  enum:
                  - Name
                  - CreationTime
                  - Status
                  - LastModifiedTime
                SortOrder:
                  type: string
                  enum:
                  - Ascending
                  - Descending
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  NotebookInstances:
                    type: array
                    items:
                      $ref: '#/components/schemas/NotebookInstance'
                  NextToken:
                    type: string
              examples:
                ListNotebookInstances200Example:
                  summary: Default ListNotebookInstances 200 response
                  x-microcks-default: true
                  value:
                    Status: Success
                    RequestId: abc12345-def6-7890-ghij-klmnopqrstuv
                    RoleArn: arn:aws:iam::123456789012:role/SageMakerRole
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Tag:
      type: object
      properties:
        Key:
          type: string
        Value:
          type: string
    NotebookInstance:
      type: object
      properties:
        NotebookInstanceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the notebook instance.
        NotebookInstanceName:
          type: string
          description: The name of the notebook instance.
        NotebookInstanceStatus:
          type: string
          description: The status of the notebook instance.
          enum:
          - Pending
          - InService
          - Stopping
          - Stopped
          - Failed
          - Deleting
          - Updating
        InstanceType:
          type: string
          description: The type of ML compute instance running the notebook.
        RoleArn:
          type: string
          description: The ARN of the IAM role associated with the instance.
        SubnetId:
          type: string
          description: The ID of the VPC subnet.
        SecurityGroups:
          type: array
          items:
            type: string
          description: The security groups associated with the instance.
        Url:
          type: string
          description: The URL that you use to connect to the Jupyter notebook.
        VolumeSizeInGB:
          type: integer
          description: The size of the ML storage volume in GB.
        CreationTime:
          type: string
          format: date-time
          description: A timestamp indicating when the notebook instance was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: A timestamp indicating when the notebook instance was last modified.
  parameters:
    XAmzTarget:
      name: X-Amz-Target
      in: header
      required: true
      schema:
        type: string
        example: SageMaker.CreateNotebookInstance
      description: The target action for the request, in the format SageMaker.<operation>.