| 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 |
Amazonka.SecurityHub.GetFindings
Description
Returns a list of findings that match the specified criteria.
If finding aggregation is enabled, then when you call GetFindings from
the aggregation Region, the results include all of the matching findings
from both the aggregation Region and the linked Regions.
This operation returns paginated results.
Synopsis
- data GetFindings = GetFindings' {}
- newGetFindings :: GetFindings
- getFindings_filters :: Lens' GetFindings (Maybe AwsSecurityFindingFilters)
- getFindings_sortCriteria :: Lens' GetFindings (Maybe [SortCriterion])
- getFindings_nextToken :: Lens' GetFindings (Maybe Text)
- getFindings_maxResults :: Lens' GetFindings (Maybe Natural)
- data GetFindingsResponse = GetFindingsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- findings :: [AwsSecurityFinding]
- newGetFindingsResponse :: Int -> GetFindingsResponse
- getFindingsResponse_nextToken :: Lens' GetFindingsResponse (Maybe Text)
- getFindingsResponse_httpStatus :: Lens' GetFindingsResponse Int
- getFindingsResponse_findings :: Lens' GetFindingsResponse [AwsSecurityFinding]
Creating a Request
data GetFindings Source #
See: newGetFindings smart constructor.
Constructors
| GetFindings' | |
Fields
| |
Instances
newGetFindings :: GetFindings Source #
Create a value of GetFindings 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:filters:GetFindings', getFindings_filters - The finding attributes used to define a condition to filter the returned
findings.
You can filter by up to 10 finding attributes. For each attribute, you can provide up to 20 filter values.
Note that in the available filter fields, WorkflowState is deprecated.
To search for a finding based on its workflow status, use
WorkflowStatus.
$sel:sortCriteria:GetFindings', getFindings_sortCriteria - The finding attributes used to sort the list of returned findings.
$sel:nextToken:GetFindings', getFindings_nextToken - The token that is required for pagination. On your first call to the
GetFindings operation, set the value of this parameter to NULL.
For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
$sel:maxResults:GetFindings', getFindings_maxResults - The maximum number of findings to return.
Request Lenses
getFindings_filters :: Lens' GetFindings (Maybe AwsSecurityFindingFilters) Source #
The finding attributes used to define a condition to filter the returned findings.
You can filter by up to 10 finding attributes. For each attribute, you can provide up to 20 filter values.
Note that in the available filter fields, WorkflowState is deprecated.
To search for a finding based on its workflow status, use
WorkflowStatus.
getFindings_sortCriteria :: Lens' GetFindings (Maybe [SortCriterion]) Source #
The finding attributes used to sort the list of returned findings.
getFindings_nextToken :: Lens' GetFindings (Maybe Text) Source #
The token that is required for pagination. On your first call to the
GetFindings operation, set the value of this parameter to NULL.
For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
getFindings_maxResults :: Lens' GetFindings (Maybe Natural) Source #
The maximum number of findings to return.
Destructuring the Response
data GetFindingsResponse Source #
See: newGetFindingsResponse smart constructor.
Constructors
| GetFindingsResponse' | |
Fields
| |
Instances
newGetFindingsResponse Source #
Arguments
| :: Int | |
| -> GetFindingsResponse |
Create a value of GetFindingsResponse 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:nextToken:GetFindings', getFindingsResponse_nextToken - The pagination token to use to request the next page of results.
$sel:httpStatus:GetFindingsResponse', getFindingsResponse_httpStatus - The response's http status code.
$sel:findings:GetFindingsResponse', getFindingsResponse_findings - The findings that matched the filters specified in the request.
Response Lenses
getFindingsResponse_nextToken :: Lens' GetFindingsResponse (Maybe Text) Source #
The pagination token to use to request the next page of results.
getFindingsResponse_httpStatus :: Lens' GetFindingsResponse Int Source #
The response's http status code.
getFindingsResponse_findings :: Lens' GetFindingsResponse [AwsSecurityFinding] Source #
The findings that matched the filters specified in the request.