Amazon SageMaker

Amazon SageMaker Sagemaker App API

The Sagemaker App API from Amazon SageMaker — 4 operation(s) for sagemaker app.

GitHub OpenAPI

Operations 4

POST /#CreateApp Create App #
POST /#DeleteApp Delete App #
POST /#DescribeApp Describe App #
POST /#ListApps List Apps #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-sagemaker/openapi/amazon-sagemaker-app-api-openapi.yml

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:amazon-sagemaker-app-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.

GitHub Google LinkedIn

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

OpenAPI Specification

amazon-sagemaker-app-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Amazon SageMaker Service App API
  version: '2017-07-24'
  description: Generated from AWS's published Smithy model for Amazon SageMaker Service. 4 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://api.sagemaker.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateApp:
    post:
      operationId: CreateApp
      summary: Create App
      description: Creates a running app for the specified UserProfile. This operation is automatically invoked by Amazon
        SageMaker AI upon access to the associated Domain, and when new kernel configurations are selected by the user. A
        user may have multiple Apps active simultaneously.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateAppResponse'
        '400':
          description: ResourceInUse; ResourceLimitExceeded
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceInUse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.CreateApp
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateAppRequest'
      tags:
      - App
  /#DeleteApp:
    post:
      operationId: DeleteApp
      summary: Delete App
      description: Used to stop and delete an app.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '400':
          description: ResourceInUse; ResourceNotFound
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceInUse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.DeleteApp
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteAppRequest'
      tags:
      - App
  /#DescribeApp:
    post:
      operationId: DescribeApp
      summary: Describe App
      description: Describes the app.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeAppResponse'
        '400':
          description: ResourceNotFound
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFound'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.DescribeApp
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeAppRequest'
      tags:
      - App
  /#ListApps:
    post:
      operationId: ListApps
      summary: List Apps
      description: Lists apps.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListAppsResponse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.ListApps
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListAppsRequest'
      tags:
      - App
components:
  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: sagemaker
  schemas:
    AppDetails:
      type: object
      properties:
        DomainId:
          type: string
          description: The domain ID.
        UserProfileName:
          type: string
          description: The user profile name.
        SpaceName:
          type: string
          description: The name of the space.
        AppType:
          type: string
          enum:
          - JupyterServer
          - KernelGateway
          - DetailedProfiler
          - TensorBoard
          - CodeEditor
          - JupyterLab
          - RStudioServerPro
          - RSessionGateway
          - Canvas
          description: The type of app.
        AppName:
          type: string
          description: The name of the app.
        Status:
          type: string
          enum:
          - Deleted
          - Deleting
          - Failed
          - InService
          - Pending
          description: The status.
        CreationTime:
          type: string
          format: date-time
          description: The creation time.
        ResourceSpec:
          $ref: '#/components/schemas/ResourceSpec'
    CreateAppRequest:
      type: object
      properties:
        DomainId:
          type: string
          description: The domain ID.
        UserProfileName:
          type: string
          description: The user profile name. If this value is not set, then SpaceName must be set.
        SpaceName:
          type: string
          description: The name of the space. If this value is not set, then UserProfileName must be set.
        AppType:
          type: string
          enum:
          - JupyterServer
          - KernelGateway
          - DetailedProfiler
          - TensorBoard
          - CodeEditor
          - JupyterLab
          - RStudioServerPro
          - RSessionGateway
          - Canvas
          description: The type of app.
        AppName:
          type: string
          description: The name of the app.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Each tag consists of a key and an optional value. Tag keys must be unique per resource.
        ResourceSpec:
          $ref: '#/components/schemas/ResourceSpec'
        RecoveryMode:
          type: boolean
          description: Indicates whether the application is launched in recovery mode.
      required:
      - DomainId
      - AppType
      - AppName
    CreateAppResponse:
      type: object
      properties:
        AppArn:
          type: string
          description: The Amazon Resource Name (ARN) of the app.
    DeleteAppRequest:
      type: object
      properties:
        DomainId:
          type: string
          description: The domain ID.
        UserProfileName:
          type: string
          description: The user profile name. If this value is not set, then SpaceName must be set.
        SpaceName:
          type: string
          description: The name of the space. If this value is not set, then UserProfileName must be set.
        AppType:
          type: string
          enum:
          - JupyterServer
          - KernelGateway
          - DetailedProfiler
          - TensorBoard
          - CodeEditor
          - JupyterLab
          - RStudioServerPro
          - RSessionGateway
          - Canvas
          description: The type of app.
        AppName:
          type: string
          description: The name of the app.
      required:
      - DomainId
      - AppType
      - AppName
    DescribeAppRequest:
      type: object
      properties:
        DomainId:
          type: string
          description: The domain ID.
        UserProfileName:
          type: string
          description: The user profile name. If this value is not set, then SpaceName must be set.
        SpaceName:
          type: string
          description: The name of the space.
        AppType:
          type: string
          enum:
          - JupyterServer
          - KernelGateway
          - DetailedProfiler
          - TensorBoard
          - CodeEditor
          - JupyterLab
          - RStudioServerPro
          - RSessionGateway
          - Canvas
          description: The type of app.
        AppName:
          type: string
          description: The name of the app.
      required:
      - DomainId
      - AppType
      - AppName
    DescribeAppResponse:
      type: object
      properties:
        AppArn:
          type: string
          description: The Amazon Resource Name (ARN) of the app.
        AppType:
          type: string
          enum:
          - JupyterServer
          - KernelGateway
          - DetailedProfiler
          - TensorBoard
          - CodeEditor
          - JupyterLab
          - RStudioServerPro
          - RSessionGateway
          - Canvas
          description: The type of app.
        AppName:
          type: string
          description: The name of the app.
        DomainId:
          type: string
          description: The domain ID.
        UserProfileName:
          type: string
          description: The user profile name.
        SpaceName:
          type: string
          description: The name of the space. If this value is not set, then UserProfileName must be set.
        Status:
          type: string
          enum:
          - Deleted
          - Deleting
          - Failed
          - InService
          - Pending
          description: The status.
        EffectiveTrustedIdentityPropagationStatus:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: The effective status of Trusted Identity Propagation (TIP) for this application. When enabled, user
            identities from IAM Identity Center are being propagated through the application to TIP enabled Amazon Web Services
            services. When disabled, standard IAM role-based access is used.
        RecoveryMode:
          type: boolean
          description: Indicates whether the application is launched in recovery mode.
        LastHealthCheckTimestamp:
          type: string
          format: date-time
          description: The timestamp of the last health check.
        LastUserActivityTimestamp:
          type: string
          format: date-time
          description: The timestamp of the last user's activity. LastUserActivityTimestamp is also updated when SageMaker
            AI performs health checks without user activity. As a result, this value is set to the same value as LastHealthCheckTimestamp.
        CreationTime:
          type: string
          format: date-time
          description: The creation time of the application. After an application has been shut down for 24 hours, SageMaker
            AI deletes all metadata for the application. To be considered an update and retain application metadata, applications
            must be restarted within 24 hours after the previous application has been shut down. After this time window, creation
            of an application is considered a new application rather than an update of the previous application.
        FailureReason:
          type: string
          description: The failure reason.
        ResourceSpec:
          $ref: '#/components/schemas/ResourceSpec'
        BuiltInLifecycleConfigArn:
          type: string
          description: The lifecycle configuration that runs before the default lifecycle configuration
    ListAppsRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: If the previous response was truncated, you will receive this token. Use it in your next request to
            receive the next set of results.
        MaxResults:
          type: integer
          description: This parameter defines the maximum number of results that can be return in a single response. The MaxResults
            parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken
            is provided in the response. The NextToken indicates that the user should get the next set of results by providing
            this token as a part of a subsequent call. The default value for MaxResults is 10.
        SortOrder:
          type: string
          enum:
          - Ascending
          - Descending
          description: The sort order for the results. The default is Ascending.
        SortBy:
          type: string
          enum:
          - CreationTime
          description: The parameter by which to sort the results. The default is CreationTime.
        DomainIdEquals:
          type: string
          description: A parameter to search for the domain ID.
        UserProfileNameEquals:
          type: string
          description: A parameter to search by user profile name. If SpaceNameEquals is set, then this value cannot be set.
        SpaceNameEquals:
          type: string
          description: A parameter to search by space name. If UserProfileNameEquals is set, then this value cannot be set.
    ListAppsResponse:
      type: object
      properties:
        Apps:
          type: array
          items:
            $ref: '#/components/schemas/AppDetails'
          description: The list of apps.
        NextToken:
          type: string
          description: If the previous response was truncated, you will receive this token. Use it in your next request to
            receive the next set of results.
    ResourceInUse:
      type: object
      properties:
        Message:
          type: string
    ResourceNotFound:
      type: object
      properties:
        Message:
          type: string
    ResourceSpec:
      type: object
      properties:
        SageMakerImageArn:
          type: string
          description: The ARN of the SageMaker AI image that the image version belongs to.
        SageMakerImageVersionArn:
          type: string
          description: The ARN of the image version created on the instance. To clear the value set for SageMakerImageVersionArn,
            pass None as the value.
        SageMakerImageVersionAlias:
          type: string
          description: The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning
            format.
        InstanceType:
          type: string
          enum:
          - system
          - ml.t3.micro
          - ml.t3.small
          - ml.t3.medium
          - ml.t3.large
          - ml.t3.xlarge
          - ml.t3.2xlarge
          - ml.m5.large
          - ml.m5.xlarge
          - ml.m5.2xlarge
          - ml.m5.4xlarge
          - ml.m5.8xlarge
          - ml.m5.12xlarge
          - ml.m5.16xlarge
          - ml.m5.24xlarge
          - ml.m5d.large
          - ml.m5d.xlarge
          - ml.m5d.2xlarge
          - ml.m5d.4xlarge
          - ml.m5d.8xlarge
          - ml.m5d.12xlarge
          - ml.m5d.16xlarge
          - ml.m5d.24xlarge
          - ml.c5.large
          - ml.c5.xlarge
          - ml.c5.2xlarge
          - ml.c5.4xlarge
          - ml.c5.9xlarge
          - ml.c5.12xlarge
          - ml.c5.18xlarge
          - ml.c5.24xlarge
          - ml.p3.2xlarge
          - ml.p3.8xlarge
          - ml.p3.16xlarge
          - ml.p3dn.24xlarge
          - ml.g4dn.xlarge
          - ml.g4dn.2xlarge
          - ml.g4dn.4xlarge
          - ml.g4dn.8xlarge
          - ml.g4dn.12xlarge
          - ml.g4dn.16xlarge
          - ml.r5.large
          - ml.r5.xlarge
          - ml.r5.2xlarge
          - ml.r5.4xlarge
          - ml.r5.8xlarge
          - ml.r5.12xlarge
          - ml.r5.16xlarge
          - ml.r5.24xlarge
          - ml.g5.xlarge
          - ml.g5.2xlarge
          - ml.g5.4xlarge
          - ml.g5.8xlarge
          - ml.g5.16xlarge
          - ml.g5.12xlarge
          - ml.g5.24xlarge
          - ml.g5.48xlarge
          - ml.g6.xlarge
          - ml.g6.2xlarge
          - ml.g6.4xlarge
          - ml.g6.8xlarge
          - ml.g6.12xlarge
          - ml.g6.16xlarge
          - ml.g6.24xlarge
          - ml.g6.48xlarge
          - ml.g6e.xlarge
          - ml.g6e.2xlarge
          - ml.g6e.4xlarge
          - ml.g6e.8xlarge
          - ml.g6e.12xlarge
          - ml.g6e.16xlarge
          - ml.g6e.24xlarge
          - ml.g6e.48xlarge
          - ml.geospatial.interactive
          - ml.p4d.24xlarge
          - ml.p4de.24xlarge
          - ml.trn1.2xlarge
          - ml.trn1.32xlarge
          - ml.trn1n.32xlarge
          - ml.p5.48xlarge
          - ml.p5en.48xlarge
          - ml.p6-b200.48xlarge
          - ml.m6i.large
          - ml.m6i.xlarge
          - ml.m6i.2xlarge
          - ml.m6i.4xlarge
          - ml.m6i.8xlarge
          - ml.m6i.12xlarge
          - ml.m6i.16xlarge
          - ml.m6i.24xlarge
          - ml.m6i.32xlarge
          - ml.m7i.large
          - ml.m7i.xlarge
          - ml.m7i.2xlarge
          - ml.m7i.4xlarge
          - ml.m7i.8xlarge
          - ml.m7i.12xlarge
          - ml.m7i.16xlarge
          - ml.m7i.24xlarge
          - ml.m7i.48xlarge
          - ml.c6i.large
          - ml.c6i.xlarge
          - ml.c6i.2xlarge
          - ml.c6i.4xlarge
          - ml.c6i.8xlarge
          - ml.c6i.12xlarge
          - ml.c6i.16xlarge
          - ml.c6i.24xlarge
          - ml.c6i.32xlarge
          - ml.c7i.large
          - ml.c7i.xlarge
          - ml.c7i.2xlarge
          - ml.c7i.4xlarge
          - ml.c7i.8xlarge
          - ml.c7i.12xlarge
          - ml.c7i.16xlarge
          - ml.c7i.24xlarge
          - ml.c7i.48xlarge
          - ml.r6i.large
          - ml.r6i.xlarge
          - ml.r6i.2xlarge
          - ml.r6i.4xlarge
          - ml.r6i.8xlarge
          - ml.r6i.12xlarge
          - ml.r6i.16xlarge
          - ml.r6i.24xlarge
          - ml.r6i.32xlarge
          - ml.r7i.large
          - ml.r7i.xlarge
          - ml.r7i.2xlarge
          - ml.r7i.4xlarge
          - ml.r7i.8xlarge
          - ml.r7i.12xlarge
          - ml.r7i.16xlarge
          - ml.r7i.24xlarge
          - ml.r7i.48xlarge
          - ml.m6id.large
          - ml.m6id.xlarge
          - ml.m6id.2xlarge
          - ml.m6id.4xlarge
          - ml.m6id.8xlarge
          - ml.m6id.12xlarge
          - ml.m6id.16xlarge
          - ml.m6id.24xlarge
          - ml.m6id.32xlarge
          - ml.c6id.large
          - ml.c6id.xlarge
          - ml.c6id.2xlarge
          - ml.c6id.4xlarge
          - ml.c6id.8xlarge
          - ml.c6id.12xlarge
          - ml.c6id.16xlarge
          - ml.c6id.24xlarge
          - ml.c6id.32xlarge
          - ml.r6id.large
          - ml.r6id.xlarge
          - ml.r6id.2xlarge
          - ml.r6id.4xlarge
          - ml.r6id.8xlarge
          - ml.r6id.12xlarge
          - ml.r6id.16xlarge
          - ml.r6id.24xlarge
          - ml.r6id.32xlarge
          - ml.p5.4xlarge
          - ml.g7.2xlarge
          - ml.g7.4xlarge
          - ml.g7.8xlarge
          - ml.g7.12xlarge
          - ml.g7.24xlarge
          - ml.g7.48xlarge
          - ml.g7e.2xlarge
          - ml.g7e.4xlarge
          - ml.g7e.8xlarge
          - ml.g7e.12xlarge
          - ml.g7e.24xlarge
          - ml.g7e.48xlarge
          description: The instance type that the image version runs on. JupyterServer apps only support the system value.
            For KernelGateway apps, the system value is translated to ml.t3.medium. KernelGateway apps also support all other
            values for available instance types.
        LifecycleConfigArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
        TrainingPlanArn:
          type: string
          description: The ARN of the SageMaker AI Training Plan to use for this app. When you specify a training plan, the
            app launches on reserved GPU capacity. This field is supported for JupyterLab and CodeEditor app types. For more
            information about how to reserve GPU capacity with SageMaker AI Training Plans, see Using training plans in Studio
            applications.
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The tag key. Tag keys must be unique per resource.
        Value:
          type: string
          description: The tag value.
      required:
      - Key
      - Value
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/sagemaker/service/2017-07-24/sagemaker-2017-07-24.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)