IoT / Paginator / ListPolicies

ListPolicies#

class IoT.Paginator.ListPolicies#
paginator = client.get_paginator('list_policies')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ascendingOrder=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • 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

{
    'policies': [
        {
            'policyName': 'string',
            'policyArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    The output from the ListPolicies operation.

    • policies (list) –

      The descriptions of the policies.

      • (dict) –

        Describes an IoT policy.

        • policyName (string) –

          The policy name.

        • policyArn (string) –

          The policy ARN.

    • NextToken (string) –

      A token to resume pagination.