IoT / Paginator / ListPrincipalThingsV2

ListPrincipalThingsV2#

class IoT.Paginator.ListPrincipalThingsV2#
paginator = client.get_paginator('list_principal_things_v2')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    principal='string',
    thingPrincipalType='EXCLUSIVE_THING'|'NON_EXCLUSIVE_THING',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • principal (string) –

    [REQUIRED]

    The principal. A principal can be an X.509 certificate or an Amazon Cognito ID.

  • thingPrincipalType (string) –

    The type of the relation you want to filter in the response. If no value is provided in this field, the response will list all things, including both the EXCLUSIVE_THING and NON_EXCLUSIVE_THING attachment types.

    • EXCLUSIVE_THING - Attaches the specified principal to the specified thing, exclusively. The thing will be the only thing that’s attached to the principal.

    • NON_EXCLUSIVE_THING - Attaches the specified principal to the specified thing. Multiple things can be attached to the principal.

  • 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

{
    'principalThingObjects': [
        {
            'thingName': 'string',
            'thingPrincipalType': 'EXCLUSIVE_THING'|'NON_EXCLUSIVE_THING'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • principalThingObjects (list) –

      A list of thingPrincipalObject that represents the principal and the type of relation it has with the thing.

      • (dict) –

        An object that represents the thing and the type of relation it has with the principal.

        • thingName (string) –

          The name of the thing.

        • thingPrincipalType (string) –

          The type of the relation you want to specify when you attach a principal to a thing. The value defaults to NON_EXCLUSIVE_THING.

          • EXCLUSIVE_THING - Attaches the specified principal to the specified thing, exclusively. The thing will be the only thing that’s attached to the principal.

          • NON_EXCLUSIVE_THING - Attaches the specified principal to the specified thing. Multiple things can be attached to the principal.

    • NextToken (string) –

      A token to resume pagination.