Skip to content

List Findings Reports

codeguruprofiler_list_findings_reports R Documentation

List the available reports for a given profiling group and time range

Description

List the available reports for a given profiling group and time range.

Usage

codeguruprofiler_list_findings_reports(dailyReportsOnly, endTime,
  maxResults, nextToken, profilingGroupName, startTime)

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

endTime

[required] The end time of the profile to get analysis data about. You must specify startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

maxResults

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

nextToken

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

profilingGroupName

[required] The name of the profiling group from which to search for analysis data.

startTime

[required] The start time of the profile to get analysis data about. You must specify startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

Value

A list with the following syntax: 

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

Request syntax

svc$list_findings_reports(
  dailyReportsOnly = TRUE|FALSE,
  endTime = as.POSIXct(
    "2015-01-01"
  ),
  maxResults = 123,
  nextToken = "string",
  profilingGroupName = "string",
  startTime = as.POSIXct(
    "2015-01-01"
  )
)