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

****************
ListArchiveRules
****************



.. py:class:: AccessAnalyzer.Paginator.ListArchiveRules

  ::

    
    paginator = client.get_paginator('list_archive_rules')

  
  

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

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

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


    **Request Syntax**
    ::

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

      The name of the analyzer to retrieve rules from.

      

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

      
      ::

        {
            'archiveRules': [
                {
                    'ruleName': 'string',
                    'filter': {
                        'string': {
                            'eq': [
                                'string',
                            ],
                            'neq': [
                                'string',
                            ],
                            'contains': [
                                'string',
                            ],
                            'exists': True|False
                        }
                    },
                    'createdAt': datetime(2015, 1, 1),
                    'updatedAt': datetime(2015, 1, 1)
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 

        The response to the request.

        
        

        - **archiveRules** *(list) --* 

          A list of archive rules created for the specified analyzer.

          
          

          - *(dict) --* 

            Contains information about an archive rule. Archive rules automatically archive new findings that meet the criteria you define when you create the rule.

            
            

            - **ruleName** *(string) --* 

              The name of the archive rule.

              
            

            - **filter** *(dict) --* 

              A filter used to define the archive rule.

              
              

              - *(string) --* 
                

                - *(dict) --* 

                  The criteria to use in the filter that defines the archive rule. For more information on available filter keys, see `IAM Access Analyzer filter keys <https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html>`__.

                  
                  

                  - **eq** *(list) --* 

                    An "equals" operator to match for the filter used to create the rule.

                    
                    

                    - *(string) --* 
                
                  

                  - **neq** *(list) --* 

                    A "not equals" operator to match for the filter used to create the rule.

                    
                    

                    - *(string) --* 
                
                  

                  - **contains** *(list) --* 

                    A "contains" operator to match for the filter used to create the rule.

                    
                    

                    - *(string) --* 
                
                  

                  - **exists** *(boolean) --* 

                    An "exists" operator to match for the filter used to create the rule.

                    
              
          
        
            

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

              The time at which the archive rule was created.

              
            

            - **updatedAt** *(datetime) --* 

              The time at which the archive rule was last updated.

              
        
      
        

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

          A token to resume pagination.

          
    