POST

/SendHeartbeat

http://edge.sagemaker.{region}.amazonaws.com/SendHeartbeat

Use to get the current status of devices registered on SageMaker Edge Manager.

Access Token Required: API Key

Body Params

Modelsarray

Returns a list of models deployed on the the device.

DeviceNamestringrequired

The unique name of the device.

AgentMetricsarray

For internal use. Returns a list of SageMaker Edge Manager agent operating metrics.

AgentVersionstringrequired

Returns the version of the agent.

DeviceFleetNamestringrequired

The name of the fleet that the device belongs to.

DeploymentResultobject

Information about the result of a deployment on an edge device that is registered with SageMaker Edge Manager.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://edge.sagemaker.{region}.amazonaws.com/SendHeartbeat' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}