Create Assessment Report

auditmanager_create_assessment_report

R Documentation

Creates an assessment report for the specified assessment¶

Description¶

Creates an assessment report for the specified assessment.

Usage¶

auditmanager_create_assessment_report(name, description, assessmentId,
  queryStatement)

Arguments¶

name

[required] The name of the new assessment report.

description

The description of the assessment report.

assessmentId

[required] The identifier for the assessment.

queryStatement

A SQL statement that represents an evidence finder query.

Provide this parameter when you want to generate an assessment report from the results of an evidence finder search query. When you use this parameter, Audit Manager generates a one-time report using only the evidence from the query output. This report does not include any assessment evidence that was manually added to a report using the console, or associated with a report using the API.

To use this parameter, the enablementStatus of evidence finder must be ENABLED.

For examples and help resolving queryStatement validation exceptions, see Troubleshooting evidence finder issues in the Audit Manager User Guide.

Value¶

A list with the following syntax:

list(
  assessmentReport = list(
    id = "string",
    name = "string",
    description = "string",
    awsAccountId = "string",
    assessmentId = "string",
    assessmentName = "string",
    author = "string",
    status = "COMPLETE"|"IN_PROGRESS"|"FAILED",
    creationTime = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax¶

svc$create_assessment_report(
  name = "string",
  description = "string",
  assessmentId = "string",
  queryStatement = "string"
)