AWS Amazon SageMaker Edge Manager
Browse all AWS APIs★ Only Publicly Available OpenAPI DocumentIOTDevice Managementhmac3 EndpointsREST
For Agents
The dataplane that registered edge devices use to fetch model deployments and send heartbeats back to SageMaker.
Use for: Fetch the latest model deployment assigned to an edge device, Send a heartbeat from an edge device with current model status, Get the registration record for a specific edge device, Check whether a new deployment is available for this device
Not supported: Does not register devices, create deployment plans, or run inference — use as the device-side dataplane for fetching assigned deployments, reading registration metadata, and sending heartbeats only.
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.
Install Jentic One Beta
Connect the Amazon SageMaker Edge Manager to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Amazon SageMaker Edge Manager, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
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
Operate as the dataplane protocol consumed by the SageMaker Edge Manager device agent
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 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.
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.
GET STARTED