Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

SendHeartbeat

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

Request Syntax


POST /SendHeartbeat HTTP/1.1
Content-type: application/json

{
   "AgentMetrics": [ 
      { 
         "Dimension": "string",
         "MetricName": "string",
         "Timestamp": number,
         "Value": number
      }
   ],
   "AgentVersion": "string",
   "DeploymentResult": { 
      "DeploymentEndTime": number,
      "DeploymentModels": [ 
         { 
            "DesiredState": "string",
            "ModelHandle": "string",
            "ModelName": "string",
            "ModelVersion": "string",
            "RollbackFailureReason": "string",
            "State": "string",
            "Status": "string",
            "StatusReason": "string"
         }
      ],
      "DeploymentName": "string",
      "DeploymentStartTime": number,
      "DeploymentStatus": "string",
      "DeploymentStatusMessage": "string"
   },
   "DeviceFleetName": "string",
   "DeviceName": "string",
   "Models": [ 
      { 
         "LatestInference": number,
         "LatestSampleTime": number,
         "ModelMetrics": [ 
            { 
               "Dimension": "string",
               "MetricName": "string",
               "Timestamp": number,
               "Value": number
            }
         ],
         "ModelName": "string",
         "ModelVersion": "string"
      }
   ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

AgentMetrics

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

Type: Array of EdgeMetric objects

Required: No

AgentVersion

Returns the version of the agent.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9\ \_\.]+

Required: Yes

DeploymentResult

Returns the result of a deployment on the device.

Type: DeploymentResult object

Required: No

DeviceFleetName

The name of the fleet to which the device belongs.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$

Required: Yes

DeviceName

The unique name of the device.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$

Required: Yes

Models

Returns a list of models deployed on the the device.

Type: Array of Model objects

Required: No

Response Syntax


HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceException

An internal failure occurred. Try your request again. If the problem persists, contact AWS customer support.

HTTP Status Code: 400