Get Scan

codegurusecurity_get_scan

R Documentation

Returns details about a scan, including whether or not a scan has completed¶

Description¶

Returns details about a scan, including whether or not a scan has completed.

Usage¶

codegurusecurity_get_scan(scanName, runId)

Arguments¶

scanName

[required] The name of the scan you want to view details about.

runId

UUID that identifies the individual scan run you want to view details about. You retrieve this when you call the create_scan operation. Defaults to the latest scan run if missing.

Value¶

A list with the following syntax:

list(
  scanName = "string",
  runId = "string",
  scanState = "InProgress"|"Successful"|"Failed",
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  analysisType = "Security"|"All",
  updatedAt = as.POSIXct(
    "2015-01-01"
  ),
  numberOfRevisions = 123,
  scanNameArn = "string",
  errorMessage = "string"
)

Request syntax¶

svc$get_scan(
  scanName = "string",
  runId = "string"
)