Generated by API Evangelist
Written by API Evangelist tooling for Amazon SageMaker's API. It is a proposal applied on top of the contract, not a document Amazon SageMaker publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Amazon SageMaker Notebook Instances API
version: 1.0.0
extends: openapi/amazon-sagemaker-notebook-instances-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/#CreateNotebookInstance'].post
update:
x-apievangelist-phrasing:
intent: Launch a Jupyter notebook instance
effect: write
questions:
- How do I spin up a hosted Jupyter notebook in SageMaker for exploring data?
- Can I put a notebook instance inside my own VPC subnet and security groups?
- What storage volume size can I give a new notebook instance?
instructions:
- text: Create notebook instance {name} on instance type {instance_type} with role {role_arn}.
slots:
name: requestBody.NotebookInstanceName
instance_type: requestBody.InstanceType
role_arn: requestBody.RoleArn
- text: Launch a {instance_type} notebook called {name} using role {role_arn} in subnet {subnet_id} with security groups {security_groups}.
slots:
instance_type: requestBody.InstanceType
name: requestBody.NotebookInstanceName
role_arn: requestBody.RoleArn
subnet_id: requestBody.SubnetId
security_groups: requestBody.SecurityGroupIds
- text: Start a notebook named {name} on {instance_type} with role {role_arn} and a {volume_gb} GB volume.
slots:
name: requestBody.NotebookInstanceName
instance_type: requestBody.InstanceType
role_arn: requestBody.RoleArn
volume_gb: requestBody.VolumeSizeInGB
method: generated
generated: '2026-10-01'
- target: $.paths['/#DescribeNotebookInstance'].post
update:
x-apievangelist-phrasing:
intent: Get the status and settings of one notebook
effect: read
questions:
- Is my Jupyter notebook instance running or stopped right now?
- What instance type and network settings does a particular notebook use?
instructions:
- text: Describe notebook instance {name}.
slots:
name: requestBody.NotebookInstanceName
- text: Check the current status of notebook {name}.
slots:
name: requestBody.NotebookInstanceName
method: generated
generated: '2026-10-01'
- target: $.paths['/#ListNotebookInstances'].post
update:
x-apievangelist-phrasing:
intent: List notebook instances in the account
effect: read
questions:
- Which Jupyter notebook instances exist in my account?
- Can I page through notebook instances sorted by creation time?
instructions:
- text: List all of my notebook instances.
- text: List notebook instances sorted by {sort_by} in {sort_order} order.
slots:
sort_by: requestBody.SortBy
sort_order: requestBody.SortOrder
- text: Show the next {max_results} notebook instances after page token {next_token}.
slots:
max_results: requestBody.MaxResults
next_token: requestBody.NextToken
method: generated
generated: '2026-10-01'
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.