Skip to content

Get Assessment Report

inspector_get_assessment_report R Documentation

Produces an assessment report that includes detailed and comprehensive results of a specified assessment run

Description

Produces an assessment report that includes detailed and comprehensive results of a specified assessment run.

Usage

inspector_get_assessment_report(assessmentRunArn, reportFileFormat,
  reportType)

Arguments

assessmentRunArn

[required] The ARN that specifies the assessment run for which you want to generate a report.

reportFileFormat

[required] Specifies the file format (html or pdf) of the assessment report that you want to generate.

reportType

[required] Specifies the type of the assessment report that you want to generate. There are two types of assessment reports: a finding report and a full report. For more information, see Assessment Reports.

Value

A list with the following syntax:

list(
  status = "WORK_IN_PROGRESS"|"FAILED"|"COMPLETED",
  url = "string"
)

Request syntax

svc$get_assessment_report(
  assessmentRunArn = "string",
  reportFileFormat = "HTML"|"PDF",
  reportType = "FINDING"|"FULL"
)