IoT / Paginator / ListThingPrincipals

ListThingPrincipals#

class IoT.Paginator.ListThingPrincipals#

paginator = client.get_paginator('list_thing_principals')

paginate(**kwargs)#

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

Request Syntax

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

Parameters:

thingName (string) –
[REQUIRED]

The name of the 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

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

Response Structure

(dict) –

The output from the ListThingPrincipals operation.
- principals (list) –
  
  The principals associated with the thing.
  - (string) –
- NextToken (string) –
  
  A token to resume pagination.