Amazon SageMaker · JSON Structure

Amazon Sagemaker Notebook Instance Structure

NotebookInstance schema from Amazon SageMaker API

Type: object Properties: 11
AIInferenceMachine LearningMLOpsTraining

NotebookInstance is a JSON Structure definition published by Amazon SageMaker, describing 11 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

NotebookInstanceArn NotebookInstanceName NotebookInstanceStatus InstanceType RoleArn SubnetId SecurityGroups Url VolumeSizeInGB CreationTime LastModifiedTime

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-sagemaker/refs/heads/main/json-structure/amazon-sagemaker-notebook-instance-structure.json",
  "name": "NotebookInstance",
  "description": "NotebookInstance schema from Amazon SageMaker API",
  "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": "int32",
      "description": "The size of the ML storage volume in GB."
    },
    "CreationTime": {
      "type": "datetime",
      "description": "A timestamp indicating when the notebook instance was created."
    },
    "LastModifiedTime": {
      "type": "datetime",
      "description": "A timestamp indicating when the notebook instance was last modified."
    }
  }
}