Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

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(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.
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
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
L{botocore.paginate.Paginator}
Returns
A paginator object.
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
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'
)
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.

Returns

None

Exceptions

  • SagemakerEdgeManager.Client.exceptions.InternalServiceException

Paginators

The available paginators are: