amazonka-route53resolver-2.0: Amazon Route 53 Resolver SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Route53Resolver.ListFirewallRules

Description

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.

A single call might return only a partial list of the rules. For information, see MaxResults.

This operation returns paginated results.

Synopsis

Creating a Request

data ListFirewallRules Source #

See: newListFirewallRules smart constructor.

Constructors

ListFirewallRules' 

Fields

  • action :: Maybe Action

    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.
  • maxResults :: Maybe Natural

    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 NextToken value that you can use in a subsequent call to get the next batch of objects.

    If you don't specify a value for MaxResults, Resolver returns up to 100 objects.

  • nextToken :: Maybe Text

    For the first call to this list request, omit this value.

    When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken 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.

  • priority :: Maybe Int

    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.

  • firewallRuleGroupId :: Text

    The unique identifier of the firewall rule group that you want to retrieve the rules for.

Instances

Instances details
ToJSON ListFirewallRules Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListFirewallRules

ToHeaders ListFirewallRules Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListFirewallRules

ToPath ListFirewallRules Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListFirewallRules

ToQuery ListFirewallRules Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListFirewallRules

AWSPager ListFirewallRules Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListFirewallRules

AWSRequest ListFirewallRules Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListFirewallRules

Associated Types

type AWSResponse ListFirewallRules #

Generic ListFirewallRules Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListFirewallRules

Associated Types

type Rep ListFirewallRules :: Type -> Type #

Read ListFirewallRules Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListFirewallRules

Show ListFirewallRules Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListFirewallRules

NFData ListFirewallRules Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListFirewallRules

Methods

rnf :: ListFirewallRules -> () #

Eq ListFirewallRules Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListFirewallRules

Hashable ListFirewallRules Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListFirewallRules

type AWSResponse ListFirewallRules Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListFirewallRules

type Rep ListFirewallRules Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListFirewallRules

type Rep ListFirewallRules = D1 ('MetaData "ListFirewallRules" "Amazonka.Route53Resolver.ListFirewallRules" "amazonka-route53resolver-2.0-GFukx1WIgCPEXMh1BiYlp6" 'False) (C1 ('MetaCons "ListFirewallRules'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Action)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "priority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "firewallRuleGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListFirewallRules Source #

Create a value of ListFirewallRules with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListFirewallRules, listFirewallRules_action - 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.

$sel:maxResults:ListFirewallRules', listFirewallRules_maxResults - 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 NextToken value that you can use in a subsequent call to get the next batch of objects.

If you don't specify a value for MaxResults, Resolver returns up to 100 objects.

ListFirewallRules, listFirewallRules_nextToken - For the first call to this list request, omit this value.

When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken 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.

ListFirewallRules, listFirewallRules_priority - 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.

ListFirewallRules, listFirewallRules_firewallRuleGroupId - The unique identifier of the firewall rule group that you want to retrieve the rules for.

Request Lenses

listFirewallRules_action :: Lens' ListFirewallRules (Maybe Action) Source #

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.

listFirewallRules_maxResults :: Lens' ListFirewallRules (Maybe Natural) Source #

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 NextToken value that you can use in a subsequent call to get the next batch of objects.

If you don't specify a value for MaxResults, Resolver returns up to 100 objects.

listFirewallRules_nextToken :: Lens' ListFirewallRules (Maybe Text) Source #

For the first call to this list request, omit this value.

When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken 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.

listFirewallRules_priority :: Lens' ListFirewallRules (Maybe Int) Source #

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.

listFirewallRules_firewallRuleGroupId :: Lens' ListFirewallRules Text Source #

The unique identifier of the firewall rule group that you want to retrieve the rules for.

Destructuring the Response

data ListFirewallRulesResponse Source #

See: newListFirewallRulesResponse smart constructor.

Constructors

ListFirewallRulesResponse' 

Fields

  • firewallRules :: Maybe [FirewallRule]

    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.

  • nextToken :: Maybe Text

    If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListFirewallRulesResponse Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListFirewallRules

Associated Types

type Rep ListFirewallRulesResponse :: Type -> Type #

Read ListFirewallRulesResponse Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListFirewallRules

Show ListFirewallRulesResponse Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListFirewallRules

NFData ListFirewallRulesResponse Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListFirewallRules

Eq ListFirewallRulesResponse Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListFirewallRules

type Rep ListFirewallRulesResponse Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListFirewallRules

type Rep ListFirewallRulesResponse = D1 ('MetaData "ListFirewallRulesResponse" "Amazonka.Route53Resolver.ListFirewallRules" "amazonka-route53resolver-2.0-GFukx1WIgCPEXMh1BiYlp6" 'False) (C1 ('MetaCons "ListFirewallRulesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "firewallRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FirewallRule])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListFirewallRulesResponse Source #

Create a value of ListFirewallRulesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:firewallRules:ListFirewallRulesResponse', listFirewallRulesResponse_firewallRules - 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.

ListFirewallRules, listFirewallRulesResponse_nextToken - If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.

$sel:httpStatus:ListFirewallRulesResponse', listFirewallRulesResponse_httpStatus - The response's http status code.

Response Lenses

listFirewallRulesResponse_firewallRules :: Lens' ListFirewallRulesResponse (Maybe [FirewallRule]) Source #

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.

listFirewallRulesResponse_nextToken :: Lens' ListFirewallRulesResponse (Maybe Text) Source #

If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.