Table of Contents
SagemakerEdgeManager.Client¶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:
can_paginate()close()get_deployments()get_device_registration()get_paginator()get_waiter()send_heartbeat()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
get_deployments(**kwargs)¶Use to get the active deployments from a device.
See also: AWS API Documentation
Request Syntax
response = client.get_deployments(
DeviceName='string',
DeviceFleetName='string'
)
[REQUIRED]
The unique name of the device you want to get the configuration of active deployments from.
[REQUIRED]
The name of the fleet that the device belongs to.
dict
Response Syntax
{
'Deployments': [
{
'DeploymentName': 'string',
'Type': 'Model',
'FailureHandlingPolicy': 'ROLLBACK_ON_FAILURE'|'DO_NOTHING',
'Definitions': [
{
'ModelHandle': 'string',
'S3Url': 'string',
'Checksum': {
'Type': 'SHA1',
'Sum': 'string'
},
'State': 'DEPLOY'|'UNDEPLOY'
},
]
},
]
}
Response Structure
(dict) --
Deployments (list) --
Returns a list of the configurations of the active deployments on the device.
(dict) --
Information about a deployment on an edge device that is registered with SageMaker Edge Manager.
DeploymentName (string) --
The name and unique ID of the deployment.
Type (string) --
The type of the deployment.
FailureHandlingPolicy (string) --
Determines whether to rollback to previous configuration if deployment fails.
Definitions (list) --
Returns a list of Definition objects.
(dict) --
ModelHandle (string) --
The unique model handle.
S3Url (string) --
The absolute S3 location of the model.
Checksum (dict) --
The checksum information of the model.
Type (string) --
The type of the checksum.
Sum (string) --
The checksum of the model.
State (string) --
The desired state of the model.
Exceptions
SagemakerEdgeManager.Client.exceptions.InternalServiceExceptionget_device_registration(**kwargs)¶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
SagemakerEdgeManager.Client.exceptions.InternalServiceExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
send_heartbeat(**kwargs)¶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',
DeploymentResult={
'DeploymentName': 'string',
'DeploymentStatus': 'string',
'DeploymentStatusMessage': 'string',
'DeploymentStartTime': datetime(2015, 1, 1),
'DeploymentEndTime': datetime(2015, 1, 1),
'DeploymentModels': [
{
'ModelHandle': 'string',
'ModelName': 'string',
'ModelVersion': 'string',
'DesiredState': 'DEPLOY'|'UNDEPLOY',
'State': 'DEPLOY'|'UNDEPLOY',
'Status': 'SUCCESS'|'FAIL',
'StatusReason': 'string',
'RollbackFailureReason': '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.
Returns the result of a deployment on the device.
The name and unique ID of the deployment.
Returns the bucket error code.
Returns the detailed error message.
The timestamp of when the deployment was started on the agent.
The timestamp of when the deployment was ended, and the agent got the deployment results.
Returns a list of models deployed on the agent.
The unique handle of the model.
The name of the model.
The version of the model.
The desired state of the model.
Returns the current state of the model.
Returns the deployment status of the model.
Returns the error message for the deployment status result.
Returns the error message if there is a rollback.
None
Exceptions
SagemakerEdgeManager.Client.exceptions.InternalServiceExceptionThe available paginators are: