Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Retrieves a subset of information about one or more findings.
This operation returns paginated results.
Synopsis
- data ListFindings = ListFindings' {}
- newListFindings :: ListFindings
- listFindings_findingCriteria :: Lens' ListFindings (Maybe FindingCriteria)
- listFindings_sortCriteria :: Lens' ListFindings (Maybe SortCriteria)
- listFindings_nextToken :: Lens' ListFindings (Maybe Text)
- listFindings_maxResults :: Lens' ListFindings (Maybe Int)
- data ListFindingsResponse = ListFindingsResponse' {
- findingIds :: Maybe [Text]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListFindingsResponse :: Int -> ListFindingsResponse
- listFindingsResponse_findingIds :: Lens' ListFindingsResponse (Maybe [Text])
- listFindingsResponse_nextToken :: Lens' ListFindingsResponse (Maybe Text)
- listFindingsResponse_httpStatus :: Lens' ListFindingsResponse Int
Creating a Request
data ListFindings Source #
See: newListFindings
smart constructor.
ListFindings' | |
|
Instances
newListFindings :: ListFindings Source #
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:
$sel:findingCriteria:ListFindings'
, listFindings_findingCriteria
- The criteria to use to filter the results.
$sel:sortCriteria:ListFindings'
, listFindings_sortCriteria
- The criteria to use to sort the results.
$sel:nextToken:ListFindings'
, listFindings_nextToken
- The nextToken string that specifies which page of results to return in a
paginated response.
$sel:maxResults:ListFindings'
, listFindings_maxResults
- The maximum number of items to include in each page of the response.
Request Lenses
listFindings_findingCriteria :: Lens' ListFindings (Maybe FindingCriteria) Source #
The criteria to use to filter the results.
listFindings_sortCriteria :: Lens' ListFindings (Maybe SortCriteria) Source #
The criteria to use to sort the results.
listFindings_nextToken :: Lens' ListFindings (Maybe Text) Source #
The nextToken string that specifies which page of results to return in a paginated response.
listFindings_maxResults :: Lens' ListFindings (Maybe Int) Source #
The maximum number of items to include in each page of the response.
Destructuring the Response
data ListFindingsResponse Source #
See: newListFindingsResponse
smart constructor.
ListFindingsResponse' | |
|
Instances
newListFindingsResponse Source #
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:
$sel:findingIds:ListFindingsResponse'
, listFindingsResponse_findingIds
- An array of strings, where each string is the unique identifier for a
finding that meets the filter criteria specified in the request.
$sel:nextToken:ListFindings'
, listFindingsResponse_nextToken
- The string to use in a subsequent request to get the next page of
results in a paginated response. This value is null if there are no
additional pages.
$sel:httpStatus:ListFindingsResponse'
, listFindingsResponse_httpStatus
- The response's http status code.
Response Lenses
listFindingsResponse_findingIds :: Lens' ListFindingsResponse (Maybe [Text]) Source #
An array of strings, where each string is the unique identifier for a finding that meets the filter criteria specified in the request.
listFindingsResponse_nextToken :: Lens' ListFindingsResponse (Maybe Text) Source #
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
listFindingsResponse_httpStatus :: Lens' ListFindingsResponse Int Source #
The response's http status code.