Amazon Sagemaker Edge Manager 2020-09-23
- Client: Aws\SagemakerEdgeManager\SagemakerEdgeManagerClient
- Service ID: sagemaker-edge
- Version: 2020-09-23
This page describes the parameters and results for the operations of the Amazon Sagemaker Edge Manager (2020-09-23), and shows how to use the Aws\SagemakerEdgeManager\SagemakerEdgeManagerClient object to call the described operations. This documentation is specific to the 2020-09-23 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- GetDeviceRegistration ( array $params = [] )
Use to check if a device is registered with SageMaker Edge Manager.
- SendHeartbeat ( array $params = [] )
Use to get the current status of devices registered on SageMaker Edge Manager.
Operations
GetDeviceRegistration
$result = $client->getDeviceRegistration([/* ... */]); $promise = $client->getDeviceRegistrationAsync([/* ... */]);
Use to check if a device is registered with SageMaker Edge Manager.
Parameter Syntax
$result = $client->getDeviceRegistration([
'DeviceFleetName' => '<string>', // REQUIRED
'DeviceName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'CacheTTL' => '<string>',
'DeviceRegistration' => '<string>',
]
Result Details
Members
Errors
-
An internal failure occurred. Try your request again. If the problem persists, contact AWS customer support.
SendHeartbeat
$result = $client->sendHeartbeat([/* ... */]); $promise = $client->sendHeartbeatAsync([/* ... */]);
Use to get the current status of devices registered on SageMaker Edge Manager.
Parameter Syntax
$result = $client->sendHeartbeat([
'AgentMetrics' => [
[
'Dimension' => '<string>',
'MetricName' => '<string>',
'Timestamp' => <integer || string || DateTime>,
'Value' => <float>,
],
// ...
],
'AgentVersion' => '<string>', // REQUIRED
'DeviceFleetName' => '<string>', // REQUIRED
'DeviceName' => '<string>', // REQUIRED
'Models' => [
[
'LatestInference' => <integer || string || DateTime>,
'LatestSampleTime' => <integer || string || DateTime>,
'ModelMetrics' => [
[
'Dimension' => '<string>',
'MetricName' => '<string>',
'Timestamp' => <integer || string || DateTime>,
'Value' => <float>,
],
// ...
],
'ModelName' => '<string>',
'ModelVersion' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- AgentMetrics
-
- Type: Array of EdgeMetric structures
For internal use. Returns a list of SageMaker Edge Manager agent operating metrics.
- AgentVersion
-
- Required: Yes
- Type: string
Returns the version of the agent.
- DeviceFleetName
-
- Required: Yes
- Type: string
The name of the fleet that the device belongs to.
- DeviceName
-
- Required: Yes
- Type: string
The unique name of the device.
- Models
-
- Type: Array of Model structures
Returns a list of models deployed on the the device.
Result Syntax
[]
Result Details
Errors
-
An internal failure occurred. Try your request again. If the problem persists, contact AWS customer support.
Shapes
EdgeMetric
Description
Information required for edge device metrics.
Members
InternalServiceException
Description
An internal failure occurred. Try your request again. If the problem persists, contact AWS customer support.
Members
Model
Description
Information about a model deployed on an edge device that is registered with SageMaker Edge Manager.
Members
- LatestInference
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the last inference that was made.
- LatestSampleTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the last data sample taken.
- ModelMetrics
-
- Type: Array of EdgeMetric structures
Information required for model metrics.
- ModelName
-
- Type: string
The name of the model.
- ModelVersion
-
- Type: string
The version of the model.