Send Heartbeat

sagemakeredgemanager_send_heartbeat

R Documentation

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

Description¶

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

Usage¶

sagemakeredgemanager_send_heartbeat(AgentMetrics, Models, AgentVersion,
  DeviceName, DeviceFleetName, DeploymentResult)

Arguments¶

AgentMetrics: For internal use. Returns a list of SageMaker Edge Manager agent operating metrics.
Models: Returns a list of models deployed on the the device.
AgentVersion: [required] Returns the version of the agent.
DeviceName: [required] The unique name of the device.
DeviceFleetName: [required] The name of the fleet that the device belongs to.
DeploymentResult: Returns the result of a deployment on the device.

Value¶

An empty list.

Request syntax¶

svc$send_heartbeat(
  AgentMetrics = list(
    list(
      Dimension = "string",
      MetricName = "string",
      Value = 123.0,
      Timestamp = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  Models = list(
    list(
      ModelName = "string",
      ModelVersion = "string",
      LatestSampleTime = as.POSIXct(
        "2015-01-01"
      ),
      LatestInference = as.POSIXct(
        "2015-01-01"
      ),
      ModelMetrics = list(
        list(
          Dimension = "string",
          MetricName = "string",
          Value = 123.0,
          Timestamp = as.POSIXct(
            "2015-01-01"
          )
        )
      )
    )
  ),
  AgentVersion = "string",
  DeviceName = "string",
  DeviceFleetName = "string",
  DeploymentResult = list(
    DeploymentName = "string",
    DeploymentStatus = "string",
    DeploymentStatusMessage = "string",
    DeploymentStartTime = as.POSIXct(
      "2015-01-01"
    ),
    DeploymentEndTime = as.POSIXct(
      "2015-01-01"
    ),
    DeploymentModels = list(
      list(
        ModelHandle = "string",
        ModelName = "string",
        ModelVersion = "string",
        DesiredState = "DEPLOY"|"UNDEPLOY",
        State = "DEPLOY"|"UNDEPLOY",
        Status = "SUCCESS"|"FAIL",
        StatusReason = "string",
        RollbackFailureReason = "string"
      )
    )
  )
)