Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . sagemaker-edge ]

send-heartbeat

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  send-heartbeat
[--agent-metrics <value>]
[--models <value>]
--agent-version <value>
--device-name <value>
--device-fleet-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--agent-metrics (list)

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

(structure)

Information required for edge device metrics.

Dimension -> (string)

The dimension of metrics published.

MetricName -> (string)

Returns the name of the metric.

Value -> (double)

Returns the value of the metric.

Timestamp -> (timestamp)

Timestamp of when the metric was requested.

Shorthand Syntax:

Dimension=string,MetricName=string,Value=double,Timestamp=timestamp ...

JSON Syntax:

[
  {
    "Dimension": "string",
    "MetricName": "string",
    "Value": double,
    "Timestamp": timestamp
  }
  ...
]

--models (list)

Returns a list of models deployed on the the device.

(structure)

Information about a model deployed on an edge device that is registered with SageMaker Edge Manager.

ModelName -> (string)

The name of the model.

ModelVersion -> (string)

The version of the model.

LatestSampleTime -> (timestamp)

The timestamp of the last data sample taken.

LatestInference -> (timestamp)

The timestamp of the last inference that was made.

ModelMetrics -> (list)

Information required for model metrics.

(structure)

Information required for edge device metrics.

Dimension -> (string)

The dimension of metrics published.

MetricName -> (string)

Returns the name of the metric.

Value -> (double)

Returns the value of the metric.

Timestamp -> (timestamp)

Timestamp of when the metric was requested.

Shorthand Syntax:

ModelName=string,ModelVersion=string,LatestSampleTime=timestamp,LatestInference=timestamp,ModelMetrics=[{Dimension=string,MetricName=string,Value=double,Timestamp=timestamp},{Dimension=string,MetricName=string,Value=double,Timestamp=timestamp}] ...

JSON Syntax:

[
  {
    "ModelName": "string",
    "ModelVersion": "string",
    "LatestSampleTime": timestamp,
    "LatestInference": timestamp,
    "ModelMetrics": [
      {
        "Dimension": "string",
        "MetricName": "string",
        "Value": double,
        "Timestamp": timestamp
      }
      ...
    ]
  }
  ...
]

--agent-version (string)

Returns the version of the agent.

--device-name (string)

The unique name of the device.

--device-fleet-name (string)

The name of the fleet that the device belongs to.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

None