Amazon SageMaker Edge Manager

Name: Amazon SageMaker Edge Manager API
Brand: Amazon SageMaker Edge Manager
Availability: InStock

★ Only Publicly Available SpecIOTDevice Managementhmac3 EndpointsREST

For Agents

The dataplane that registered edge devices use to fetch model deployments and send heartbeats back to SageMaker.

Quickstart

Get started with Amazon SageMaker Edge Manager in minutes using your preferred integration method.

# Add to your MCP client config (Claude Desktop, Cursor, Windsurf)
{
  "jentic": {
    "url": "https://api.jentic.com/mcp",
    "auth": "oauth"
  }
}

# Then ask your agent:
"fetch a SageMaker Edge deployment"

# → Jentic returns the GET /events tool with parameter schema, agent executes.

Capabilities

What an agent can do with Amazon SageMaker Edge Manager API.

Fetch the model deployment assigned to a registered edge device with GetDeployments

Retrieve a device's registration metadata and assigned device fleet with GetDeviceRegistration

Send a periodic heartbeat with model status, agent metrics, and metadata using SendHeartbeat

Track per-device deployment progress through heartbeat reporting back to the control plane

GET STARTED

Start building with Amazon SageMaker Edge Manager API

Explore with Jentic

View OpenAPI Spec

Jentic publishes the only available OpenAPI specification for Amazon SageMaker Edge Manager, keeping it validated and agent-ready.

Jentic publishes the only available OpenAPI specification for Amazon SageMaker Edge Manager, keeping it validated and agent-ready. SageMaker Edge Manager is the dataplane for active edge agents — it lets registered devices fetch their assigned model deployments, send periodic heartbeats with telemetry, and report registration metadata back to the SageMaker control plane. This API is consumed by the Edge Manager agent on each device, not typically called directly by application code, but it is the protocol that drives over-the-air model updates on edge fleets. Note that AWS announced SageMaker Edge Manager is on a deprecation path, so check current status before adopting.

Use Cases

Patterns agents use Amazon SageMaker Edge Manager API for, with concrete tasks.

★ Edge device polling for model updates

The SageMaker Edge Manager device agent polls GetDeployments on a regular interval to learn when a new model version has been assigned to its fleet. When a new deployment is returned, the agent downloads the model artifact from the indicated S3 location and swaps it into the local inference runtime. This API is the contract between the device-side agent and the cloud-side deployment plan.

Call GetDeployments for DeviceName='device-042' in DeviceFleetName='warehouse-cameras' and, on a non-empty response, download the model from the returned S3 URI.

Device telemetry and heartbeat reporting

Each edge device sends SendHeartbeat at a regular interval with the current AgentVersion, model statuses, and any custom metrics. The control plane uses these heartbeats to surface device health in the SageMaker console — last-seen timestamps, stale models, and degraded agents. Without heartbeats, the cloud has no visibility into whether the deployment landed.

Call SendHeartbeat from device-042 with AgentVersion='1.20', ModelMetadata listing the currently loaded model and its status as RUNNING.

Device registration verification

The Edge Manager agent calls GetDeviceRegistration on startup to confirm the device is registered, retrieve its fleet assignment, and load the IoT credentials needed for downstream operations. This is the bootstrap step before deployment polling can succeed — an unregistered device gets a clear error rather than silently failing.

Call GetDeviceRegistration for DeviceName='device-042' in DeviceFleetName='warehouse-cameras' to confirm the device is registered and receive the IoT certificate ARN.

Agent-driven edge fleet diagnostics through Jentic

AI agents that diagnose edge fleet issues use Jentic to call GetDeployments and GetDeviceRegistration on behalf of operators without holding raw AWS credentials. Jentic stores keys in the MAXsystem vault, signs each request with SigV4, and returns the structured response — letting the agent verify whether a missing deployment is a registration problem, a deployment-plan problem, or a device-side polling problem.

Search Jentic for 'fetch a SageMaker Edge deployment', call GetDeployments for the suspected device, and on empty response call GetDeviceRegistration to confirm it is registered to the right fleet.

Key Endpoints

3 endpoints — jentic publishes the only available openapi specification for amazon sagemaker edge manager, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/GetDeployments

Fetch the model deployment assigned to a device

POST

/GetDeviceRegistration

Retrieve a device's registration metadata

POST

/SendHeartbeat

Send a periodic heartbeat with model and agent status

POST

/GetDeployments

Fetch the model deployment assigned to a device

POST

/GetDeviceRegistration

Retrieve a device's registration metadata

POST

/SendHeartbeat

Send a periodic heartbeat with model and agent status

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

AWS credentials are stored encrypted in the Jentic vault (MAXsystem). Each Edge Manager Runtime call is signed with SigV4 server-side and the agent only receives scoped, short-lived authorisation — raw access keys never enter the agent's context.

Intent-based discovery

Agents search by intent (e.g., 'fetch a SageMaker Edge deployment') and Jentic returns the matching Edge Manager operations with their input schemas, so the agent calls GetDeployments or SendHeartbeat without browsing AWS docs.

Time to first call

Direct Edge Manager integration: 1 day for SigV4 signing and the small operation surface. Through Jentic: under 30 minutes — search, load schema, execute (devices still need to be registered via the SageMaker control plane).

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

Amazon SageMaker

The control plane that registers devices, creates fleets, and authors deployment plans

Use SageMaker to register devices and define what to deploy; use Edge Manager Runtime as the device-side dataplane that fetches and reports.

Alternative

AWS IoT Greengrass

Component-based edge runtime that AWS positions as the longer-term home for edge ML deployments

Choose Greengrass for new edge ML projects given Edge Manager's deprecation path; keep Edge Manager only for existing fleets.

Complementary

AWS IoT Core (data)

MQTT and HTTPS dataplane for IoT messaging that often coexists with Edge Manager telemetry

Use IoT Core for general device messaging and shadows; use Edge Manager Runtime specifically for SageMaker model deployment polling and heartbeats.

FAQs

Specific to using Amazon SageMaker Edge Manager API through Jentic.

Why is there no official OpenAPI spec for Amazon SageMaker Edge Manager?

AWS does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Amazon SageMaker Edge Manager via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Amazon SageMaker Edge Manager API use?

Edge Manager Runtime uses AWS Signature Version 4 HMAC signing with an access key ID and secret access key, optionally with a session token. On real edge devices, the SageMaker Edge Manager agent typically uses IoT certificates issued during device registration to obtain temporary credentials. Through Jentic, your AWS credentials sit in the MAXsystem vault and Jentic signs each request server-side.

Can I register or deploy to devices with the Amazon SageMaker Edge Manager API?

No — registration, fleet creation, and deployment planning live on the SageMaker control plane (RegisterDevices, CreateDeviceFleet, CreateEdgeDeploymentPlan). This dataplane API is what registered devices call at runtime to fetch their assigned deployment and send heartbeats.

What are the rate limits for the Amazon SageMaker Edge Manager API?

AWS does not publish a fixed RPS in the spec; standard AWS API throttling applies and the service returns ThrottlingException on overage. The Edge Manager agent on devices applies sensible default poll and heartbeat intervals (typically tens of seconds to minutes) to stay well within service quotas.

How do I fetch the assigned deployment for a device with Amazon SageMaker Edge Manager through Jentic?

Search Jentic for 'fetch a SageMaker Edge deployment', load GetDeployments, and call POST /GetDeployments with DeviceName and DeviceFleetName. The response contains the assigned model name, version, and S3 URI to download the artifact. Install with pip install jentic.

Is Amazon SageMaker Edge Manager still actively supported?

AWS announced SageMaker Edge Manager is on a deprecation path, with new feature work focused on alternatives such as IoT Greengrass component-based ML deployments. The dataplane endpoints documented here continue to function for existing deployments, but check current AWS service status before building new edge fleets on Edge Manager.