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.

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The ARN of the assessment run.

Returns:

  • (String)


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 197

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_arnString

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

Returns:

  • (String)


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 197

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_atTime

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

Returns:

  • (Time)


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 197

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_atTime

The time when StartAssessmentRun was called.

Returns:

  • (Time)


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 197

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_collectedBoolean

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

Returns:

  • (Boolean)


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 197

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_secondsInteger

The duration of the assessment run.

Returns:

  • (Integer)


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 197

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_countsHash<String,Integer>

Provides a total count of generated findings per severity.

Returns:

  • (Hash<String,Integer>)


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 197

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

#nameString

The auto-generated name for the assessment run.

Returns:

  • (String)


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 197

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

#notificationsArray<Types::AssessmentRunNotification>

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



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 197

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_arnsArray<String>

The rules packages selected for the assessment run.

Returns:

  • (Array<String>)


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 197

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_atTime

The time when StartAssessmentRun was called.

Returns:

  • (Time)


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 197

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

#stateString

The state of the assessment run.

Returns:

  • (String)


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 197

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_atTime

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

Returns:

  • (Time)


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 197

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_changesArray<Types::AssessmentRunStateChange>

A list of the assessment run state changes.



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 197

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_findingsArray<Types::Attribute>

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

Returns:



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 197

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