A low-level client representing Amazon Sagemaker Edge Manager
SageMaker Edge Manager dataplane service for communicating with active agents.
client = session.create_client('sagemaker-edge')
These are the available methods:
Check if an operation can be paginated.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is 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.
Closes underlying endpoint connections.
Use to get the active deployments from a device.
See also: AWS API Documentation
Request Syntax
response = client.get_deployments(
DeviceName='string',
DeviceFleetName='string'
)
DeviceName (string) –
[REQUIRED]
The unique name of the device you want to get the configuration of active deployments from.
DeviceFleetName (string) –
[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
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'
)
DeviceName (string) –
[REQUIRED]
The unique name of the device you want to get the registration status from.
DeviceFleetName (string) –
[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.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is 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")
.
OperationNotPageableError – Raised if the operation is not
pageable. You can use the client.can_paginate
method to
check if an operation is pageable.
L{botocore.paginate.Paginator}
A paginator object.
Returns an object that can wait for some condition.
waiter_name (str) – The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
The specified waiter object.
botocore.waiter.Waiter
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'
},
]
}
)
AgentMetrics (list) –
For internal use. Returns a list of SageMaker Edge Manager agent operating metrics.
(dict) –
Information required for edge device metrics.
Dimension (string) –
The dimension of metrics published.
MetricName (string) –
Returns the name of the metric.
Value (float) –
Returns the value of the metric.
Timestamp (datetime) –
Timestamp of when the metric was requested.
Models (list) –
Returns a list of models deployed on the the device.
(dict) –
Information about a model deployed on an edge device that is registered with SageMaker Edge Manager.
ModelName (string) –
The name of the model.
ModelVersion (string) –
The version of the model.
LatestSampleTime (datetime) –
The timestamp of the last data sample taken.
LatestInference (datetime) –
The timestamp of the last inference that was made.
ModelMetrics (list) –
Information required for model metrics.
(dict) –
Information required for edge device metrics.
Dimension (string) –
The dimension of metrics published.
MetricName (string) –
Returns the name of the metric.
Value (float) –
Returns the value of the metric.
Timestamp (datetime) –
Timestamp of when the metric was requested.
AgentVersion (string) –
[REQUIRED]
Returns the version of the agent.
DeviceName (string) –
[REQUIRED]
The unique name of the device.
DeviceFleetName (string) –
[REQUIRED]
The name of the fleet that the device belongs to.
DeploymentResult (dict) –
Returns the result of a deployment on the device.
DeploymentName (string) –
The name and unique ID of the deployment.
DeploymentStatus (string) –
Returns the bucket error code.
DeploymentStatusMessage (string) –
Returns the detailed error message.
DeploymentStartTime (datetime) –
The timestamp of when the deployment was started on the agent.
DeploymentEndTime (datetime) –
The timestamp of when the deployment was ended, and the agent got the deployment results.
DeploymentModels (list) –
Returns a list of models deployed on the agent.
(dict) –
ModelHandle (string) –
The unique handle of the model.
ModelName (string) –
The name of the model.
ModelVersion (string) –
The version of the model.
DesiredState (string) –
The desired state of the model.
State (string) –
Returns the current state of the model.
Status (string) –
Returns the deployment status of the model.
StatusReason (string) –
Returns the error message for the deployment status result.
RollbackFailureReason (string) –
Returns the error message if there is a rollback.
None
Exceptions
Client exceptions are available on a client instance via the exceptions
property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services customer support.
Example
try:
...
except client.exceptions.InternalServiceException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services customer support.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The available paginators are: