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.Inspector2.ListFindingAggregations

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists aggregated finding data for your environment based on specific criteria.

This operation returns paginated results.

Synopsis

Creating a Request

data ListFindingAggregations Source #

See: newListFindingAggregations smart constructor.

Constructors

ListFindingAggregations'

Fields

accountIds :: Maybe (NonEmpty StringFilter)
The Amazon Web Services account IDs to retrieve finding aggregation data for.
aggregationRequest :: Maybe AggregationRequest
Details of the aggregation request that is used to filter your aggregation results.
maxResults :: Maybe Natural
The maximum number of results to return in the response.
nextToken :: Maybe Text
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.
aggregationType :: AggregationType
The type of the aggregation request.

Instances

Instances details

ToJSON ListFindingAggregations Source #
Instance details Defined in Amazonka.Inspector2.ListFindingAggregations Methods toJSON :: ListFindingAggregations -> Value # toEncoding :: ListFindingAggregations -> Encoding # toJSONList :: [ListFindingAggregations] -> Value # toEncodingList :: [ListFindingAggregations] -> Encoding #
ToHeaders ListFindingAggregations Source #
Instance details Defined in Amazonka.Inspector2.ListFindingAggregations Methods toHeaders :: ListFindingAggregations -> [Header] #
ToPath ListFindingAggregations Source #
Instance details Defined in Amazonka.Inspector2.ListFindingAggregations Methods toPath :: ListFindingAggregations -> ByteString #
ToQuery ListFindingAggregations Source #
Instance details Defined in Amazonka.Inspector2.ListFindingAggregations Methods toQuery :: ListFindingAggregations -> QueryString #
AWSPager ListFindingAggregations Source #
Instance details Defined in Amazonka.Inspector2.ListFindingAggregations Methods page :: ListFindingAggregations -> AWSResponse ListFindingAggregations -> Maybe ListFindingAggregations #
AWSRequest ListFindingAggregations Source #
Instance details Defined in Amazonka.Inspector2.ListFindingAggregations Associated Types type AWSResponse ListFindingAggregations # Methods request :: (Service -> Service) -> ListFindingAggregations -> Request ListFindingAggregations # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListFindingAggregations -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListFindingAggregations))) #
Generic ListFindingAggregations Source #
Instance details Defined in Amazonka.Inspector2.ListFindingAggregations Associated Types type Rep ListFindingAggregations :: Type -> Type # Methods from :: ListFindingAggregations -> Rep ListFindingAggregations x # to :: Rep ListFindingAggregations x -> ListFindingAggregations #
Read ListFindingAggregations Source #
Instance details Defined in Amazonka.Inspector2.ListFindingAggregations Methods readsPrec :: Int -> ReadS ListFindingAggregations # readList :: ReadS [ListFindingAggregations] # readPrec :: ReadPrec ListFindingAggregations # readListPrec :: ReadPrec [ListFindingAggregations] #
Show ListFindingAggregations Source #
Instance details Defined in Amazonka.Inspector2.ListFindingAggregations Methods showsPrec :: Int -> ListFindingAggregations -> ShowS # show :: ListFindingAggregations -> String # showList :: [ListFindingAggregations] -> ShowS #
NFData ListFindingAggregations Source #
Instance details Defined in Amazonka.Inspector2.ListFindingAggregations Methods rnf :: ListFindingAggregations -> () #
Eq ListFindingAggregations Source #
Instance details Defined in Amazonka.Inspector2.ListFindingAggregations Methods (==) :: ListFindingAggregations -> ListFindingAggregations -> Bool # (/=) :: ListFindingAggregations -> ListFindingAggregations -> Bool #
Hashable ListFindingAggregations Source #
Instance details Defined in Amazonka.Inspector2.ListFindingAggregations Methods hashWithSalt :: Int -> ListFindingAggregations -> Int # hash :: ListFindingAggregations -> Int #
type AWSResponse ListFindingAggregations Source #
Instance details Defined in Amazonka.Inspector2.ListFindingAggregations type AWSResponse ListFindingAggregations = ListFindingAggregationsResponse
type Rep ListFindingAggregations Source #
Instance details Defined in Amazonka.Inspector2.ListFindingAggregations type Rep ListFindingAggregations = D1 ('MetaData "ListFindingAggregations" "Amazonka.Inspector2.ListFindingAggregations" "amazonka-inspector2-2.0-EI0CfxGdACSBWwvVde8cFy" 'False) (C1 ('MetaCons "ListFindingAggregations'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accountIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty StringFilter))) :: S1 ('MetaSel ('Just "aggregationRequest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AggregationRequest))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "aggregationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AggregationType)))))

newListFindingAggregations Source #

Arguments

:: AggregationType	`ListFindingAggregations`
-> ListFindingAggregations

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.

Constructors

ListFindingAggregationsResponse'

Fields

nextToken :: Maybe Text
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.
responses :: Maybe [AggregationResponse]
Objects that contain the results of an aggregation operation.
httpStatus :: Int
The response's http status code.
aggregationType :: AggregationType
The type of aggregation to perform.

Instances

Instances details

Generic ListFindingAggregationsResponse Source #
Instance details Defined in Amazonka.Inspector2.ListFindingAggregations Associated Types type Rep ListFindingAggregationsResponse :: Type -> Type # Methods from :: ListFindingAggregationsResponse -> Rep ListFindingAggregationsResponse x # to :: Rep ListFindingAggregationsResponse x -> ListFindingAggregationsResponse #
Read ListFindingAggregationsResponse Source #
Instance details Defined in Amazonka.Inspector2.ListFindingAggregations Methods readsPrec :: Int -> ReadS ListFindingAggregationsResponse # readList :: ReadS [ListFindingAggregationsResponse] # readPrec :: ReadPrec ListFindingAggregationsResponse # readListPrec :: ReadPrec [ListFindingAggregationsResponse] #
Show ListFindingAggregationsResponse Source #
Instance details Defined in Amazonka.Inspector2.ListFindingAggregations Methods showsPrec :: Int -> ListFindingAggregationsResponse -> ShowS # show :: ListFindingAggregationsResponse -> String # showList :: [ListFindingAggregationsResponse] -> ShowS #
NFData ListFindingAggregationsResponse Source #
Instance details Defined in Amazonka.Inspector2.ListFindingAggregations Methods rnf :: ListFindingAggregationsResponse -> () #
Eq ListFindingAggregationsResponse Source #
Instance details Defined in Amazonka.Inspector2.ListFindingAggregations Methods (==) :: ListFindingAggregationsResponse -> ListFindingAggregationsResponse -> Bool # (/=) :: ListFindingAggregationsResponse -> ListFindingAggregationsResponse -> Bool #
type Rep ListFindingAggregationsResponse Source #
Instance details Defined in Amazonka.Inspector2.ListFindingAggregations type Rep ListFindingAggregationsResponse = D1 ('MetaData "ListFindingAggregationsResponse" "Amazonka.Inspector2.ListFindingAggregations" "amazonka-inspector2-2.0-EI0CfxGdACSBWwvVde8cFy" 'False) (C1 ('MetaCons "ListFindingAggregationsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "responses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AggregationResponse]))) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "aggregationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AggregationType))))

newListFindingAggregationsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListFindingAggregationsResponse'`
-> AggregationType	`ListFindingAggregations`
-> ListFindingAggregationsResponse

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.