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 |
Lists aggregated finding data for your environment based on specific criteria.
This operation returns paginated results.
Synopsis
- data ListFindingAggregations = ListFindingAggregations' {}
- newListFindingAggregations :: AggregationType -> ListFindingAggregations
- listFindingAggregations_accountIds :: Lens' ListFindingAggregations (Maybe (NonEmpty StringFilter))
- listFindingAggregations_aggregationRequest :: Lens' ListFindingAggregations (Maybe AggregationRequest)
- listFindingAggregations_maxResults :: Lens' ListFindingAggregations (Maybe Natural)
- listFindingAggregations_nextToken :: Lens' ListFindingAggregations (Maybe Text)
- listFindingAggregations_aggregationType :: Lens' ListFindingAggregations AggregationType
- data ListFindingAggregationsResponse = ListFindingAggregationsResponse' {}
- newListFindingAggregationsResponse :: Int -> AggregationType -> ListFindingAggregationsResponse
- listFindingAggregationsResponse_nextToken :: Lens' ListFindingAggregationsResponse (Maybe Text)
- listFindingAggregationsResponse_responses :: Lens' ListFindingAggregationsResponse (Maybe [AggregationResponse])
- listFindingAggregationsResponse_httpStatus :: Lens' ListFindingAggregationsResponse Int
- listFindingAggregationsResponse_aggregationType :: Lens' ListFindingAggregationsResponse AggregationType
Creating a Request
data ListFindingAggregations Source #
See: newListFindingAggregations
smart constructor.
ListFindingAggregations' | |
|
Instances
newListFindingAggregations Source #
Create a value of ListFindingAggregations
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:accountIds:ListFindingAggregations'
, listFindingAggregations_accountIds
- The Amazon Web Services account IDs to retrieve finding aggregation data
for.
$sel:aggregationRequest:ListFindingAggregations'
, listFindingAggregations_aggregationRequest
- Details of the aggregation request that is used to filter your
aggregation results.
$sel:maxResults:ListFindingAggregations'
, listFindingAggregations_maxResults
- The maximum number of results to return in the response.
ListFindingAggregations
, listFindingAggregations_nextToken
- A token to use for paginating results that are returned in the response.
Set the value of this parameter to null for the first request to a list
action. For subsequent calls, use the NextToken
value returned from
the previous request to continue listing results after the first page.
ListFindingAggregations
, listFindingAggregations_aggregationType
- The type of the aggregation request.
Request Lenses
listFindingAggregations_accountIds :: Lens' ListFindingAggregations (Maybe (NonEmpty StringFilter)) Source #
The Amazon Web Services account IDs to retrieve finding aggregation data for.
listFindingAggregations_aggregationRequest :: Lens' ListFindingAggregations (Maybe AggregationRequest) Source #
Details of the aggregation request that is used to filter your aggregation results.
listFindingAggregations_maxResults :: Lens' ListFindingAggregations (Maybe Natural) Source #
The maximum number of results to return in the response.
listFindingAggregations_nextToken :: Lens' ListFindingAggregations (Maybe Text) Source #
A token to use for paginating results that are returned in the response.
Set the value of this parameter to null for the first request to a list
action. For subsequent calls, use the NextToken
value returned from
the previous request to continue listing results after the first page.
listFindingAggregations_aggregationType :: Lens' ListFindingAggregations AggregationType Source #
The type of the aggregation request.
Destructuring the Response
data ListFindingAggregationsResponse Source #
See: newListFindingAggregationsResponse
smart constructor.
ListFindingAggregationsResponse' | |
|
Instances
newListFindingAggregationsResponse Source #
Create a value of ListFindingAggregationsResponse
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:
ListFindingAggregations
, listFindingAggregationsResponse_nextToken
- A token to use for paginating results that are returned in the response.
Set the value of this parameter to null for the first request to a list
action. For subsequent calls, use the NextToken
value returned from
the previous request to continue listing results after the first page.
$sel:responses:ListFindingAggregationsResponse'
, listFindingAggregationsResponse_responses
- Objects that contain the results of an aggregation operation.
$sel:httpStatus:ListFindingAggregationsResponse'
, listFindingAggregationsResponse_httpStatus
- The response's http status code.
ListFindingAggregations
, listFindingAggregationsResponse_aggregationType
- The type of aggregation to perform.
Response Lenses
listFindingAggregationsResponse_nextToken :: Lens' ListFindingAggregationsResponse (Maybe Text) Source #
A token to use for paginating results that are returned in the response.
Set the value of this parameter to null for the first request to a list
action. For subsequent calls, use the NextToken
value returned from
the previous request to continue listing results after the first page.
listFindingAggregationsResponse_responses :: Lens' ListFindingAggregationsResponse (Maybe [AggregationResponse]) Source #
Objects that contain the results of an aggregation operation.
listFindingAggregationsResponse_httpStatus :: Lens' ListFindingAggregationsResponse Int Source #
The response's http status code.
listFindingAggregationsResponse_aggregationType :: Lens' ListFindingAggregationsResponse AggregationType Source #
The type of aggregation to perform.