Amazon SageMaker

Amazon SageMaker Sagemaker Device API

The Sagemaker Device API from Amazon SageMaker — 5 operation(s) for sagemaker device.

GitHub OpenAPI

Operations 5

POST /#DeregisterDevices Deregister Devices #
POST /#DescribeDevice Describe Device #
POST /#ListDevices List Devices #
POST /#RegisterDevices Register Devices #
POST /#UpdateDevices Update Devices #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-sagemaker/openapi/amazon-sagemaker-device-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-device-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-device-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Amazon SageMaker Service Device 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:
  /#DeregisterDevices:
    post:
      operationId: DeregisterDevices
      summary: Deregister Devices
      description: Deregisters the specified devices. After you deregister a device, you will need to re-register the devices.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.DeregisterDevices
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeregisterDevicesRequest'
      tags:
      - Device
  /#DescribeDevice:
    post:
      operationId: DescribeDevice
      summary: Describe Device
      description: Describes the device.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeDeviceResponse'
        '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.DescribeDevice
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeDeviceRequest'
      tags:
      - Device
  /#ListDevices:
    post:
      operationId: ListDevices
      summary: List Devices
      description: A list of devices.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListDevicesResponse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.ListDevices
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListDevicesRequest'
      tags:
      - Device
  /#RegisterDevices:
    post:
      operationId: RegisterDevices
      summary: Register Devices
      description: Register devices.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '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.RegisterDevices
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/RegisterDevicesRequest'
      tags:
      - Device
  /#UpdateDevices:
    post:
      operationId: UpdateDevices
      summary: Update Devices
      description: Updates one or more devices in a fleet.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.UpdateDevices
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateDevicesRequest'
      tags:
      - Device
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:
    DeregisterDevicesRequest:
      type: object
      properties:
        DeviceFleetName:
          type: string
          description: The name of the fleet the devices belong to.
        DeviceNames:
          type: array
          items:
            type: string
          description: The unique IDs of the devices.
      required:
      - DeviceFleetName
      - DeviceNames
    DescribeDeviceRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: Next token of device description.
        DeviceName:
          type: string
          description: The unique ID of the device.
        DeviceFleetName:
          type: string
          description: The name of the fleet the devices belong to.
      required:
      - DeviceName
      - DeviceFleetName
    DescribeDeviceResponse:
      type: object
      properties:
        DeviceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the device.
        DeviceName:
          type: string
          description: The unique identifier of the device.
        Description:
          type: string
          description: A description of the device.
        DeviceFleetName:
          type: string
          description: The name of the fleet the device belongs to.
        IotThingName:
          type: string
          description: The Amazon Web Services Internet of Things (IoT) object thing name associated with the device.
        RegistrationTime:
          type: string
          format: date-time
          description: The timestamp of the last registration or de-reregistration.
        LatestHeartbeat:
          type: string
          format: date-time
          description: The last heartbeat received from the device.
        Models:
          type: array
          items:
            $ref: '#/components/schemas/EdgeModel'
          description: Models on the device.
        MaxModels:
          type: integer
          description: The maximum number of models.
        NextToken:
          type: string
          description: The response from the last list when returning a list large enough to need tokening.
        AgentVersion:
          type: string
          description: Edge Manager agent version.
      required:
      - DeviceName
      - DeviceFleetName
      - RegistrationTime
    Device:
      type: object
      properties:
        DeviceName:
          type: string
          description: The name of the device.
        Description:
          type: string
          description: Description of the device.
        IotThingName:
          type: string
          description: Amazon Web Services Internet of Things (IoT) object name.
      required:
      - DeviceName
    DeviceSummary:
      type: object
      properties:
        DeviceName:
          type: string
          description: The unique identifier of the device.
        DeviceArn:
          type: string
          description: Amazon Resource Name (ARN) of the device.
        Description:
          type: string
          description: A description of the device.
        DeviceFleetName:
          type: string
          description: The name of the fleet the device belongs to.
        IotThingName:
          type: string
          description: The Amazon Web Services Internet of Things (IoT) object thing name associated with the device..
        RegistrationTime:
          type: string
          format: date-time
          description: The timestamp of the last registration or de-reregistration.
        LatestHeartbeat:
          type: string
          format: date-time
          description: The last heartbeat received from the device.
        Models:
          type: array
          items:
            $ref: '#/components/schemas/EdgeModelSummary'
          description: Models on the device.
        AgentVersion:
          type: string
          description: Edge Manager agent version.
      required:
      - DeviceName
      - DeviceArn
    EdgeModel:
      type: object
      properties:
        ModelName:
          type: string
          description: The name of the model.
        ModelVersion:
          type: string
          description: The model version.
        LatestSampleTime:
          type: string
          format: date-time
          description: The timestamp of the last data sample taken.
        LatestInference:
          type: string
          format: date-time
          description: The timestamp of the last inference that was made.
      required:
      - ModelName
      - ModelVersion
    EdgeModelSummary:
      type: object
      properties:
        ModelName:
          type: string
          description: The name of the model.
        ModelVersion:
          type: string
          description: The version model.
      required:
      - ModelName
      - ModelVersion
    ListDevicesRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: The response from the last list when returning a list large enough to need tokening.
        MaxResults:
          type: integer
          description: Maximum number of results to select.
        LatestHeartbeatAfter:
          type: string
          format: date-time
          description: Select fleets where the job was updated after X
        ModelName:
          type: string
          description: A filter that searches devices that contains this name in any of their models.
        DeviceFleetName:
          type: string
          description: Filter for fleets containing this name in their device fleet name.
    ListDevicesResponse:
      type: object
      properties:
        DeviceSummaries:
          type: array
          items:
            $ref: '#/components/schemas/DeviceSummary'
          description: Summary of devices.
        NextToken:
          type: string
          description: The response from the last list when returning a list large enough to need tokening.
      required:
      - DeviceSummaries
    RegisterDevicesRequest:
      type: object
      properties:
        DeviceFleetName:
          type: string
          description: The name of the fleet.
        Devices:
          type: array
          items:
            $ref: '#/components/schemas/Device'
          description: A list of devices to register with SageMaker Edge Manager.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags associated with devices.
      required:
      - DeviceFleetName
      - Devices
    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
    UpdateDevicesRequest:
      type: object
      properties:
        DeviceFleetName:
          type: string
          description: The name of the fleet the devices belong to.
        Devices:
          type: array
          items:
            $ref: '#/components/schemas/Device'
          description: List of devices to register with Edge Manager agent.
      required:
      - DeviceFleetName
      - Devices
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)