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(runId, scanName)

Arguments¶

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.

scanName

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

Value¶

A list with the following syntax:

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

Request syntax¶

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