| 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.ListComplianceStatus
Description
Returns an array of PolicyComplianceStatus objects. Use
PolicyComplianceStatus to get a summary of which member accounts are
protected by the specified policy.
This operation returns paginated results.
Synopsis
- data ListComplianceStatus = ListComplianceStatus' {}
- newListComplianceStatus :: Text -> ListComplianceStatus
- listComplianceStatus_maxResults :: Lens' ListComplianceStatus (Maybe Natural)
- listComplianceStatus_nextToken :: Lens' ListComplianceStatus (Maybe Text)
- listComplianceStatus_policyId :: Lens' ListComplianceStatus Text
- data ListComplianceStatusResponse = ListComplianceStatusResponse' {}
- newListComplianceStatusResponse :: Int -> ListComplianceStatusResponse
- listComplianceStatusResponse_nextToken :: Lens' ListComplianceStatusResponse (Maybe Text)
- listComplianceStatusResponse_policyComplianceStatusList :: Lens' ListComplianceStatusResponse (Maybe [PolicyComplianceStatus])
- listComplianceStatusResponse_httpStatus :: Lens' ListComplianceStatusResponse Int
Creating a Request
data ListComplianceStatus Source #
See: newListComplianceStatus smart constructor.
Constructors
| ListComplianceStatus' | |
Fields
| |
Instances
newListComplianceStatus Source #
Arguments
| :: Text | |
| -> ListComplianceStatus |
Create a value of ListComplianceStatus 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:ListComplianceStatus', listComplianceStatus_maxResults - Specifies the number of PolicyComplianceStatus objects that you want
Firewall Manager to return for this request. If you have more
PolicyComplianceStatus objects than the number that you specify for
MaxResults, the response includes a NextToken value that you can use
to get another batch of PolicyComplianceStatus objects.
ListComplianceStatus, listComplianceStatus_nextToken - If you specify a value for MaxResults and you have more
PolicyComplianceStatus 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
PolicyComplianceStatus objects. For the second and subsequent
ListComplianceStatus requests, specify the value of NextToken from
the previous response to get information about another batch of
PolicyComplianceStatus objects.
ListComplianceStatus, listComplianceStatus_policyId - The ID of the Firewall Manager policy that you want the details for.
Request Lenses
listComplianceStatus_maxResults :: Lens' ListComplianceStatus (Maybe Natural) Source #
Specifies the number of PolicyComplianceStatus objects that you want
Firewall Manager to return for this request. If you have more
PolicyComplianceStatus objects than the number that you specify for
MaxResults, the response includes a NextToken value that you can use
to get another batch of PolicyComplianceStatus objects.
listComplianceStatus_nextToken :: Lens' ListComplianceStatus (Maybe Text) Source #
If you specify a value for MaxResults and you have more
PolicyComplianceStatus 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
PolicyComplianceStatus objects. For the second and subsequent
ListComplianceStatus requests, specify the value of NextToken from
the previous response to get information about another batch of
PolicyComplianceStatus objects.
listComplianceStatus_policyId :: Lens' ListComplianceStatus Text Source #
The ID of the Firewall Manager policy that you want the details for.
Destructuring the Response
data ListComplianceStatusResponse Source #
See: newListComplianceStatusResponse smart constructor.
Constructors
| ListComplianceStatusResponse' | |
Fields
| |
Instances
newListComplianceStatusResponse Source #
Create a value of ListComplianceStatusResponse 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:
ListComplianceStatus, listComplianceStatusResponse_nextToken - If you have more PolicyComplianceStatus objects than the number that
you specified for MaxResults in the request, the response includes a
NextToken value. To list more PolicyComplianceStatus objects, submit
another ListComplianceStatus request, and specify the NextToken
value from the response in the NextToken value in the next request.
$sel:policyComplianceStatusList:ListComplianceStatusResponse', listComplianceStatusResponse_policyComplianceStatusList - An array of PolicyComplianceStatus objects.
$sel:httpStatus:ListComplianceStatusResponse', listComplianceStatusResponse_httpStatus - The response's http status code.
Response Lenses
listComplianceStatusResponse_nextToken :: Lens' ListComplianceStatusResponse (Maybe Text) Source #
If you have more PolicyComplianceStatus objects than the number that
you specified for MaxResults in the request, the response includes a
NextToken value. To list more PolicyComplianceStatus objects, submit
another ListComplianceStatus request, and specify the NextToken
value from the response in the NextToken value in the next request.
listComplianceStatusResponse_policyComplianceStatusList :: Lens' ListComplianceStatusResponse (Maybe [PolicyComplianceStatus]) Source #
An array of PolicyComplianceStatus objects.
listComplianceStatusResponse_httpStatus :: Lens' ListComplianceStatusResponse Int Source #
The response's http status code.