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

Description

Retrieves the metadata for the firewalls that you have defined. If you provide VPC identifiers in your request, this returns only the firewalls for those VPCs.

Depending on your setting for max results and the number of firewalls, a single call might not return the full list.

This operation returns paginated results.

Synopsis

Creating a Request

data ListFirewalls Source #

See: newListFirewalls smart constructor.

Constructors

ListFirewalls' 

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.

  • vpcIds :: Maybe [Text]

    The unique identifiers of the VPCs that you want Network Firewall to retrieve the firewalls for. Leave this blank to retrieve all firewalls that you have defined.

  • 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 ListFirewalls Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewalls

Read ListFirewalls Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewalls

Show ListFirewalls Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewalls

Generic ListFirewalls Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewalls

Associated Types

type Rep ListFirewalls :: Type -> Type #

NFData ListFirewalls Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewalls

Methods

rnf :: ListFirewalls -> () #

Hashable ListFirewalls Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewalls

ToJSON ListFirewalls Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewalls

AWSPager ListFirewalls Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewalls

AWSRequest ListFirewalls Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewalls

Associated Types

type AWSResponse ListFirewalls #

ToHeaders ListFirewalls Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewalls

ToPath ListFirewalls Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewalls

ToQuery ListFirewalls Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewalls

type Rep ListFirewalls Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewalls

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

Defined in Amazonka.NetworkFirewall.ListFirewalls

newListFirewalls :: ListFirewalls Source #

Create a value of ListFirewalls 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:ListFirewalls', listFirewalls_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:vpcIds:ListFirewalls', listFirewalls_vpcIds - The unique identifiers of the VPCs that you want Network Firewall to retrieve the firewalls for. Leave this blank to retrieve all firewalls that you have defined.

$sel:maxResults:ListFirewalls', listFirewalls_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

listFirewalls_nextToken :: Lens' ListFirewalls (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.

listFirewalls_vpcIds :: Lens' ListFirewalls (Maybe [Text]) Source #

The unique identifiers of the VPCs that you want Network Firewall to retrieve the firewalls for. Leave this blank to retrieve all firewalls that you have defined.

listFirewalls_maxResults :: Lens' ListFirewalls (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 ListFirewallsResponse Source #

See: newListFirewallsResponse smart constructor.

Constructors

ListFirewallsResponse' 

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.

  • firewalls :: Maybe [FirewallMetadata]

    The firewall metadata objects for the VPCs that you specified. Depending on your setting for max results and the number of firewalls you have, a single call might not be the full list.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListFirewallsResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewalls

Read ListFirewallsResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewalls

Show ListFirewallsResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewalls

Generic ListFirewallsResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewalls

Associated Types

type Rep ListFirewallsResponse :: Type -> Type #

NFData ListFirewallsResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewalls

Methods

rnf :: ListFirewallsResponse -> () #

type Rep ListFirewallsResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.ListFirewalls

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

newListFirewallsResponse Source #

Create a value of ListFirewallsResponse 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:ListFirewalls', listFirewallsResponse_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:firewalls:ListFirewallsResponse', listFirewallsResponse_firewalls - The firewall metadata objects for the VPCs that you specified. Depending on your setting for max results and the number of firewalls you have, a single call might not be the full list.

$sel:httpStatus:ListFirewallsResponse', listFirewallsResponse_httpStatus - The response's http status code.

Response Lenses

listFirewallsResponse_nextToken :: Lens' ListFirewallsResponse (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.

listFirewallsResponse_firewalls :: Lens' ListFirewallsResponse (Maybe [FirewallMetadata]) Source #

The firewall metadata objects for the VPCs that you specified. Depending on your setting for max results and the number of firewalls you have, a single call might not be the full list.