IoT / Paginator / ListThingGroups

ListThingGroups#

class IoT.Paginator.ListThingGroups#
paginator = client.get_paginator('list_thing_groups')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

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

  • parentGroup (string) – A filter that limits the results to those with the specified parent group.

  • namePrefixFilter (string) – A filter that limits the results to those with the specified name prefix.

  • recursive (boolean) – If true, return 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

{
    'thingGroups': [
        {
            'groupName': 'string',
            'groupArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • thingGroups (list) –

      The thing groups.

      • (dict) –

        The name and ARN of a group.

        • groupName (string) –

          The group name.

        • groupArn (string) –

          The group ARN.

    • NextToken (string) –

      A token to resume pagination.