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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-auditmanager/types.rb

Overview

Note:

When making an API call, you may pass CreateAssessmentReportRequest data as a hash:

{
  name: "AssessmentReportName", # required
  description: "AssessmentReportDescription",
  assessment_id: "UUID", # required
  query_statement: "QueryStatement",
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#assessment_id ⇒ String

The identifier for the assessment.

Returns:

  • (String) 


1748
1749
1750
1751
1752
1753
1754
1755
 
# File 'lib/aws-sdk-auditmanager/types.rb', line 1748

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

#description ⇒ String

The description of the assessment report.

Returns:

  • (String) 


1748
1749
1750
1751
1752
1753
1754
1755
 
# File 'lib/aws-sdk-auditmanager/types.rb', line 1748

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

#name ⇒ String

The name of the new assessment report.

Returns:

  • (String) 


1748
1749
1750
1751
1752
1753
1754
1755
 
# File 'lib/aws-sdk-auditmanager/types.rb', line 1748

class CreateAssessmentReportRequest < Struct.new(
  :name,
  :description,
  :assessment_id,
  :query_statement)
  SENSITIVE = []
  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 AWS Audit Manager User Guide.

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

Returns:

  • (String) 


1748
1749
1750
1751
1752
1753
1754
1755
 
# File 'lib/aws-sdk-auditmanager/types.rb', line 1748

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