Get Findings Report Account Summary

codeguruprofiler_get_findings_report_account_summary

R Documentation

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

Description¶

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

Usage¶

codeguruprofiler_get_findings_report_account_summary(dailyReportsOnly,
  maxResults, nextToken)

Arguments¶

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).

maxResults

The maximum number of results returned by get_findings_report_account_summary in paginated output. When this parameter is used, get_findings_report_account_summary 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 get_findings_report_account_summary request with the returned nextToken value.

nextToken

The nextToken value returned from a previous paginated get_findings_report_account_summary 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.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Value¶

A list with the following syntax:

list(
  nextToken = "string",
  reportSummaries = list(
    list(
      id = "string",
      profileEndTime = as.POSIXct(
        "2015-01-01"
      ),
      profileStartTime = as.POSIXct(
        "2015-01-01"
      ),
      profilingGroupName = "string",
      totalNumberOfFindings = 123
    )
  )
)

Request syntax¶

svc$get_findings_report_account_summary(
  dailyReportsOnly = TRUE|FALSE,
  maxResults = 123,
  nextToken = "string"
)