You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Inspector::Types::AssessmentRun

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

Overview

A snapshot of an Amazon Inspector assessment run that contains the findings of the assessment run .

Used as the response element in the DescribeAssessmentRuns action.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The ARN of the assessment run.

Returns:

  • (String) 


281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 281

class AssessmentRun < Struct.new(
  :arn,
  :name,
  :assessment_template_arn,
  :state,
  :duration_in_seconds,
  :rules_package_arns,
  :user_attributes_for_findings,
  :created_at,
  :started_at,
  :completed_at,
  :state_changed_at,
  :data_collected,
  :state_changes,
  :notifications,
  :finding_counts)
  include Aws::Structure
end

#assessment_template_arn ⇒ String

The ARN of the assessment template that is associated with the assessment run.

Returns:

  • (String) 


281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 281

class AssessmentRun < Struct.new(
  :arn,
  :name,
  :assessment_template_arn,
  :state,
  :duration_in_seconds,
  :rules_package_arns,
  :user_attributes_for_findings,
  :created_at,
  :started_at,
  :completed_at,
  :state_changed_at,
  :data_collected,
  :state_changes,
  :notifications,
  :finding_counts)
  include Aws::Structure
end

#completed_at ⇒ Time

The assessment run completion time that corresponds to the rules packages evaluation completion time or failure.

Returns:

  • (Time) 


281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 281

class AssessmentRun < Struct.new(
  :arn,
  :name,
  :assessment_template_arn,
  :state,
  :duration_in_seconds,
  :rules_package_arns,
  :user_attributes_for_findings,
  :created_at,
  :started_at,
  :completed_at,
  :state_changed_at,
  :data_collected,
  :state_changes,
  :notifications,
  :finding_counts)
  include Aws::Structure
end

#created_at ⇒ Time

The time when StartAssessmentRun was called.

Returns:

  • (Time) 


281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 281

class AssessmentRun < Struct.new(
  :arn,
  :name,
  :assessment_template_arn,
  :state,
  :duration_in_seconds,
  :rules_package_arns,
  :user_attributes_for_findings,
  :created_at,
  :started_at,
  :completed_at,
  :state_changed_at,
  :data_collected,
  :state_changes,
  :notifications,
  :finding_counts)
  include Aws::Structure
end

#data_collected ⇒ Boolean

A Boolean value (true or false) that specifies whether the process of collecting data from the agents is completed.

Returns:

  • (Boolean) 


281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 281

class AssessmentRun < Struct.new(
  :arn,
  :name,
  :assessment_template_arn,
  :state,
  :duration_in_seconds,
  :rules_package_arns,
  :user_attributes_for_findings,
  :created_at,
  :started_at,
  :completed_at,
  :state_changed_at,
  :data_collected,
  :state_changes,
  :notifications,
  :finding_counts)
  include Aws::Structure
end

#duration_in_seconds ⇒ Integer

The duration of the assessment run.

Returns:

  • (Integer) 


281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 281

class AssessmentRun < Struct.new(
  :arn,
  :name,
  :assessment_template_arn,
  :state,
  :duration_in_seconds,
  :rules_package_arns,
  :user_attributes_for_findings,
  :created_at,
  :started_at,
  :completed_at,
  :state_changed_at,
  :data_collected,
  :state_changes,
  :notifications,
  :finding_counts)
  include Aws::Structure
end

#finding_counts ⇒ Hash<String,Integer>

Provides a total count of generated findings per severity.

Returns:

  • (Hash<String,Integer>) 


281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 281

class AssessmentRun < Struct.new(
  :arn,
  :name,
  :assessment_template_arn,
  :state,
  :duration_in_seconds,
  :rules_package_arns,
  :user_attributes_for_findings,
  :created_at,
  :started_at,
  :completed_at,
  :state_changed_at,
  :data_collected,
  :state_changes,
  :notifications,
  :finding_counts)
  include Aws::Structure
end

#name ⇒ String

The auto-generated name for the assessment run.

Returns:

  • (String) 


281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 281

class AssessmentRun < Struct.new(
  :arn,
  :name,
  :assessment_template_arn,
  :state,
  :duration_in_seconds,
  :rules_package_arns,
  :user_attributes_for_findings,
  :created_at,
  :started_at,
  :completed_at,
  :state_changed_at,
  :data_collected,
  :state_changes,
  :notifications,
  :finding_counts)
  include Aws::Structure
end

#notifications ⇒ Array<Types::AssessmentRunNotification>

A list of notifications for the event subscriptions. A notification about a particular generated finding is added to this list only once.

Returns:



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 281

class AssessmentRun < Struct.new(
  :arn,
  :name,
  :assessment_template_arn,
  :state,
  :duration_in_seconds,
  :rules_package_arns,
  :user_attributes_for_findings,
  :created_at,
  :started_at,
  :completed_at,
  :state_changed_at,
  :data_collected,
  :state_changes,
  :notifications,
  :finding_counts)
  include Aws::Structure
end

#rules_package_arns ⇒ Array<String>

The rules packages selected for the assessment run.

Returns:

  • (Array<String>) 


281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 281

class AssessmentRun < Struct.new(
  :arn,
  :name,
  :assessment_template_arn,
  :state,
  :duration_in_seconds,
  :rules_package_arns,
  :user_attributes_for_findings,
  :created_at,
  :started_at,
  :completed_at,
  :state_changed_at,
  :data_collected,
  :state_changes,
  :notifications,
  :finding_counts)
  include Aws::Structure
end

#started_at ⇒ Time

The time when StartAssessmentRun was called.

Returns:

  • (Time) 


281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 281

class AssessmentRun < Struct.new(
  :arn,
  :name,
  :assessment_template_arn,
  :state,
  :duration_in_seconds,
  :rules_package_arns,
  :user_attributes_for_findings,
  :created_at,
  :started_at,
  :completed_at,
  :state_changed_at,
  :data_collected,
  :state_changes,
  :notifications,
  :finding_counts)
  include Aws::Structure
end

#state ⇒ String

The state of the assessment run.

Returns:

  • (String) 


281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 281

class AssessmentRun < Struct.new(
  :arn,
  :name,
  :assessment_template_arn,
  :state,
  :duration_in_seconds,
  :rules_package_arns,
  :user_attributes_for_findings,
  :created_at,
  :started_at,
  :completed_at,
  :state_changed_at,
  :data_collected,
  :state_changes,
  :notifications,
  :finding_counts)
  include Aws::Structure
end

#state_changed_at ⇒ Time

The last time when the assessment run's state changed.

Returns:

  • (Time) 


281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 281

class AssessmentRun < Struct.new(
  :arn,
  :name,
  :assessment_template_arn,
  :state,
  :duration_in_seconds,
  :rules_package_arns,
  :user_attributes_for_findings,
  :created_at,
  :started_at,
  :completed_at,
  :state_changed_at,
  :data_collected,
  :state_changes,
  :notifications,
  :finding_counts)
  include Aws::Structure
end

#state_changes ⇒ Array<Types::AssessmentRunStateChange>

A list of the assessment run state changes.

Returns:



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 281

class AssessmentRun < Struct.new(
  :arn,
  :name,
  :assessment_template_arn,
  :state,
  :duration_in_seconds,
  :rules_package_arns,
  :user_attributes_for_findings,
  :created_at,
  :started_at,
  :completed_at,
  :state_changed_at,
  :data_collected,
  :state_changes,
  :notifications,
  :finding_counts)
  include Aws::Structure
end

#user_attributes_for_findings ⇒ Array<Types::Attribute>

The user-defined attributes that are assigned to every generated finding.

Returns:



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 281

class AssessmentRun < Struct.new(
  :arn,
  :name,
  :assessment_template_arn,
  :state,
  :duration_in_seconds,
  :rules_package_arns,
  :user_attributes_for_findings,
  :created_at,
  :started_at,
  :completed_at,
  :state_changed_at,
  :data_collected,
  :state_changes,
  :notifications,
  :finding_counts)
  include Aws::Structure
end