IoT / Paginator / ListThingsInThingGroup

ListThingsInThingGroup#

class IoT.Paginator.ListThingsInThingGroup#
paginator = client.get_paginator('list_things_in_thing_group')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from IoT.Client.list_things_in_thing_group().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    thingGroupName='string',
    recursive=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • thingGroupName (string) –

    [REQUIRED]

    The thing group name.

  • recursive (boolean) – When true, list things in this thing group and in all child groups as well.

  • 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

{
    'things': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • things (list) –

      The things in the specified thing group.

      • (string) –

    • NextToken (string) –

      A token to resume pagination.