getFindingsReportAccountSummary method

Future<GetFindingsReportAccountSummaryResponse> getFindingsReportAccountSummary({ bool? dailyReportsOnly, int? maxResults, String? nextToken, })

Returns a list of FindingsReportSummary objects that contain analysis results for all profiling groups in your AWS account.

May throw InternalServerException. May throw ValidationException. May throw ThrottlingException.

Parameter dailyReportsOnly : A Boolean value indicating whether to only return reports from daily profiles. If set to True, only analysis data from daily profiles is returned. If set to False, analysis data is returned from smaller time windows (for example, one hour).

Parameter maxResults : The maximum number of results returned by GetFindingsReportAccountSummary in paginated output. When this parameter is used, GetFindingsReportAccountSummary only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another GetFindingsReportAccountSummary request with the returned nextToken value.

Parameter nextToken : The nextToken value returned from a previous paginated GetFindingsReportAccountSummary request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

Implementation

Future<GetFindingsReportAccountSummaryResponse>
    getFindingsReportAccountSummary({
  bool? dailyReportsOnly,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    1000,
  );
  _s.validateStringLength(
    'nextToken',
    nextToken,
    1,
    64,
  );
  final $query = <String, List<String>>{
    if (dailyReportsOnly != null)
      'dailyReportsOnly': [dailyReportsOnly.toString()],
    if (maxResults != null) 'maxResults': [maxResults.toString()],
    if (nextToken != null) 'nextToken': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/internal/findingsReports',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return GetFindingsReportAccountSummaryResponse.fromJson(response);
}