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 */).
- GetDeployments ( array $params = [] )
Use to get the active deployments from a device.
- 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
GetDeployments
$result = $client->getDeployments([/* ... */]); $promise = $client->getDeploymentsAsync([/* ... */]);
Use to get the active deployments from a device.
Parameter Syntax
$result = $client->getDeployments([
'DeviceFleetName' => '<string>', // REQUIRED
'DeviceName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Deployments' => [
[
'Definitions' => [
[
'Checksum' => [
'Sum' => '<string>',
'Type' => 'SHA1',
],
'ModelHandle' => '<string>',
'S3Url' => '<string>',
'State' => 'DEPLOY|UNDEPLOY',
],
// ...
],
'DeploymentName' => '<string>',
'FailureHandlingPolicy' => 'ROLLBACK_ON_FAILURE|DO_NOTHING',
'Type' => 'Model',
],
// ...
],
]
Result Details
Members
- Deployments
-
- Type: Array of EdgeDeployment structures
Returns a list of the configurations of the active deployments on the device.
Errors
-
An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services customer support.
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 Amazon Web Services 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
'DeploymentResult' => [
'DeploymentEndTime' => <integer || string || DateTime>,
'DeploymentModels' => [
[
'DesiredState' => 'DEPLOY|UNDEPLOY',
'ModelHandle' => '<string>',
'ModelName' => '<string>',
'ModelVersion' => '<string>',
'RollbackFailureReason' => '<string>',
'State' => 'DEPLOY|UNDEPLOY',
'Status' => 'SUCCESS|FAIL',
'StatusReason' => '<string>',
],
// ...
],
'DeploymentName' => '<string>',
'DeploymentStartTime' => <integer || string || DateTime>,
'DeploymentStatus' => '<string>',
'DeploymentStatusMessage' => '<string>',
],
'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.
- DeploymentResult
-
- Type: DeploymentResult structure
Returns the result of a deployment on the device.
- 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 Amazon Web Services customer support.
Shapes
Checksum
Description
Information about the checksum of a model deployed on a device.
Members
Definition
Description
Members
- Checksum
-
- Type: Checksum structure
The checksum information of the model.
- ModelHandle
-
- Type: string
The unique model handle.
- S3Url
-
- Type: string
The absolute S3 location of the model.
- State
-
- Type: string
The desired state of the model.
DeploymentModel
Description
Members
- DesiredState
-
- Type: string
The desired state of the model.
- ModelHandle
-
- Type: string
The unique handle of the model.
- ModelName
-
- Type: string
The name of the model.
- ModelVersion
-
- Type: string
The version of the model.
- RollbackFailureReason
-
- Type: string
Returns the error message if there is a rollback.
- State
-
- Type: string
Returns the current state of the model.
- Status
-
- Type: string
Returns the deployment status of the model.
- StatusReason
-
- Type: string
Returns the error message for the deployment status result.
DeploymentResult
Description
Information about the result of a deployment on an edge device that is registered with SageMaker Edge Manager.
Members
- DeploymentEndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the deployment was ended, and the agent got the deployment results.
- DeploymentModels
-
- Type: Array of DeploymentModel structures
Returns a list of models deployed on the agent.
- DeploymentName
-
- Type: string
The name and unique ID of the deployment.
- DeploymentStartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the deployment was started on the agent.
- DeploymentStatus
-
- Type: string
Returns the bucket error code.
- DeploymentStatusMessage
-
- Type: string
Returns the detailed error message.
EdgeDeployment
Description
Information about a deployment on an edge device that is registered with SageMaker Edge Manager.
Members
- Definitions
-
- Type: Array of Definition structures
Returns a list of Definition objects.
- DeploymentName
-
- Type: string
The name and unique ID of the deployment.
- FailureHandlingPolicy
-
- Type: string
Determines whether to rollback to previous configuration if deployment fails.
- Type
-
- Type: string
The type of the deployment.
EdgeMetric
Description
Information required for edge device metrics.
Members
InternalServiceException
Description
An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services 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.