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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:description]

Instance Attribute Summary collapse

Instance Attribute Details

#assessment_id ⇒ String

The identifier for the assessment.

Returns:

  • (String) 


1614
1615
1616
1617
1618
1619
1620
1621
 
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 1614

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) 


1614
1615
1616
1617
1618
1619
1620
1621
 
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 1614

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) 


1614
1615
1616
1617
1618
1619
1620
1621
 
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 1614

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.

Returns:

  • (String) 


1614
1615
1616
1617
1618
1619
1620
1621
 
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 1614

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