SagemakerEdgeManager ******************** Client ====== class 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 SagemakerEdgeManager / Client / get_paginator get_paginator ************* SagemakerEdgeManager.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **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")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. SagemakerEdgeManager / Client / can_paginate can_paginate ************ SagemakerEdgeManager.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **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")". Returns: "True" if the operation can be paginated, "False" otherwise. SagemakerEdgeManager / Client / get_waiter get_waiter ********** SagemakerEdgeManager.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" SagemakerEdgeManager / Client / get_device_registration get_device_registration *********************** SagemakerEdgeManager.Client.get_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' ) Parameters: * **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. Return type: dict Returns: **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.InternalServiceException" SagemakerEdgeManager / Client / close close ***** SagemakerEdgeManager.Client.close() Closes underlying endpoint connections. SagemakerEdgeManager / Client / get_deployments get_deployments *************** SagemakerEdgeManager.Client.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' ) Parameters: * **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. Return type: dict Returns: **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.InternalServiceException" SagemakerEdgeManager / Client / send_heartbeat send_heartbeat ************** SagemakerEdgeManager.Client.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' }, ] } ) Parameters: * **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. Returns: None **Exceptions** * "SagemakerEdgeManager.Client.exceptions.InternalServiceException"