SageMaker / Client / describe_device

describe_device

SageMaker.Client.describe_device(**kwargs)

Describes the device.

See also: AWS API Documentation

Request Syntax

response = client.describe_device(
    NextToken='string',
    DeviceName='string',
    DeviceFleetName='string'
)

Parameters:

• NextToken (string) – Next token of device description.

• DeviceName (string) –

  [REQUIRED]

  The unique ID of the device.

• DeviceFleetName (string) –

  [REQUIRED]

  The name of the fleet the devices belong to.

Return type:

dict

Returns:

Response Syntax

{
    'DeviceArn': 'string',
    'DeviceName': 'string',
    'Description': 'string',
    'DeviceFleetName': 'string',
    'IotThingName': 'string',
    'RegistrationTime': datetime(2015, 1, 1),
    'LatestHeartbeat': datetime(2015, 1, 1),
    'Models': [
        {
            'ModelName': 'string',
            'ModelVersion': 'string',
            'LatestSampleTime': datetime(2015, 1, 1),
            'LatestInference': datetime(2015, 1, 1)
        },
    ],
    'MaxModels': 123,
    'NextToken': 'string',
    'AgentVersion': 'string'
}

Response Structure

• (dict) –

  • DeviceArn (string) –

    The Amazon Resource Name (ARN) of the device.

  • DeviceName (string) –

    The unique identifier of the device.

  • Description (string) –

    A description of the device.

  • DeviceFleetName (string) –

    The name of the fleet the device belongs to.

  • IotThingName (string) –

    The Amazon Web Services Internet of Things (IoT) object thing name associated with the device.

  • RegistrationTime (datetime) –

    The timestamp of the last registration or de-reregistration.

  • LatestHeartbeat (datetime) –

    The last heartbeat received from the device.

  • Models (list) –

    Models on the device.

    • (dict) –

      The model on the edge device.

      • ModelName (string) –

        The name of the model.

      • ModelVersion (string) –

        The model version.

      • LatestSampleTime (datetime) –

        The timestamp of the last data sample taken.

      • LatestInference (datetime) –

        The timestamp of the last inference that was made.

  • MaxModels (integer) –

    The maximum number of models.

  • NextToken (string) –

    The response from the last list when returning a list large enough to need tokening.

  • AgentVersion (string) –

    Edge Manager agent version.

Exceptions

• SageMaker.Client.exceptions.ResourceNotFound