SENDHEARTBEAT()`¶

About SendHeartbeat¶

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

Method Signature¶

METHODS /AWS1/IF_SGE~SENDHEARTBEAT
  IMPORTING
    !IT_AGENTMETRICS TYPE /AWS1/CL_SGEEDGEMETRIC=>TT_EDGEMETRICS OPTIONAL
    !IT_MODELS TYPE /AWS1/CL_SGEMODEL=>TT_MODELS OPTIONAL
    !IV_AGENTVERSION TYPE /AWS1/SGEVERSION OPTIONAL
    !IV_DEVICENAME TYPE /AWS1/SGEDEVICENAME OPTIONAL
    !IV_DEVICEFLEETNAME TYPE /AWS1/SGEDEVICEFLEETNAME OPTIONAL
    !IO_DEPLOYMENTRESULT TYPE REF TO /AWS1/CL_SGEDEPLOYMENTRESULT OPTIONAL
  RAISING
    /AWS1/CX_SGEINTERNALSERVICEEX
    /AWS1/CX_SGECLIENTEXC
    /AWS1/CX_SGESERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_agentversion` `TYPE /AWS1/SGEVERSION` `/AWS1/SGEVERSION`¶

Returns the version of the agent.

`iv_devicename` `TYPE /AWS1/SGEDEVICENAME` `/AWS1/SGEDEVICENAME`¶

The unique name of the device.

`iv_devicefleetname` `TYPE /AWS1/SGEDEVICEFLEETNAME` `/AWS1/SGEDEVICEFLEETNAME`¶

The name of the fleet that the device belongs to.

Optional arguments:¶

`it_agentmetrics` `TYPE /AWS1/CL_SGEEDGEMETRIC=>TT_EDGEMETRICS` `TT_EDGEMETRICS`¶

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

`it_models` `TYPE /AWS1/CL_SGEMODEL=>TT_MODELS` `TT_MODELS`¶

Returns a list of models deployed on the the device.

`io_deploymentresult` `TYPE REF TO /AWS1/CL_SGEDEPLOYMENTRESULT` `/AWS1/CL_SGEDEPLOYMENTRESULT`¶

Returns the result of a deployment on the device.

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

lo_client->sendheartbeat(
  io_deploymentresult = new /aws1/cl_sgedeploymentresult(
    it_deploymentmodels = VALUE /aws1/cl_sgedeploymentmodel=>tt_deploymentmodels(
      (
        new /aws1/cl_sgedeploymentmodel(
          iv_desiredstate = |string|
          iv_modelhandle = |string|
          iv_modelname = |string|
          iv_modelversion = |string|
          iv_rollbackfailurereason = |string|
          iv_state = |string|
          iv_status = |string|
          iv_statusreason = |string|
        )
      )
    )
    iv_deploymentendtime = '20150101000000.0000000'
    iv_deploymentname = |string|
    iv_deploymentstarttime = '20150101000000.0000000'
    iv_deploymentstatus = |string|
    iv_deploymentstatusmessage = |string|
  )
  it_agentmetrics = VALUE /aws1/cl_sgeedgemetric=>tt_edgemetrics(
    (
      new /aws1/cl_sgeedgemetric(
        iv_dimension = |string|
        iv_metricname = |string|
        iv_timestamp = '20150101000000.0000000'
        iv_value = '0.1'
      )
    )
  )
  it_models = VALUE /aws1/cl_sgemodel=>tt_models(
    (
      new /aws1/cl_sgemodel(
        it_modelmetrics = VALUE /aws1/cl_sgeedgemetric=>tt_edgemetrics(
          (
            new /aws1/cl_sgeedgemetric(
              iv_dimension = |string|
              iv_metricname = |string|
              iv_timestamp = '20150101000000.0000000'
              iv_value = '0.1'
            )
          )
        )
        iv_latestinference = '20150101000000.0000000'
        iv_latestsampletime = '20150101000000.0000000'
        iv_modelname = |string|
        iv_modelversion = |string|
      )
    )
  )
  iv_agentversion = |string|
  iv_devicefleetname = |string|
  iv_devicename = |string|
).

/AWS1/IF_SGE=>SENDHEARTBEAT()¶