| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
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
- data ListFirewalls = ListFirewalls' {}
- newListFirewalls :: ListFirewalls
- listFirewalls_maxResults :: Lens' ListFirewalls (Maybe Natural)
- listFirewalls_nextToken :: Lens' ListFirewalls (Maybe Text)
- listFirewalls_vpcIds :: Lens' ListFirewalls (Maybe [Text])
- data ListFirewallsResponse = ListFirewallsResponse' {
- firewalls :: Maybe [FirewallMetadata]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListFirewallsResponse :: Int -> ListFirewallsResponse
- listFirewallsResponse_firewalls :: Lens' ListFirewallsResponse (Maybe [FirewallMetadata])
- listFirewallsResponse_nextToken :: Lens' ListFirewallsResponse (Maybe Text)
- listFirewallsResponse_httpStatus :: Lens' ListFirewallsResponse Int
Creating a Request
data ListFirewalls Source #
See: newListFirewalls smart constructor.
Constructors
| ListFirewalls' | |
Fields
| |
Instances
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: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.
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.
Request Lenses
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.
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.
Destructuring the Response
data ListFirewallsResponse Source #
See: newListFirewallsResponse smart constructor.
Constructors
| ListFirewallsResponse' | |
Fields
| |
Instances
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: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.
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:httpStatus:ListFirewallsResponse', listFirewallsResponse_httpStatus - The response's http status code.
Response Lenses
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.
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_httpStatus :: Lens' ListFirewallsResponse Int Source #
The response's http status code.