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.AccessAnalyzer.ListFindings

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a list of findings generated by the specified analyzer.

To learn about filter keys that you can use to retrieve a list of findings, see IAM Access Analyzer filter keys in the IAM User Guide.

This operation returns paginated results.

Synopsis

data ListFindings = ListFindings' {
- filter' :: Maybe (HashMap Text Criterion)
- maxResults :: Maybe Int
- nextToken :: Maybe Text
- sort :: Maybe SortCriteria
- analyzerArn :: Text
}
newListFindings :: Text -> ListFindings
listFindings_filter :: Lens' ListFindings (Maybe (HashMap Text Criterion))
listFindings_maxResults :: Lens' ListFindings (Maybe Int)
listFindings_nextToken :: Lens' ListFindings (Maybe Text)
listFindings_sort :: Lens' ListFindings (Maybe SortCriteria)
listFindings_analyzerArn :: Lens' ListFindings Text
data ListFindingsResponse = ListFindingsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- findings :: [FindingSummary]
}
newListFindingsResponse :: Int -> ListFindingsResponse
listFindingsResponse_nextToken :: Lens' ListFindingsResponse (Maybe Text)
listFindingsResponse_httpStatus :: Lens' ListFindingsResponse Int
listFindingsResponse_findings :: Lens' ListFindingsResponse [FindingSummary]

Creating a Request

data ListFindings Source #

Retrieves a list of findings generated by the specified analyzer.

See: newListFindings smart constructor.

Constructors

ListFindings'
Fields filter' :: Maybe (HashMap Text Criterion) A filter to match for the findings to return. maxResults :: Maybe Int The maximum number of results to return in the response. nextToken :: Maybe Text A token used for pagination of results returned. sort :: Maybe SortCriteria The sort order for the findings returned. analyzerArn :: Text The ARN of the analyzer to retrieve findings from.

Instances

Instances details

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

newListFindings Source #

Arguments

:: Text	`ListFindings`
-> ListFindings

Create a value of ListFindings 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:

ListFindings, listFindings_filter - A filter to match for the findings to return.

$sel:maxResults:ListFindings', listFindings_maxResults - The maximum number of results to return in the response.

ListFindings, listFindings_nextToken - A token used for pagination of results returned.

$sel:sort:ListFindings', listFindings_sort - The sort order for the findings returned.

ListFindings, listFindings_analyzerArn - The ARN of the analyzer to retrieve findings from.

Request Lenses

listFindings_filter :: Lens' ListFindings (Maybe (HashMap Text Criterion)) Source #

A filter to match for the findings to return.

listFindings_maxResults :: Lens' ListFindings (Maybe Int) Source #

The maximum number of results to return in the response.

listFindings_nextToken :: Lens' ListFindings (Maybe Text) Source #

A token used for pagination of results returned.

listFindings_sort :: Lens' ListFindings (Maybe SortCriteria) Source #

The sort order for the findings returned.

listFindings_analyzerArn :: Lens' ListFindings Text Source #

The ARN of the analyzer to retrieve findings from.

Destructuring the Response

data ListFindingsResponse Source #

The response to the request.

See: newListFindingsResponse smart constructor.

Constructors

ListFindingsResponse'
Fields nextToken :: Maybe Text A token used for pagination of results returned. httpStatus :: Int The response's http status code. findings :: [FindingSummary] A list of findings retrieved from the analyzer that match the filter criteria specified, if any.

Instances

Instances details

Generic ListFindingsResponse Source #
Instance details Defined in Amazonka.AccessAnalyzer.ListFindings Associated Types type Rep ListFindingsResponse :: Type -> Type # Methods from :: ListFindingsResponse -> Rep ListFindingsResponse x # to :: Rep ListFindingsResponse x -> ListFindingsResponse #
Read ListFindingsResponse Source #
Instance details Defined in Amazonka.AccessAnalyzer.ListFindings Methods readsPrec :: Int -> ReadS ListFindingsResponse # readList :: ReadS [ListFindingsResponse] # readPrec :: ReadPrec ListFindingsResponse # readListPrec :: ReadPrec [ListFindingsResponse] #
Show ListFindingsResponse Source #
Instance details Defined in Amazonka.AccessAnalyzer.ListFindings Methods showsPrec :: Int -> ListFindingsResponse -> ShowS # show :: ListFindingsResponse -> String # showList :: [ListFindingsResponse] -> ShowS #
NFData ListFindingsResponse Source #
Instance details Defined in Amazonka.AccessAnalyzer.ListFindings Methods rnf :: ListFindingsResponse -> () #
Eq ListFindingsResponse Source #
Instance details Defined in Amazonka.AccessAnalyzer.ListFindings Methods (==) :: ListFindingsResponse -> ListFindingsResponse -> Bool # (/=) :: ListFindingsResponse -> ListFindingsResponse -> Bool #
type Rep ListFindingsResponse Source #
Instance details Defined in Amazonka.AccessAnalyzer.ListFindings type Rep ListFindingsResponse = D1 ('MetaData "ListFindingsResponse" "Amazonka.AccessAnalyzer.ListFindings" "amazonka-accessanalyzer-2.0-A0JZirwj4a95MolJaaBere" 'False) (C1 ('MetaCons "ListFindingsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "findings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [FindingSummary]))))

newListFindingsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListFindingsResponse'`
-> ListFindingsResponse

Create a value of ListFindingsResponse 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:

ListFindings, listFindingsResponse_nextToken - A token used for pagination of results returned.

$sel:httpStatus:ListFindingsResponse', listFindingsResponse_httpStatus - The response's http status code.

$sel:findings:ListFindingsResponse', listFindingsResponse_findings - A list of findings retrieved from the analyzer that match the filter criteria specified, if any.

Response Lenses

listFindingsResponse_nextToken :: Lens' ListFindingsResponse (Maybe Text) Source #

A token used for pagination of results returned.

listFindingsResponse_httpStatus :: Lens' ListFindingsResponse Int Source #

The response's http status code.

listFindingsResponse_findings :: Lens' ListFindingsResponse [FindingSummary] Source #

A list of findings retrieved from the analyzer that match the filter criteria specified, if any.