SageMaker / Paginator / ListDevices


class SageMaker.Paginator.ListDevices#
paginator = client.get_paginator('list_devices')

Creates an iterator that will paginate through responses from SageMaker.Client.list_devices().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    LatestHeartbeatAfter=datetime(2015, 1, 1),
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • 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.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



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'


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.