amazonka-network-firewall-2.0: Amazon Network Firewall 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.NetworkFirewall.ListFirewallPolicies

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

data ListFirewallPolicies Source #

See: newListFirewallPolicies smart constructor.

Constructors

ListFirewallPolicies' 

Fields

  • 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.

  • 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.

Instances

Instances details
ToJSON ListFirewallPolicies Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewallPolicies

ToHeaders ListFirewallPolicies Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewallPolicies

ToPath ListFirewallPolicies Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewallPolicies

ToQuery ListFirewallPolicies Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewallPolicies

AWSPager ListFirewallPolicies Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewallPolicies

AWSRequest ListFirewallPolicies Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewallPolicies

Associated Types

type AWSResponse ListFirewallPolicies #

Generic ListFirewallPolicies Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewallPolicies

Associated Types

type Rep ListFirewallPolicies :: Type -> Type #

Read ListFirewallPolicies Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewallPolicies

Show ListFirewallPolicies Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewallPolicies

NFData ListFirewallPolicies Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewallPolicies

Methods

rnf :: ListFirewallPolicies -> () #

Eq ListFirewallPolicies Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewallPolicies

Hashable ListFirewallPolicies Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewallPolicies

type AWSResponse ListFirewallPolicies Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewallPolicies

type Rep ListFirewallPolicies Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewallPolicies

type Rep ListFirewallPolicies = D1 ('MetaData "ListFirewallPolicies" "Amazonka.NetworkFirewall.ListFirewallPolicies" "amazonka-network-firewall-2.0-4y6HybZBSNcEwGPO5AYVfm" 'False) (C1 ('MetaCons "ListFirewallPolicies'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListFirewallPolicies :: ListFirewallPolicies Source #

Create a value of ListFirewallPolicies 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:maxResults:ListFirewallPolicies', listFirewallPolicies_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.

ListFirewallPolicies, listFirewallPolicies_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.

Request Lenses

listFirewallPolicies_maxResults :: Lens' ListFirewallPolicies (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.

listFirewallPolicies_nextToken :: Lens' ListFirewallPolicies (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.

Destructuring the Response

data ListFirewallPoliciesResponse Source #

See: newListFirewallPoliciesResponse smart constructor.

Constructors

ListFirewallPoliciesResponse' 

Fields

  • firewallPolicies :: Maybe [FirewallPolicyMetadata]

    The metadata for the firewall policies. Depending on your setting for max results and the number of firewall policies that you have, this might not be the full list.

  • 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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListFirewallPoliciesResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewallPolicies

Associated Types

type Rep ListFirewallPoliciesResponse :: Type -> Type #

Read ListFirewallPoliciesResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewallPolicies

Show ListFirewallPoliciesResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewallPolicies

NFData ListFirewallPoliciesResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewallPolicies

Eq ListFirewallPoliciesResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewallPolicies

type Rep ListFirewallPoliciesResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewallPolicies

type Rep ListFirewallPoliciesResponse = D1 ('MetaData "ListFirewallPoliciesResponse" "Amazonka.NetworkFirewall.ListFirewallPolicies" "amazonka-network-firewall-2.0-4y6HybZBSNcEwGPO5AYVfm" 'False) (C1 ('MetaCons "ListFirewallPoliciesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "firewallPolicies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FirewallPolicyMetadata])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListFirewallPoliciesResponse Source #

Create a value of ListFirewallPoliciesResponse 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:firewallPolicies:ListFirewallPoliciesResponse', listFirewallPoliciesResponse_firewallPolicies - The metadata for the firewall policies. Depending on your setting for max results and the number of firewall policies that you have, this might not be the full list.

ListFirewallPolicies, listFirewallPoliciesResponse_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:httpStatus:ListFirewallPoliciesResponse', listFirewallPoliciesResponse_httpStatus - The response's http status code.

Response Lenses

listFirewallPoliciesResponse_firewallPolicies :: Lens' ListFirewallPoliciesResponse (Maybe [FirewallPolicyMetadata]) Source #

The metadata for the firewall policies. Depending on your setting for max results and the number of firewall policies that you have, this might not be the full list.

listFirewallPoliciesResponse_nextToken :: Lens' ListFirewallPoliciesResponse (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.