Amazon SageMaker

Amazon SageMaker Sagemaker Experiment API

The Sagemaker Experiment API from Amazon SageMaker — 5 operation(s) for sagemaker experiment.

GitHub OpenAPI
Business capability
Artificial Intelligence Management BC-610.60

Operations 5

POST /#CreateExperiment Create Experiment #
POST /#DeleteExperiment Delete Experiment #
POST /#DescribeExperiment Describe Experiment #
POST /#ListExperiments List Experiments #
POST /#UpdateExperiment Update Experiment #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-sagemaker/openapi/amazon-sagemaker-experiment-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-experiment-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-experiment-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Amazon SageMaker Service Experiment API
  version: '2017-07-24'
  description: Generated from AWS's published Smithy model for Amazon SageMaker Service. 5 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:
  /#CreateExperiment:
    post:
      operationId: CreateExperiment
      summary: Create Experiment
      description: Creates a SageMaker experiment. An experiment is a collection of trials that are observed, compared and
        evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model. In
        the Studio UI, trials are referred to as run groups and trial components are referred to as runs. The goal of an experiment
        is to determine the components that produce the best model. Multiple trials are performed, each one isolating and
        measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant. When you use
        SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked,
        logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided
        by the SDK. You can add tags to experiments, trials, trial components and then use the Search API to search for the
        tags. To add a description to an experiment, specify the optional Description parameter. To add a description later,
        or to change the description, call the UpdateExperiment API. To get a list of all your experiments, call the ListExperiments
        API. To view an experiment's pr
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateExperimentResponse'
        '400':
          description: ResourceLimitExceeded
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceLimitExceeded'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.CreateExperiment
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateExperimentRequest'
      tags:
      - Experiment
  /#DeleteExperiment:
    post:
      operationId: DeleteExperiment
      summary: Delete Experiment
      description: Deletes an SageMaker experiment. All trials associated with the experiment must be deleted first. Use the
        ListTrials API to get a list of the trials associated with the experiment.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteExperimentResponse'
        '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.DeleteExperiment
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteExperimentRequest'
      tags:
      - Experiment
  /#DescribeExperiment:
    post:
      operationId: DescribeExperiment
      summary: Describe Experiment
      description: Provides a list of an experiment's properties.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeExperimentResponse'
        '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.DescribeExperiment
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeExperimentRequest'
      tags:
      - Experiment
  /#ListExperiments:
    post:
      operationId: ListExperiments
      summary: List Experiments
      description: Lists all the experiments in your account. The list can be filtered to show only experiments that were
        created in a specific time range. The list can be sorted by experiment name or creation time.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListExperimentsResponse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.ListExperiments
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListExperimentsRequest'
      tags:
      - Experiment
  /#UpdateExperiment:
    post:
      operationId: UpdateExperiment
      summary: Update Experiment
      description: Adds, updates, or removes the description of an experiment. Updates the display name of an experiment.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateExperimentResponse'
        '400':
          description: ConflictException; ResourceNotFound
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.UpdateExperiment
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateExperimentRequest'
      tags:
      - Experiment
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:
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    CreateExperimentRequest:
      type: object
      properties:
        ExperimentName:
          type: string
          description: The name of the experiment. The name must be unique in your Amazon Web Services account and is not
            case-sensitive.
        DisplayName:
          type: string
          description: The name of the experiment as displayed. The name doesn't need to be unique. If you don't specify DisplayName,
            the value in ExperimentName is displayed.
        Description:
          type: string
          description: The description of the experiment.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags to associate with the experiment. You can use Search API to search on the tags.
      required:
      - ExperimentName
    CreateExperimentResponse:
      type: object
      properties:
        ExperimentArn:
          type: string
          description: The Amazon Resource Name (ARN) of the experiment.
    DeleteExperimentRequest:
      type: object
      properties:
        ExperimentName:
          type: string
          description: The name of the experiment to delete.
      required:
      - ExperimentName
    DeleteExperimentResponse:
      type: object
      properties:
        ExperimentArn:
          type: string
          description: The Amazon Resource Name (ARN) of the experiment that is being deleted.
    DescribeExperimentRequest:
      type: object
      properties:
        ExperimentName:
          type: string
          description: The name of the experiment to describe.
      required:
      - ExperimentName
    DescribeExperimentResponse:
      type: object
      properties:
        ExperimentName:
          type: string
          description: The name of the experiment.
        ExperimentArn:
          type: string
          description: The Amazon Resource Name (ARN) of the experiment.
        DisplayName:
          type: string
          description: The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.
        Source:
          $ref: '#/components/schemas/ExperimentSource'
        Description:
          type: string
          description: The description of the experiment.
        CreationTime:
          type: string
          format: date-time
          description: When the experiment was created.
        CreatedBy:
          $ref: '#/components/schemas/UserContext'
        LastModifiedTime:
          type: string
          format: date-time
          description: When the experiment was last modified.
        LastModifiedBy:
          $ref: '#/components/schemas/UserContext'
    ExperimentSource:
      type: object
      properties:
        SourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the source.
        SourceType:
          type: string
          description: The source type.
      required:
      - SourceArn
    ExperimentSummary:
      type: object
      properties:
        ExperimentArn:
          type: string
          description: The Amazon Resource Name (ARN) of the experiment.
        ExperimentName:
          type: string
          description: The name of the experiment.
        DisplayName:
          type: string
          description: The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.
        ExperimentSource:
          $ref: '#/components/schemas/ExperimentSource'
        CreationTime:
          type: string
          format: date-time
          description: When the experiment was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: When the experiment was last modified.
    IamIdentity:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM identity.
        PrincipalId:
          type: string
          description: The ID of the principal that assumes the IAM identity.
        SourceIdentity:
          type: string
          description: The person or application which assumes the IAM identity.
    ListExperimentsRequest:
      type: object
      properties:
        CreatedAfter:
          type: string
          format: date-time
          description: A filter that returns only experiments created after the specified time.
        CreatedBefore:
          type: string
          format: date-time
          description: A filter that returns only experiments created before the specified time.
        SortBy:
          type: string
          enum:
          - Name
          - CreationTime
          description: The property used to sort results. The default value is CreationTime.
        SortOrder:
          type: string
          enum:
          - Ascending
          - Descending
          description: The sort order. The default value is Descending.
        NextToken:
          type: string
          description: If the previous call to ListExperiments didn't return the full set of experiments, the call returns
            a token for getting the next set of experiments.
        MaxResults:
          type: integer
          description: The maximum number of experiments to return in the response. The default value is 10.
    ListExperimentsResponse:
      type: object
      properties:
        ExperimentSummaries:
          type: array
          items:
            $ref: '#/components/schemas/ExperimentSummary'
          description: A list of the summaries of your experiments.
        NextToken:
          type: string
          description: A token for getting the next set of experiments, if there are any.
    ResourceLimitExceeded:
      type: object
      properties:
        Message:
          type: string
    ResourceNotFound:
      type: object
      properties:
        Message:
          type: string
    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
    UpdateExperimentRequest:
      type: object
      properties:
        ExperimentName:
          type: string
          description: The name of the experiment to update.
        DisplayName:
          type: string
          description: The name of the experiment as displayed. The name doesn't need to be unique. If DisplayName isn't specified,
            ExperimentName is displayed.
        Description:
          type: string
          description: The description of the experiment.
      required:
      - ExperimentName
    UpdateExperimentResponse:
      type: object
      properties:
        ExperimentArn:
          type: string
          description: The Amazon Resource Name (ARN) of the experiment.
    UserContext:
      type: object
      properties:
        UserProfileArn:
          type: string
          description: The Amazon Resource Name (ARN) of the user's profile.
        UserProfileName:
          type: string
          description: The name of the user's profile.
        DomainId:
          type: string
          description: The domain associated with the user.
        IamIdentity:
          $ref: '#/components/schemas/IamIdentity'
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)