list_devices

list_devices(**kwargs)

A list of devices.

See also: AWS API Documentation

Request Syntax

response = client.list_devices(
    NextToken='string',
    MaxResults=123,
    LatestHeartbeatAfter=datetime(2015, 1, 1),
    ModelName='string',
    DeviceFleetName='string'
)

Parameters

• NextToken (string) -- The response from the last list when returning a list large enough to need tokening.
• MaxResults (integer) -- Maximum number of results to select.
• LatestHeartbeatAfter (datetime) -- Select fleets where the job was updated after X
• ModelName (string) -- A filter that searches devices that contains this name in any of their models.
• DeviceFleetName (string) -- Filter for fleets containing this name in their device fleet name.

Return type

dict

Returns

Response Syntax

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

Response Structure

• (dict) --

  • DeviceSummaries (list) --

    Summary of devices.

    • (dict) --

      Summary of the device.

      • DeviceName (string) --

        The unique identifier of the device.

      • DeviceArn (string) --

        Amazon Resource Name (ARN) 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) --

          Summary of model on edge device.

          • ModelName (string) --

            The name of the model.

          • ModelVersion (string) --

            The version model.

      • AgentVersion (string) --

        Edge Manager agent version.

  • NextToken (string) --

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