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