| 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.FMS.ListPolicies
Description
Returns an array of PolicySummary objects.
This operation returns paginated results.
Synopsis
- data ListPolicies = ListPolicies' {}
- newListPolicies :: ListPolicies
- listPolicies_maxResults :: Lens' ListPolicies (Maybe Natural)
- listPolicies_nextToken :: Lens' ListPolicies (Maybe Text)
- data ListPoliciesResponse = ListPoliciesResponse' {
- nextToken :: Maybe Text
- policyList :: Maybe [PolicySummary]
- httpStatus :: Int
- newListPoliciesResponse :: Int -> ListPoliciesResponse
- listPoliciesResponse_nextToken :: Lens' ListPoliciesResponse (Maybe Text)
- listPoliciesResponse_policyList :: Lens' ListPoliciesResponse (Maybe [PolicySummary])
- listPoliciesResponse_httpStatus :: Lens' ListPoliciesResponse Int
Creating a Request
data ListPolicies Source #
See: newListPolicies smart constructor.
Constructors
| ListPolicies' | |
Fields
| |
Instances
newListPolicies :: ListPolicies Source #
Create a value of ListPolicies 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:ListPolicies', listPolicies_maxResults - Specifies the number of PolicySummary objects that you want Firewall
Manager to return for this request. If you have more PolicySummary
objects than the number that you specify for MaxResults, the response
includes a NextToken value that you can use to get another batch of
PolicySummary objects.
ListPolicies, listPolicies_nextToken - If you specify a value for MaxResults and you have more
PolicySummary objects than the number that you specify for
MaxResults, Firewall Manager returns a NextToken value in the
response that allows you to list another group of PolicySummary
objects. For the second and subsequent ListPolicies requests, specify
the value of NextToken from the previous response to get information
about another batch of PolicySummary objects.
Request Lenses
listPolicies_maxResults :: Lens' ListPolicies (Maybe Natural) Source #
Specifies the number of PolicySummary objects that you want Firewall
Manager to return for this request. If you have more PolicySummary
objects than the number that you specify for MaxResults, the response
includes a NextToken value that you can use to get another batch of
PolicySummary objects.
listPolicies_nextToken :: Lens' ListPolicies (Maybe Text) Source #
If you specify a value for MaxResults and you have more
PolicySummary objects than the number that you specify for
MaxResults, Firewall Manager returns a NextToken value in the
response that allows you to list another group of PolicySummary
objects. For the second and subsequent ListPolicies requests, specify
the value of NextToken from the previous response to get information
about another batch of PolicySummary objects.
Destructuring the Response
data ListPoliciesResponse Source #
See: newListPoliciesResponse smart constructor.
Constructors
| ListPoliciesResponse' | |
Fields
| |
Instances
newListPoliciesResponse Source #
Arguments
| :: Int | |
| -> ListPoliciesResponse |
Create a value of ListPoliciesResponse 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:
ListPolicies, listPoliciesResponse_nextToken - If you have more PolicySummary objects than the number that you
specified for MaxResults in the request, the response includes a
NextToken value. To list more PolicySummary objects, submit another
ListPolicies request, and specify the NextToken value from the
response in the NextToken value in the next request.
$sel:policyList:ListPoliciesResponse', listPoliciesResponse_policyList - An array of PolicySummary objects.
$sel:httpStatus:ListPoliciesResponse', listPoliciesResponse_httpStatus - The response's http status code.
Response Lenses
listPoliciesResponse_nextToken :: Lens' ListPoliciesResponse (Maybe Text) Source #
If you have more PolicySummary objects than the number that you
specified for MaxResults in the request, the response includes a
NextToken value. To list more PolicySummary objects, submit another
ListPolicies request, and specify the NextToken value from the
response in the NextToken value in the next request.
listPoliciesResponse_policyList :: Lens' ListPoliciesResponse (Maybe [PolicySummary]) Source #
An array of PolicySummary objects.
listPoliciesResponse_httpStatus :: Lens' ListPoliciesResponse Int Source #
The response's http status code.