list_firewall_rules ¶

def list_firewall_rules(
    self,
    firewall_rule_group_id: "capo_route53resolver.types.resource_id.ResourceId",
    *,
    config_overrides: Optional[Route53ResolverClientConfig] = None,
    priority: Optional["capo_route53resolver.types.priority.Priority"] = None,
    action: Optional["capo_route53resolver.types.action.Action"] = None,
    max_results: Optional[
        "capo_route53resolver.types.max_results.MaxResults"
    ] = None,
    next_token: Optional["capo_route53resolver.types.next_token.NextToken"] = None,
) -> "capo_route53resolver.types.list_firewall_rules_response.ListFirewallRulesResponse":
    """<p>Retrieves the firewall rules that you have defined for the specified firewall rule group. DNS Firewall uses the rules in a rule group to filter DNS network traffic for a VPC.</p> <p>A single call might return only a partial list of the rules. For information, see <code>MaxResults</code>.</p> <p>For rules that require asynchronous provisioning, the response includes <code>Status</code> (see <a>FirewallRuleStatus</a>) and, on failure, <code>StatusMessage</code> with the reason.</p>

    Args:
        firewall_rule_group_id: <p>The unique identifier of the firewall rule group that you want to retrieve the rules for. </p>
        priority: <p>Optional additional filter for the rules to retrieve.</p> <p>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.</p>
        action: <p>Optional additional filter for the rules to retrieve.</p> <p>The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list, or a threat in a DNS Firewall Advanced rule:</p> <ul> <li> <p> <code>ALLOW</code> - Permit the request to go through. Not availabe for DNS Firewall Advanced rules.</p> </li> <li> <p> <code>ALERT</code> - Permit the request to go through but send an alert to the logs.</p> </li> <li> <p> <code>BLOCK</code> - Disallow the request. If this is specified, additional handling details are provided in the rule's <code>BlockResponse</code> setting. </p> </li> </ul>
        max_results: <p>The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p> <p>If you don't specify a value for <code>MaxResults</code>, Resolver returns up to 100 objects. </p>
        next_token: <p>For the first call to this list request, omit this value.</p> <p>When you request a list of objects, Resolver returns at most the number of objects specified in <code>MaxResults</code>. If more objects are available for retrieval, Resolver returns a <code>NextToken</code> value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.</p>

    Raises:
        capo_route53resolver.errors.access_denied_exception.AccessDeniedException: <p>The current account doesn't have the IAM permissions required to perform the specified Resolver operation.</p> <p>This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.</p>
        capo_route53resolver.errors.internal_service_error_exception.InternalServiceErrorException: <p>We encountered an unknown error. Try again in a few minutes.</p>
        capo_route53resolver.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource doesn't exist.</p>
        capo_route53resolver.errors.throttling_exception.ThrottlingException: <p>The request was throttled. Try again in a few minutes.</p>
        capo_route53resolver.errors.validation_exception.ValidationException: <p>You have provided an invalid command. If you ran the <code>UpdateFirewallDomains</code> request. supported values are <code>ADD</code>, <code>REMOVE</code>, or <code>REPLACE</code> a domain.</p>
        capo_route53resolver.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_route53resolver.types.list_firewall_rules_request.ListFirewallRulesRequest]",
    ) -> OperationResponse[
        "capo_route53resolver.types.list_firewall_rules_response.ListFirewallRulesResponse"
    ]:
        import capo_route53resolver._operations.route53_resolver.list_firewall_rules

        output, http_response = (
            capo_route53resolver._operations.route53_resolver.list_firewall_rules.list_firewall_rules(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListFirewallRules")
    )
    input_: capo_route53resolver.types.list_firewall_rules_request.ListFirewallRulesRequest = {
        "firewall_rule_group_id": firewall_rule_group_id
    }
    if priority is not None:
        input_["priority"] = priority
    if action is not None:
        input_["action"] = action
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output