VerifiedPermissions / Paginator / ListPolicyTemplates

ListPolicyTemplates#

class VerifiedPermissions.Paginator.ListPolicyTemplates#
paginator = client.get_paginator('list_policy_templates')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from VerifiedPermissions.Client.list_policy_templates().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    policyStoreId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • policyStoreId (string) –

    [REQUIRED]

    Specifies the ID of the policy store that contains the policy templates you want to list.

  • 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

{
    'policyTemplates': [
        {
            'policyStoreId': 'string',
            'policyTemplateId': 'string',
            'description': 'string',
            'createdDate': datetime(2015, 1, 1),
            'lastUpdatedDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • policyTemplates (list) –

      The list of the policy templates in the specified policy store.

      • (dict) –

        Contains details about a policy template

        This data type is used as a response parameter for the ListPolicyTemplates operation.

        • policyStoreId (string) –

          The unique identifier of the policy store that contains the template.

        • policyTemplateId (string) –

          The unique identifier of the policy template.

        • description (string) –

          The description attached to the policy template.

        • createdDate (datetime) –

          The date and time that the policy template was created.

        • lastUpdatedDate (datetime) –

          The date and time that the policy template was most recently updated.

    • NextToken (string) –

      A token to resume pagination.