NetworkSecurityManagerCustomerAPI / Paginator / ListRuleSnapshots

ListRuleSnapshots¶

class NetworkSecurityManagerCustomerAPI.Paginator.ListRuleSnapshots¶

paginator = client.get_paginator('list_rule_snapshots')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from NetworkSecurityManagerCustomerAPI.Client.list_rule_snapshots().

Request Syntax

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

Parameters:

ruleIdentifier (string) –
[REQUIRED]

The identifier of the rule. This is the rule’s Amazon Resource Name (ARN).
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

{
    'snapshots': [
        {
            'ruleId': 'string',
            'ruleArn': 'string',
            'ruleName': 'string',
            'firewallType': 'WAF',
            'ruleType': 'CONFIGURATION'|'INSPECTION',
            'status': 'DRAFT'|'ACTIVE'|'DISABLED',
            'version': 'string',
            'hasPublishedVersion': True|False,
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- snapshots (list) –
  
  The snapshots of the rule.
  - (dict) –
    
    Summary information about a rule.
    - ruleId (string) –
      
      The service-generated id of the rule.
    - ruleArn (string) –
      
      The Amazon Resource Name (ARN) of the rule.
    - ruleName (string) –
      
      The name of the rule.
    - firewallType (string) –
      
      The firewall type associated with the resource.
    - ruleType (string) –
      
      The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.
    - status (string) –
      
      The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
    - version (string) –
      
      The version of the resource.
    - hasPublishedVersion (boolean) –
      
      Specifies whether a published version of the resource exists.
    - updatedAt (datetime) –
      
      The time when the resource was last updated. For a snapshot, this is the time when the snapshot was created.
- NextToken (string) –
  
  A token to resume pagination.