libZSservicesZSamazonka-network-firewallZSamazonka-network-firewall
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.NetworkFirewall.ListRuleGroups

Description

Retrieves the metadata for the rule groups that you have defined. Depending on your setting for max results and the number of rule groups, a single call might not return the full list.

This operation returns paginated results.

Synopsis

Creating a Request

data ListRuleGroups Source #

See: newListRuleGroups smart constructor.

Constructors

ListRuleGroups' 

Fields

  • nextToken :: Maybe Text

    When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

  • maxResults :: Maybe Natural

    The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

Instances

Instances details
Eq ListRuleGroups Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListRuleGroups

Read ListRuleGroups Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListRuleGroups

Show ListRuleGroups Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListRuleGroups

Generic ListRuleGroups Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListRuleGroups

Associated Types

type Rep ListRuleGroups :: Type -> Type #

NFData ListRuleGroups Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListRuleGroups

Methods

rnf :: ListRuleGroups -> () #

Hashable ListRuleGroups Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListRuleGroups

ToJSON ListRuleGroups Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListRuleGroups

AWSPager ListRuleGroups Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListRuleGroups

AWSRequest ListRuleGroups Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListRuleGroups

Associated Types

type AWSResponse ListRuleGroups #

ToHeaders ListRuleGroups Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListRuleGroups

ToPath ListRuleGroups Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListRuleGroups

ToQuery ListRuleGroups Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListRuleGroups

type Rep ListRuleGroups Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListRuleGroups

type Rep ListRuleGroups = D1 ('MetaData "ListRuleGroups" "Amazonka.NetworkFirewall.ListRuleGroups" "libZSservicesZSamazonka-network-firewallZSamazonka-network-firewall" 'False) (C1 ('MetaCons "ListRuleGroups'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))
type AWSResponse ListRuleGroups Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListRuleGroups

newListRuleGroups :: ListRuleGroups Source #

Create a value of ListRuleGroups 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:nextToken:ListRuleGroups', listRuleGroups_nextToken - When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

$sel:maxResults:ListRuleGroups', listRuleGroups_maxResults - The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

Request Lenses

listRuleGroups_nextToken :: Lens' ListRuleGroups (Maybe Text) Source #

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

listRuleGroups_maxResults :: Lens' ListRuleGroups (Maybe Natural) Source #

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

Destructuring the Response

data ListRuleGroupsResponse Source #

See: newListRuleGroupsResponse smart constructor.

Constructors

ListRuleGroupsResponse' 

Fields

  • nextToken :: Maybe Text

    When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

  • ruleGroups :: Maybe [RuleGroupMetadata]

    The rule group metadata objects that you've defined. Depending on your setting for max results and the number of rule groups, this might not be the full list.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListRuleGroupsResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListRuleGroups

Read ListRuleGroupsResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListRuleGroups

Show ListRuleGroupsResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListRuleGroups

Generic ListRuleGroupsResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListRuleGroups

Associated Types

type Rep ListRuleGroupsResponse :: Type -> Type #

NFData ListRuleGroupsResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListRuleGroups

Methods

rnf :: ListRuleGroupsResponse -> () #

type Rep ListRuleGroupsResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListRuleGroups

type Rep ListRuleGroupsResponse = D1 ('MetaData "ListRuleGroupsResponse" "Amazonka.NetworkFirewall.ListRuleGroups" "libZSservicesZSamazonka-network-firewallZSamazonka-network-firewall" 'False) (C1 ('MetaCons "ListRuleGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "ruleGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RuleGroupMetadata])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListRuleGroupsResponse Source #

Create a value of ListRuleGroupsResponse 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:nextToken:ListRuleGroups', listRuleGroupsResponse_nextToken - When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

$sel:ruleGroups:ListRuleGroupsResponse', listRuleGroupsResponse_ruleGroups - The rule group metadata objects that you've defined. Depending on your setting for max results and the number of rule groups, this might not be the full list.

$sel:httpStatus:ListRuleGroupsResponse', listRuleGroupsResponse_httpStatus - The response's http status code.

Response Lenses

listRuleGroupsResponse_nextToken :: Lens' ListRuleGroupsResponse (Maybe Text) Source #

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

listRuleGroupsResponse_ruleGroups :: Lens' ListRuleGroupsResponse (Maybe [RuleGroupMetadata]) Source #

The rule group metadata objects that you've defined. Depending on your setting for max results and the number of rule groups, this might not be the full list.