Table of Contents
A low-level client representing Amazon Sagemaker Edge Manager
SageMaker Edge Manager dataplane service for communicating with active agents.
import boto3
client = boto3.client('sagemaker-edge')
These are the available methods:
Check if an operation can be paginated.
Use to check if a device is registered with SageMaker Edge Manager.
See also: AWS API Documentation
Request Syntax
response = client.get_device_registration(
DeviceName='string',
DeviceFleetName='string'
)
[REQUIRED]
The unique name of the device you want to get the registration status from.
[REQUIRED]
The name of the fleet that the device belongs to.
dict
Response Syntax
{
'DeviceRegistration': 'string',
'CacheTTL': 'string'
}
Response Structure
(dict) --
DeviceRegistration (string) --
Describes if the device is currently registered with SageMaker Edge Manager.
CacheTTL (string) --
The amount of time, in seconds, that the registration status is stored on the device’s cache before it is refreshed.
Exceptions
Create a paginator for an operation.
Returns an object that can wait for some condition.
Use to get the current status of devices registered on SageMaker Edge Manager.
See also: AWS API Documentation
Request Syntax
response = client.send_heartbeat(
AgentMetrics=[
{
'Dimension': 'string',
'MetricName': 'string',
'Value': 123.0,
'Timestamp': datetime(2015, 1, 1)
},
],
Models=[
{
'ModelName': 'string',
'ModelVersion': 'string',
'LatestSampleTime': datetime(2015, 1, 1),
'LatestInference': datetime(2015, 1, 1),
'ModelMetrics': [
{
'Dimension': 'string',
'MetricName': 'string',
'Value': 123.0,
'Timestamp': datetime(2015, 1, 1)
},
]
},
],
AgentVersion='string',
DeviceName='string',
DeviceFleetName='string'
)
For internal use. Returns a list of SageMaker Edge Manager agent operating metrics.
Information required for edge device metrics.
The dimension of metrics published.
Returns the name of the metric.
Returns the value of the metric.
Timestamp of when the metric was requested.
Returns a list of models deployed on the the device.
Information about a model deployed on an edge device that is registered with SageMaker Edge Manager.
The name of the model.
The version of the model.
The timestamp of the last data sample taken.
The timestamp of the last inference that was made.
Information required for model metrics.
Information required for edge device metrics.
The dimension of metrics published.
Returns the name of the metric.
Returns the value of the metric.
Timestamp of when the metric was requested.
[REQUIRED]
Returns the version of the agent.
[REQUIRED]
The unique name of the device.
[REQUIRED]
The name of the fleet that the device belongs to.
None
Exceptions
The available paginators are: