AWS CLI Command Reference

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

Synopsis

  send-heartbeat
[--agent-metrics <value>]
[--models <value>]
--agent-version <value>
--device-name <value>
--device-fleet-name <value>
[--deployment-result <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <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.

--deployment-result (structure)

Returns the result of a deployment on the device.

DeploymentName -> (string)

The name and unique ID of the deployment.

DeploymentStatus -> (string)

Returns the bucket error code.

DeploymentStatusMessage -> (string)

Returns the detailed error message.

DeploymentStartTime -> (timestamp)

The timestamp of when the deployment was started on the agent.

DeploymentEndTime -> (timestamp)

The timestamp of when the deployment was ended, and the agent got the deployment results.

DeploymentModels -> (list)

Returns a list of models deployed on the agent.

(structure)

ModelHandle -> (string)

The unique handle of the model.

ModelName -> (string)

The name of the model.

ModelVersion -> (string)

The version of the model.

DesiredState -> (string)

The desired state of the model.

State -> (string)

Returns the current state of the model.

Status -> (string)

Returns the deployment status of the model.

StatusReason -> (string)

Returns the error message for the deployment status result.

RollbackFailureReason -> (string)

Returns the error message if there is a rollback.

Shorthand Syntax:

DeploymentName=string,DeploymentStatus=string,DeploymentStatusMessage=string,DeploymentStartTime=timestamp,DeploymentEndTime=timestamp,DeploymentModels=[{ModelHandle=string,ModelName=string,ModelVersion=string,DesiredState=string,State=string,Status=string,StatusReason=string,RollbackFailureReason=string},{ModelHandle=string,ModelName=string,ModelVersion=string,DesiredState=string,State=string,Status=string,StatusReason=string,RollbackFailureReason=string}]

JSON Syntax:

{
  "DeploymentName": "string",
  "DeploymentStatus": "string",
  "DeploymentStatusMessage": "string",
  "DeploymentStartTime": timestamp,
  "DeploymentEndTime": timestamp,
  "DeploymentModels": [
    {
      "ModelHandle": "string",
      "ModelName": "string",
      "ModelVersion": "string",
      "DesiredState": "DEPLOY"|"UNDEPLOY",
      "State": "DEPLOY"|"UNDEPLOY",
      "Status": "SUCCESS"|"FAIL",
      "StatusReason": "string",
      "RollbackFailureReason": "string"
    }
    ...
  ]
}

--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.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

None