GreengrassV2 / Paginator / ListClientDevicesAssociatedWithCoreDevice

ListClientDevicesAssociatedWithCoreDevice

class GreengrassV2.Paginator.ListClientDevicesAssociatedWithCoreDevice

paginator = client.get_paginator('list_client_devices_associated_with_core_device')

paginate(**kwargs)

Creates an iterator that will paginate through responses from GreengrassV2.Client.list_client_devices_associated_with_core_device().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    coreDeviceThingName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• coreDeviceThingName (string) –

  [REQUIRED]

  The name of the core device. This is also the name of the IoT thing.

• 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:

dict

Returns:

Response Syntax

{
    'associatedClientDevices': [
        {
            'thingName': 'string',
            'associationTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • associatedClientDevices (list) –

    A list that describes the client devices that are associated with the core device.

    • (dict) –

      Contains information about a client device that is associated to a core device for cloud discovery.

      • thingName (string) –

        The name of the IoT thing that represents the associated client device.

      • associationTimestamp (datetime) –

        The time that the client device was associated, expressed in ISO 8601 format.

  • NextToken (string) –

    A token to resume pagination.