:doc:`AccessAnalyzer <../../accessanalyzer>` / Client / list_archive_rules

******************
list_archive_rules
******************



.. py:method:: AccessAnalyzer.Client.list_archive_rules(**kwargs)

  

  Retrieves a list of archive rules created for the specified analyzer.

  

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


  **Request Syntax**
  ::

    response = client.list_archive_rules(
        analyzerName='string',
        nextToken='string',
        maxResults=123
    )
    
  :type analyzerName: string
  :param analyzerName: **[REQUIRED]** 

    The name of the analyzer to retrieve rules from.

    

  
  :type nextToken: string
  :param nextToken: 

    A token used for pagination of results returned.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return in the request.

    

  
  
  :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 used for pagination of results returned.

        
  
  **Exceptions**
  
  *   :py:class:`AccessAnalyzer.Client.exceptions.ValidationException`

  
  *   :py:class:`AccessAnalyzer.Client.exceptions.InternalServerException`

  
  *   :py:class:`AccessAnalyzer.Client.exceptions.ThrottlingException`

  
  *   :py:class:`AccessAnalyzer.Client.exceptions.AccessDeniedException`

  