IoT1ClickDevicesService / Client / describe_device

describe_device#

IoT1ClickDevicesService.Client.describe_device(**kwargs)#

Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.

See also: AWS API Documentation

Request Syntax

response = client.describe_device(
    DeviceId='string'
)
Parameters:

DeviceId (string) –

[REQUIRED]

The unique identifier of the device.

Return type:

dict

Returns:

Response Syntax

{
    'DeviceDescription': {
        'Arn': 'string',
        'Attributes': {
            'string': 'string'
        },
        'DeviceId': 'string',
        'Enabled': True|False,
        'RemainingLife': 123.0,
        'Type': 'string',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) –

    200 response

    • DeviceDescription (dict) –

      Device details.

      • Arn (string) –

        The ARN of the device.

      • Attributes (dict) –

        An array of zero or more elements of DeviceAttribute objects providing user specified device attributes.

        • (string) –

          • (string) –

      • DeviceId (string) –

        The unique identifier of the device.

      • Enabled (boolean) –

        A Boolean value indicating whether or not the device is enabled.

      • RemainingLife (float) –

        A value between 0 and 1 inclusive, representing the fraction of life remaining for the device.

      • Type (string) –

        The type of the device, such as “button”.

      • Tags (dict) –

        The tags currently associated with the AWS IoT 1-Click device.

        • (string) –

          • (string) –

Exceptions