Amazon SageMaker

Amazon SageMaker Sagemaker Device Fleet API

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

GitHub OpenAPI

Operations 5

POST /#CreateDeviceFleet Create Device Fleet #
POST /#DeleteDeviceFleet Delete Device Fleet #
POST /#DescribeDeviceFleet Describe Device Fleet #
POST /#ListDeviceFleets List Device Fleets #
POST /#UpdateDeviceFleet Update Device Fleet #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-sagemaker/openapi/amazon-sagemaker-device-fleet-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-fleet-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-fleet-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Amazon SageMaker Service Device Fleet 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:
  /#CreateDeviceFleet:
    post:
      operationId: CreateDeviceFleet
      summary: Create Device Fleet
      description: Creates a device fleet.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '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.CreateDeviceFleet
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateDeviceFleetRequest'
      tags:
      - Device Fleet
  /#DeleteDeviceFleet:
    post:
      operationId: DeleteDeviceFleet
      summary: Delete Device Fleet
      description: Deletes a fleet.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '400':
          description: ResourceInUse
          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.DeleteDeviceFleet
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteDeviceFleetRequest'
      tags:
      - Device Fleet
  /#DescribeDeviceFleet:
    post:
      operationId: DescribeDeviceFleet
      summary: Describe Device Fleet
      description: A description of the fleet the device belongs to.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeDeviceFleetResponse'
        '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.DescribeDeviceFleet
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeDeviceFleetRequest'
      tags:
      - Device Fleet
  /#ListDeviceFleets:
    post:
      operationId: ListDeviceFleets
      summary: List Device Fleets
      description: Returns a list of devices in the fleet.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListDeviceFleetsResponse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.ListDeviceFleets
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListDeviceFleetsRequest'
      tags:
      - Device Fleet
  /#UpdateDeviceFleet:
    post:
      operationId: UpdateDeviceFleet
      summary: Update Device Fleet
      description: Updates a fleet of devices.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '400':
          description: ResourceInUse
          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.UpdateDeviceFleet
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateDeviceFleetRequest'
      tags:
      - Device Fleet
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:
    CreateDeviceFleetRequest:
      type: object
      properties:
        DeviceFleetName:
          type: string
          description: The name of the fleet that the device belongs to.
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).
        Description:
          type: string
          description: A description of the fleet.
        OutputConfig:
          $ref: '#/components/schemas/EdgeOutputConfig'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Creates tags for the specified fleet.
        EnableIotRoleAlias:
          type: boolean
          description: 'Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of
            the role alias generated will match this pattern: "SageMakerEdge-{DeviceFleetName}". For example, if your device
            fleet is called "demo-fleet", the name of the role alias will be "SageMakerEdge-demo-fleet".'
      required:
      - DeviceFleetName
      - OutputConfig
    DeleteDeviceFleetRequest:
      type: object
      properties:
        DeviceFleetName:
          type: string
          description: The name of the fleet to delete.
      required:
      - DeviceFleetName
    DescribeDeviceFleetRequest:
      type: object
      properties:
        DeviceFleetName:
          type: string
          description: The name of the fleet.
      required:
      - DeviceFleetName
    DescribeDeviceFleetResponse:
      type: object
      properties:
        DeviceFleetName:
          type: string
          description: The name of the fleet.
        DeviceFleetArn:
          type: string
          description: The The Amazon Resource Name (ARN) of the fleet.
        OutputConfig:
          $ref: '#/components/schemas/EdgeOutputConfig'
        Description:
          type: string
          description: A description of the fleet.
        CreationTime:
          type: string
          format: date-time
          description: Timestamp of when the device fleet was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: Timestamp of when the device fleet was last updated.
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).
        IotRoleAlias:
          type: string
          description: The Amazon Resource Name (ARN) alias created in Amazon Web Services Internet of Things (IoT).
      required:
      - DeviceFleetName
      - DeviceFleetArn
      - OutputConfig
      - CreationTime
      - LastModifiedTime
    DeviceFleetSummary:
      type: object
      properties:
        DeviceFleetArn:
          type: string
          description: Amazon Resource Name (ARN) of the device fleet.
        DeviceFleetName:
          type: string
          description: Name of the device fleet.
        CreationTime:
          type: string
          format: date-time
          description: Timestamp of when the device fleet was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: Timestamp of when the device fleet was last updated.
      required:
      - DeviceFleetArn
      - DeviceFleetName
    EdgeOutputConfig:
      type: object
      properties:
        S3OutputLocation:
          type: string
          description: The Amazon Simple Storage (S3) bucker URI.
        KmsKeyId:
          type: string
          description: The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker
            uses to encrypt data on the storage volume after compilation job. If you don't provide a KMS key ID, Amazon SageMaker
            uses the default KMS key for Amazon S3 for your role's account.
        PresetDeploymentType:
          type: string
          enum:
          - GreengrassV2Component
          description: The deployment type SageMaker Edge Manager will create. Currently only supports Amazon Web Services
            IoT Greengrass Version 2 components.
        PresetDeploymentConfig:
          type: string
          description: 'The configuration used to create deployment artifacts. Specify configuration options with a JSON string.
            The available configuration options for each type are: ComponentName (optional) - Name of the GreenGrass V2 component.
            If not specified, the default name generated consists of "SagemakerEdgeManager" and the name of your SageMaker
            Edge Manager packaging job. ComponentDescription (optional) - Description of the component. ComponentVersion (optional)
            - The version of the component. Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic
            versions follow a major.minor.'
      required:
      - S3OutputLocation
    ListDeviceFleetsRequest:
      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: The maximum number of results to select.
        CreationTimeAfter:
          type: string
          format: date-time
          description: Filter fleets where packaging job was created after specified time.
        CreationTimeBefore:
          type: string
          format: date-time
          description: Filter fleets where the edge packaging job was created before specified time.
        LastModifiedTimeAfter:
          type: string
          format: date-time
          description: Select fleets where the job was updated after X
        LastModifiedTimeBefore:
          type: string
          format: date-time
          description: Select fleets where the job was updated before X
        NameContains:
          type: string
          description: Filter for fleets containing this name in their fleet device name.
        SortBy:
          type: string
          enum:
          - NAME
          - CREATION_TIME
          - LAST_MODIFIED_TIME
          description: The column to sort by.
        SortOrder:
          type: string
          enum:
          - Ascending
          - Descending
          description: What direction to sort in.
    ListDeviceFleetsResponse:
      type: object
      properties:
        DeviceFleetSummaries:
          type: array
          items:
            $ref: '#/components/schemas/DeviceFleetSummary'
          description: Summary of the device fleet.
        NextToken:
          type: string
          description: The response from the last list when returning a list large enough to need tokening.
      required:
      - DeviceFleetSummaries
    ResourceInUse:
      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
    UpdateDeviceFleetRequest:
      type: object
      properties:
        DeviceFleetName:
          type: string
          description: The name of the fleet.
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the device.
        Description:
          type: string
          description: Description of the fleet.
        OutputConfig:
          $ref: '#/components/schemas/EdgeOutputConfig'
        EnableIotRoleAlias:
          type: boolean
          description: 'Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of
            the role alias generated will match this pattern: "SageMakerEdge-{DeviceFleetName}". For example, if your device
            fleet is called "demo-fleet", the name of the role alias will be "SageMakerEdge-demo-fleet".'
      required:
      - DeviceFleetName
      - OutputConfig
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)