Amazon SageMaker Sagemaker Action API

The Sagemaker Action API from Amazon SageMaker — 5 operation(s) for sagemaker action.

Operations 5

POST /#CreateAction Create Action #
POST /#DeleteAction Delete Action #
POST /#DescribeAction Describe Action #
POST /#ListActions List Actions #
POST /#UpdateAction Update Action #

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-action-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.

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

OpenAPI Specification

amazon-sagemaker-action-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon SageMaker Service Action 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:
  /#CreateAction:
    post:
      operationId: CreateAction
      summary: Create Action
      description: Creates an action. An action is a lineage tracking entity that represents an action or activity. For example,
        a model deployment or an HPO job. Generally, an action involves at least one input or output artifact. For more information,
        see Amazon SageMaker ML Lineage Tracking.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateActionResponse'
        '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.CreateAction
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateActionRequest'
      tags:
      - Action
  /#DeleteAction:
    post:
      operationId: DeleteAction
      summary: Delete Action
      description: Deletes an action.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteActionResponse'
        '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.DeleteAction
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteActionRequest'
      tags:
      - Action
  /#DescribeAction:
    post:
      operationId: DescribeAction
      summary: Describe Action
      description: Describes an action.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeActionResponse'
        '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.DescribeAction
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeActionRequest'
      tags:
      - Action
  /#ListActions:
    post:
      operationId: ListActions
      summary: List Actions
      description: Lists the actions in your account and their properties.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListActionsResponse'
        '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.ListActions
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListActionsRequest'
      tags:
      - Action
  /#UpdateAction:
    post:
      operationId: UpdateAction
      summary: Update Action
      description: Updates an action.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateActionResponse'
        '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.UpdateAction
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateActionRequest'
      tags:
      - Action
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:
    ActionSource:
      type: object
      properties:
        SourceUri:
          type: string
          description: The URI of the source.
        SourceType:
          type: string
          description: The type of the source.
        SourceId:
          type: string
          description: The ID of the source.
      required:
      - SourceUri
    ActionSummary:
      type: object
      properties:
        ActionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the action.
        ActionName:
          type: string
          description: The name of the action.
        Source:
          $ref: '#/components/schemas/ActionSource'
        ActionType:
          type: string
          description: The type of the action.
        Status:
          type: string
          enum:
          - Unknown
          - InProgress
          - Completed
          - Failed
          - Stopping
          - Stopped
          description: The status of the action.
        CreationTime:
          type: string
          format: date-time
          description: When the action was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: When the action was last modified.
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    CreateActionRequest:
      type: object
      properties:
        ActionName:
          type: string
          description: The name of the action. Must be unique to your account in an Amazon Web Services Region.
        Source:
          $ref: '#/components/schemas/ActionSource'
        ActionType:
          type: string
          description: The action type.
        Description:
          type: string
          description: The description of the action.
        Status:
          type: string
          enum:
          - Unknown
          - InProgress
          - Completed
          - Failed
          - Stopping
          - Stopped
          description: The status of the action.
        Properties:
          type: object
          additionalProperties:
            type: string
          description: A list of properties to add to the action.
        MetadataProperties:
          $ref: '#/components/schemas/MetadataProperties'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags to apply to the action.
      required:
      - ActionName
      - Source
      - ActionType
    CreateActionResponse:
      type: object
      properties:
        ActionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the action.
    DeleteActionRequest:
      type: object
      properties:
        ActionName:
          type: string
          description: The name of the action to delete.
      required:
      - ActionName
    DeleteActionResponse:
      type: object
      properties:
        ActionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the action.
    DescribeActionRequest:
      type: object
      properties:
        ActionName:
          type: string
          description: The name of the action to describe.
      required:
      - ActionName
    DescribeActionResponse:
      type: object
      properties:
        ActionName:
          type: string
          description: The name of the action.
        ActionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the action.
        Source:
          $ref: '#/components/schemas/ActionSource'
        ActionType:
          type: string
          description: The type of the action.
        Description:
          type: string
          description: The description of the action.
        Status:
          type: string
          enum:
          - Unknown
          - InProgress
          - Completed
          - Failed
          - Stopping
          - Stopped
          description: The status of the action.
        Properties:
          type: object
          additionalProperties:
            type: string
          description: A list of the action's properties.
        CreationTime:
          type: string
          format: date-time
          description: When the action was created.
        CreatedBy:
          $ref: '#/components/schemas/UserContext'
        LastModifiedTime:
          type: string
          format: date-time
          description: When the action was last modified.
        LastModifiedBy:
          $ref: '#/components/schemas/UserContext'
        MetadataProperties:
          $ref: '#/components/schemas/MetadataProperties'
        LineageGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the lineage group.
    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.
    ListActionsRequest:
      type: object
      properties:
        SourceUri:
          type: string
          description: A filter that returns only actions with the specified source URI.
        ActionType:
          type: string
          description: A filter that returns only actions of the specified type.
        CreatedAfter:
          type: string
          format: date-time
          description: A filter that returns only actions created on or after the specified time.
        CreatedBefore:
          type: string
          format: date-time
          description: A filter that returns only actions created on or 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 ListActions didn't return the full set of actions, the call returns a token
            for getting the next set of actions.
        MaxResults:
          type: integer
          description: The maximum number of actions to return in the response. The default value is 10.
    ListActionsResponse:
      type: object
      properties:
        ActionSummaries:
          type: array
          items:
            $ref: '#/components/schemas/ActionSummary'
          description: A list of actions and their properties.
        NextToken:
          type: string
          description: A token for getting the next set of actions, 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
    UpdateActionRequest:
      type: object
      properties:
        ActionName:
          type: string
          description: The name of the action to update.
        Description:
          type: string
          description: The new description for the action.
        Status:
          type: string
          enum:
          - Unknown
          - InProgress
          - Completed
          - Failed
          - Stopping
          - Stopped
          description: The new status for the action.
        Properties:
          type: object
          additionalProperties:
            type: string
          description: The new list of properties. Overwrites the current property list.
        PropertiesToRemove:
          type: array
          items:
            type: string
          description: A list of properties to remove.
      required:
      - ActionName
    UpdateActionResponse:
      type: object
      properties:
        ActionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the action.
    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)