Amazon SageMaker · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Amazon SageMaker Models API

4 actions 4 updates phrasing extends openapi/amazon-sagemaker-models-api-openapi.yml

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.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/#CreateModel'].post

$.paths['/#DescribeModel'].post

$.paths['/#ListModels'].post

OpenAPI Overlay

# 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 Models API
  version: 1.0.0
extends: openapi/amazon-sagemaker-models-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['/#CreateModel'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a model with its inference container
      effect: write
      questions:
      - How do I register my model artifacts and inference code so SageMaker can host them?
      - Which IAM role does a model need when I register it?
      - Can I set environment variables on the container a model runs in?
      instructions:
      - text: Create a model named {model_name} that runs with role {role_arn}.
        slots:
          model_name: requestBody.ModelName
          role_arn: requestBody.ExecutionRoleArn
      - text: Register model {model_name} using primary container {container} and execution role {role_arn}.
        slots:
          model_name: requestBody.ModelName
          container: requestBody.PrimaryContainer
          role_arn: requestBody.ExecutionRoleArn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/#DescribeModel'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up one registered model
      effect: read
      questions:
      - What container image and execution role is a given model set up with?
      - Where are the artifacts for a model I already registered stored?
      instructions:
      - text: Describe model {model_name}.
        slots:
          model_name: requestBody.ModelName
      - text: Show the primary container and role for model {model_name}.
        slots:
          model_name: requestBody.ModelName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/#ListModels'].post
  update:
    x-apievangelist-phrasing:
      intent: List registered models
      effect: read
      questions:
      - Which models have I registered in SageMaker so far?
      - Can I sort my registered models by name or creation time?
      instructions:
      - text: List all of my registered models.
      - text: List my models sorted by {sort_by} in {sort_order} order, {max_results} at a time.
        slots:
          sort_by: requestBody.SortBy
          sort_order: requestBody.SortOrder
          max_results: requestBody.MaxResults
      method: generated
      generated: '2026-10-01'