Get Findings

codegurusecurity_get_findings

R Documentation

Returns a list of all findings generated by a particular scan

Description

Returns a list of all findings generated by a particular scan.

Usage

codegurusecurity_get_findings(maxResults, nextToken, scanName, status)

Arguments

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.

scanName

[required] The name of the scan you want to retrieve findings from.

status

The status of the findings you want to get. Pass either Open, Closed, or All.

Value

A list with the following syntax:

list(
  findings = list(
    list(
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      description = "string",
      detectorId = "string",
      detectorName = "string",
      detectorTags = list(
        "string"
      ),
      generatorId = "string",
      id = "string",
      remediation = list(
        recommendation = list(
          text = "string",
          url = "string"
        ),
        suggestedFixes = list(
          list(
            code = "string",
            description = "string"
          )
        )
      ),
      resource = list(
        id = "string",
        subResourceId = "string"
      ),
      ruleId = "string",
      severity = "Critical"|"High"|"Medium"|"Low"|"Info",
      status = "Closed"|"Open"|"All",
      title = "string",
      type = "string",
      updatedAt = as.POSIXct(
        "2015-01-01"
      ),
      vulnerability = list(
        filePath = list(
          codeSnippet = list(
            list(
              content = "string",
              number = 123
            )
          ),
          endLine = 123,
          name = "string",
          path = "string",
          startLine = 123
        ),
        id = "string",
        itemCount = 123,
        referenceUrls = list(
          "string"
        ),
        relatedVulnerabilities = list(
          "string"
        )
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$get_findings(
  maxResults = 123,
  nextToken = "string",
  scanName = "string",
  status = "Closed"|"Open"|"All"
)