Sagemaker Edge
This page documents function available when using the Sagemaker_Edge
module, created with @service Sagemaker_Edge
.
Index
Main.Sagemaker_Edge.get_deployments
Main.Sagemaker_Edge.get_device_registration
Main.Sagemaker_Edge.send_heartbeat
Documentation
Main.Sagemaker_Edge.get_deployments
— Methodget_deployments(device_fleet_name, device_name)
get_deployments(device_fleet_name, device_name, params::Dict{String,<:Any})
Use to get the active deployments from a device.
Arguments
device_fleet_name
: The name of the fleet that the device belongs to.device_name
: The unique name of the device you want to get the configuration of active deployments from.
Main.Sagemaker_Edge.get_device_registration
— Methodget_device_registration(device_fleet_name, device_name)
get_device_registration(device_fleet_name, device_name, params::Dict{String,<:Any})
Use to check if a device is registered with SageMaker Edge Manager.
Arguments
device_fleet_name
: The name of the fleet that the device belongs to.device_name
: The unique name of the device you want to get the registration status from.
Main.Sagemaker_Edge.send_heartbeat
— Methodsend_heartbeat(agent_version, device_fleet_name, device_name)
send_heartbeat(agent_version, device_fleet_name, device_name, params::Dict{String,<:Any})
Use to get the current status of devices registered on SageMaker Edge Manager.
Arguments
agent_version
: Returns the version of the agent.device_fleet_name
: The name of the fleet that the device belongs to.device_name
: The unique name of the device.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AgentMetrics"
: For internal use. Returns a list of SageMaker Edge Manager agent operating metrics."DeploymentResult"
: Returns the result of a deployment on the device."Models"
: Returns a list of models deployed on the the device.