Route53Resolver / Paginator / ListFirewallRules

ListFirewallRules#

class Route53Resolver.Paginator.ListFirewallRules#

paginator = client.get_paginator('list_firewall_rules')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from Route53Resolver.Client.list_firewall_rules().

Request Syntax

response_iterator = paginator.paginate(
    FirewallRuleGroupId='string',
    Priority=123,
    Action='ALLOW'|'BLOCK'|'ALERT',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

FirewallRuleGroupId (string) –
[REQUIRED]

The unique identifier of the firewall rule group that you want to retrieve the rules for.
Priority (integer) –
Optional additional filter for the rules to retrieve.

The setting that determines the processing order of the rules in a rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.
Action (string) –
Optional additional filter for the rules to retrieve.

The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule’s domain list:
- ALLOW - Permit the request to go through.
- ALERT - Permit the request to go through but send an alert to the logs.
- BLOCK - Disallow the request. If this is specified, additional handling details are provided in the rule’s BlockResponse setting.
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

{
    'FirewallRules': [
        {
            'FirewallRuleGroupId': 'string',
            'FirewallDomainListId': 'string',
            'Name': 'string',
            'Priority': 123,
            'Action': 'ALLOW'|'BLOCK'|'ALERT',
            'BlockResponse': 'NODATA'|'NXDOMAIN'|'OVERRIDE',
            'BlockOverrideDomain': 'string',
            'BlockOverrideDnsType': 'CNAME',
            'BlockOverrideTtl': 123,
            'CreatorRequestId': 'string',
            'CreationTime': 'string',
            'ModificationTime': 'string'
        },
    ]
}

Response Structure

(dict) –
- FirewallRules (list) –
  
  A list of the rules that you have defined.
  
  This might be a partial list of the firewall rules that you’ve defined. For information, see MaxResults.
  - (dict) –
    
    A single firewall rule in a rule group.
    - FirewallRuleGroupId (string) –
      
      The unique identifier of the firewall rule group of the rule.
    - FirewallDomainListId (string) –
      
      The ID of the domain list that’s used in the rule.
    - Name (string) –
      
      The name of the rule.
    - Priority (integer) –
      
      The priority of the rule in the rule group. This value must be unique within the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.
    - Action (string) –
      
      The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule’s domain list:
      - ALLOW - Permit the request to go through.
      - ALERT - Permit the request to go through but send an alert to the logs.
      - BLOCK - Disallow the request. If this is specified, additional handling details are provided in the rule’s BlockResponse setting.
    - BlockResponse (string) –
      
      The way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK.
      - NODATA - Respond indicating that the query was successful, but no response is available for it.
      - NXDOMAIN - Respond indicating that the domain name that’s in the query doesn’t exist.
      - OVERRIDE - Provide a custom override in the response. This option requires custom handling details in the rule’s BlockOverride* settings.
    - BlockOverrideDomain (string) –
      
      The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.
    - BlockOverrideDnsType (string) –
      
      The DNS record’s type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.
    - BlockOverrideTtl (integer) –
      
      The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.
    - CreatorRequestId (string) –
      
      A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of executing the operation twice. This can be any unique string, for example, a timestamp.
    - CreationTime (string) –
      
      The date and time that the rule was created, in Unix time format and Coordinated Universal Time (UTC).
    - ModificationTime (string) –
      
      The date and time that the rule was last modified, in Unix time format and Coordinated Universal Time (UTC).