IoT / Paginator / ListPolicyPrincipals

ListPolicyPrincipals#

class IoT.Paginator.ListPolicyPrincipals#
paginator = client.get_paginator('list_policy_principals')
paginate(**kwargs)#

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

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

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

  • policyName (string) –

    [REQUIRED]

    The policy name.

  • ascendingOrder (boolean) – Specifies the order for results. If true, the results are returned in ascending creation order.

  • 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 ListPolicyPrincipals operation.

    • principals (list) –

      The descriptions of the principals.

      • (string) –

    • NextToken (string) –

      A token to resume pagination.