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

******************
ListAccessPreviews
******************



.. py:class:: AccessAnalyzer.Paginator.ListAccessPreviews

  ::

    
    paginator = client.get_paginator('list_access_previews')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          analyzerArn='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type analyzerArn: string
    :param analyzerArn: **[REQUIRED]** 

      The `ARN of the analyzer <https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources>`__ used to generate the access preview.

      

    
    :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**

      
      ::

        {
            'accessPreviews': [
                {
                    'id': 'string',
                    'analyzerArn': 'string',
                    'createdAt': datetime(2015, 1, 1),
                    'status': 'COMPLETED'|'CREATING'|'FAILED',
                    'statusReason': {
                        'code': 'INTERNAL_ERROR'|'INVALID_CONFIGURATION'
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **accessPreviews** *(list) --* 

          A list of access previews retrieved for the analyzer.

          
          

          - *(dict) --* 

            Contains a summary of information about an access preview.

            
            

            - **id** *(string) --* 

              The unique ID for the access preview.

              
            

            - **analyzerArn** *(string) --* 

              The ARN of the analyzer used to generate the access preview.

              
            

            - **createdAt** *(datetime) --* 

              The time at which the access preview was created.

              
            

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

              The status of the access preview.

               

              
              * ``Creating`` - The access preview creation is in progress.
               
              * ``Completed`` - The access preview is complete and previews the findings for external access to the resource.
               
              * ``Failed`` - The access preview creation has failed.
              

              
            

            - **statusReason** *(dict) --* 

              Provides more details about the current status of the access preview. For example, if the creation of the access preview fails, a ``Failed`` status is returned. This failure can be due to an internal issue with the analysis or due to an invalid proposed resource configuration.

              
              

              - **code** *(string) --* 

                The reason code for the current status of the access preview.

                
          
        
      
        

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

          A token to resume pagination.

          
    