:doc:`AccessAnalyzer <../../accessanalyzer>` / Paginator / ListPolicyGenerations

*********************
ListPolicyGenerations
*********************



.. py:class:: AccessAnalyzer.Paginator.ListPolicyGenerations

  ::

    
    paginator = client.get_paginator('list_policy_generations')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`AccessAnalyzer.Client.list_policy_generations`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/ListPolicyGenerations>`_    


    **Request Syntax**
    ::

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

      The ARN of the IAM entity (user or role) for which you are generating a policy. Use this with ``ListGeneratedPolicies`` to filter the results to only include results for a specific principal.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'policyGenerations': [
                {
                    'jobId': 'string',
                    'principalArn': 'string',
                    'status': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'CANCELED',
                    'startedOn': datetime(2015, 1, 1),
                    'completedOn': datetime(2015, 1, 1)
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **policyGenerations** *(list) --* 

          A ``PolicyGeneration`` object that contains details about the generated policy.

          
          

          - *(dict) --* 

            Contains details about the policy generation status and properties.

            
            

            - **jobId** *(string) --* 

              The ``JobId`` that is returned by the ``StartPolicyGeneration`` operation. The ``JobId`` can be used with ``GetGeneratedPolicy`` to retrieve the generated policies or used with ``CancelPolicyGeneration`` to cancel the policy generation request.

              
            

            - **principalArn** *(string) --* 

              The ARN of the IAM entity (user or role) for which you are generating a policy.

              
            

            - **status** *(string) --* 

              The status of the policy generation request.

              
            

            - **startedOn** *(datetime) --* 

              A timestamp of when the policy generation started.

              
            

            - **completedOn** *(datetime) --* 

              A timestamp of when the policy generation was completed.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    