Amazon SageMaker

Amazon SageMaker Sagemaker Trial API

The Sagemaker Trial API from Amazon SageMaker — 5 operation(s) for sagemaker trial.

GitHub OpenAPI

Operations 5

POST /#CreateTrial Create Trial #
POST /#DeleteTrial Delete Trial #
POST /#DescribeTrial Describe Trial #
POST /#ListTrials List Trials #
POST /#UpdateTrial Update Trial #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-sagemaker/openapi/amazon-sagemaker-trial-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-trial-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-trial-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Amazon SageMaker Service Trial 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:
  /#CreateTrial:
    post:
      operationId: CreateTrial
      summary: Create Trial
      description: Creates an SageMaker trial. A trial is a set of steps called trial components that produce a machine learning
        model. A trial is part of a single SageMaker experiment. 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 a trial
        and then use the Search API to search for the tags. To get a list of all your trials, call the ListTrials API. To
        view a trial's properties, call the DescribeTrial API. To create a trial component, call the CreateTrialComponent
        API.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateTrialResponse'
        '400':
          description: ResourceLimitExceeded; ResourceNotFound
          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.CreateTrial
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateTrialRequest'
      tags:
      - Trial
  /#DeleteTrial:
    post:
      operationId: DeleteTrial
      summary: Delete Trial
      description: Deletes the specified trial. All trial components that make up the trial must be deleted first. Use the
        DescribeTrialComponent API to get the list of trial components.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteTrialResponse'
        '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.DeleteTrial
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteTrialRequest'
      tags:
      - Trial
  /#DescribeTrial:
    post:
      operationId: DescribeTrial
      summary: Describe Trial
      description: Provides a list of a trial's properties.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeTrialResponse'
        '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.DescribeTrial
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeTrialRequest'
      tags:
      - Trial
  /#ListTrials:
    post:
      operationId: ListTrials
      summary: List Trials
      description: Lists the trials in your account. Specify an experiment name to limit the list to the trials that are part
        of that experiment. Specify a trial component name to limit the list to the trials that associated with that trial
        component. The list can be filtered to show only trials that were created in a specific time range. The list can be
        sorted by trial name or creation time.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListTrialsResponse'
        '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.ListTrials
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListTrialsRequest'
      tags:
      - Trial
  /#UpdateTrial:
    post:
      operationId: UpdateTrial
      summary: Update Trial
      description: Updates the display name of a trial.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateTrialResponse'
        '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.UpdateTrial
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateTrialRequest'
      tags:
      - Trial
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
    CreateTrialRequest:
      type: object
      properties:
        TrialName:
          type: string
          description: The name of the trial. The name must be unique in your Amazon Web Services account and is not case-sensitive.
        DisplayName:
          type: string
          description: The name of the trial as displayed. The name doesn't need to be unique. If DisplayName isn't specified,
            TrialName is displayed.
        ExperimentName:
          type: string
          description: The name of the experiment to associate the trial with.
        MetadataProperties:
          $ref: '#/components/schemas/MetadataProperties'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags to associate with the trial. You can use Search API to search on the tags.
      required:
      - TrialName
      - ExperimentName
    CreateTrialResponse:
      type: object
      properties:
        TrialArn:
          type: string
          description: The Amazon Resource Name (ARN) of the trial.
    DeleteTrialRequest:
      type: object
      properties:
        TrialName:
          type: string
          description: The name of the trial to delete.
      required:
      - TrialName
    DeleteTrialResponse:
      type: object
      properties:
        TrialArn:
          type: string
          description: The Amazon Resource Name (ARN) of the trial that is being deleted.
    DescribeTrialRequest:
      type: object
      properties:
        TrialName:
          type: string
          description: The name of the trial to describe.
      required:
      - TrialName
    DescribeTrialResponse:
      type: object
      properties:
        TrialName:
          type: string
          description: The name of the trial.
        TrialArn:
          type: string
          description: The Amazon Resource Name (ARN) of the trial.
        DisplayName:
          type: string
          description: The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.
        ExperimentName:
          type: string
          description: The name of the experiment the trial is part of.
        Source:
          $ref: '#/components/schemas/TrialSource'
        CreationTime:
          type: string
          format: date-time
          description: When the trial was created.
        CreatedBy:
          $ref: '#/components/schemas/UserContext'
        LastModifiedTime:
          type: string
          format: date-time
          description: When the trial was last modified.
        LastModifiedBy:
          $ref: '#/components/schemas/UserContext'
        MetadataProperties:
          $ref: '#/components/schemas/MetadataProperties'
    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.
    ListTrialsRequest:
      type: object
      properties:
        ExperimentName:
          type: string
          description: A filter that returns only trials that are part of the specified experiment.
        TrialComponentName:
          type: string
          description: A filter that returns only trials that are associated with the specified trial component.
        CreatedAfter:
          type: string
          format: date-time
          description: A filter that returns only trials created after the specified time.
        CreatedBefore:
          type: string
          format: date-time
          description: A filter that returns only trials 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.
        MaxResults:
          type: integer
          description: The maximum number of trials to return in the response. The default value is 10.
        NextToken:
          type: string
          description: If the previous call to ListTrials didn't return the full set of trials, the call returns a token for
            getting the next set of trials.
    ListTrialsResponse:
      type: object
      properties:
        TrialSummaries:
          type: array
          items:
            $ref: '#/components/schemas/TrialSummary'
          description: A list of the summaries of your trials.
        NextToken:
          type: string
          description: A token for getting the next set of trials, if there are any.
    MetadataProperties:
      type: object
      properties:
        CommitId:
          type: string
          description: The commit ID.
        Repository:
          type: string
          description: The repository.
        GeneratedBy:
          type: string
          description: The entity this entity was generated by.
        ProjectId:
          type: string
          description: The project ID.
    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
    TrialSource:
      type: object
      properties:
        SourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the source.
        SourceType:
          type: string
          description: The source job type.
      required:
      - SourceArn
    TrialSummary:
      type: object
      properties:
        TrialArn:
          type: string
          description: The Amazon Resource Name (ARN) of the trial.
        TrialName:
          type: string
          description: The name of the trial.
        DisplayName:
          type: string
          description: The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.
        TrialSource:
          $ref: '#/components/schemas/TrialSource'
        CreationTime:
          type: string
          format: date-time
          description: When the trial was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: When the trial was last modified.
    UpdateTrialRequest:
      type: object
      properties:
        TrialName:
          type: string
          description: The name of the trial to update.
        DisplayName:
          type: string
          description: The name of the trial as displayed. The name doesn't need to be unique. If DisplayName isn't specified,
            TrialName is displayed.
      required:
      - TrialName
    UpdateTrialResponse:
      type: object
      properties:
        TrialArn:
          type: string
          description: The Amazon Resource Name (ARN) of the trial.
    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)