Class: Aws::AuditManager::Types::CreateAssessmentReportRequest

Inherits:

Struct

• Object
• Struct
• Aws::AuditManager::Types::CreateAssessmentReportRequest

Includes:

Structure

Defined in:

lib/aws-sdk-auditmanager/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:description]

Instance Attribute Summary

• #assessment_id ⇒ String

  The identifier for the assessment.

• #description ⇒ String

  The description of the assessment report.

• #name ⇒ String

  The name of the new assessment report.

• #query_statement ⇒ String

  A SQL statement that represents an evidence finder query.

Instance Attribute Details

#assessment_id ⇒ String

The identifier for the assessment.

Returns:

• (String)

# File 'lib/aws-sdk-auditmanager/types.rb', line 1648

class CreateAssessmentReportRequest < Struct.new(
  :name,
  :description,
  :assessment_id,
  :query_statement)
  SENSITIVE = [:description]
  include Aws::Structure
end

#description ⇒ String

The description of the assessment report.

Returns:

• (String)

# File 'lib/aws-sdk-auditmanager/types.rb', line 1648

class CreateAssessmentReportRequest < Struct.new(
  :name,
  :description,
  :assessment_id,
  :query_statement)
  SENSITIVE = [:description]
  include Aws::Structure
end

#name ⇒ String

The name of the new assessment report.

Returns:

• (String)

# File 'lib/aws-sdk-auditmanager/types.rb', line 1648

class CreateAssessmentReportRequest < Struct.new(
  :name,
  :description,
  :assessment_id,
  :query_statement)
  SENSITIVE = [:description]
  include Aws::Structure
end

#query_statement ⇒ String

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.*

[1]: docs.aws.amazon.com/audit-manager/latest/userguide/generate-assessment-report.html#generate-assessment-report-include-evidence [2]: docs.aws.amazon.com/audit-manager/latest/APIReference/API_BatchAssociateAssessmentReportEvidence.html [3]: docs.aws.amazon.com/audit-manager/latest/APIReference/API_EvidenceFinderEnablement.html#auditmanager-Type-EvidenceFinderEnablement-enablementStatus [4]: docs.aws.amazon.com/audit-manager/latest/userguide/evidence-finder-issues.html#querystatement-exceptions

Returns:

• (String)

# File 'lib/aws-sdk-auditmanager/types.rb', line 1648

class CreateAssessmentReportRequest < Struct.new(
  :name,
  :description,
  :assessment_id,
  :query_statement)
  SENSITIVE = [:description]
  include Aws::Structure
end