List Findings Metrics

codegurusecurity_list_findings_metrics

R Documentation

Returns metrics about all findings in an account within a specified time range

Description

Returns metrics about all findings in an account within a specified time range.

Usage

codegurusecurity_list_findings_metrics(endDate, maxResults, nextToken,
  startDate)

Arguments

endDate

[required] The end date of the interval which you want to retrieve metrics from. Round to the nearest day.

maxResults

The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the nextToken element is returned in the response. Use nextToken in a subsequent request to retrieve additional results. If not specified, returns 1000 results.

nextToken

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

startDate

[required] The start date of the interval which you want to retrieve metrics from. Rounds to the nearest day.

Value

A list with the following syntax:

list(
  findingsMetrics = list(
    list(
      closedFindings = list(
        critical = 123.0,
        high = 123.0,
        info = 123.0,
        low = 123.0,
        medium = 123.0
      ),
      date = as.POSIXct(
        "2015-01-01"
      ),
      meanTimeToClose = list(
        critical = 123.0,
        high = 123.0,
        info = 123.0,
        low = 123.0,
        medium = 123.0
      ),
      newFindings = list(
        critical = 123.0,
        high = 123.0,
        info = 123.0,
        low = 123.0,
        medium = 123.0
      ),
      openFindings = list(
        critical = 123.0,
        high = 123.0,
        info = 123.0,
        low = 123.0,
        medium = 123.0
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_findings_metrics(
  endDate = as.POSIXct(
    "2015-01-01"
  ),
  maxResults = 123,
  nextToken = "string",
  startDate = as.POSIXct(
    "2015-01-01"
  )
)