AccessAnalyzer / Paginator / ListArchiveRules

ListArchiveRules#

class AccessAnalyzer.Paginator.ListArchiveRules#

paginator = client.get_paginator('list_archive_rules')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from AccessAnalyzer.Client.list_archive_rules().

Request Syntax

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

Parameters:

analyzerName (string) –
[REQUIRED]

The name of the analyzer to retrieve rules from.
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

{
    '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.
    - 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.
        
        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.