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

Class: Aws::Inspector::Types::AssessmentRunFilter

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

Overview

Note:

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

{
  name_pattern: "NamePattern",
  states: ["CREATED"], # accepts CREATED, START_DATA_COLLECTION_PENDING, START_DATA_COLLECTION_IN_PROGRESS, COLLECTING_DATA, STOP_DATA_COLLECTION_PENDING, DATA_COLLECTED, START_EVALUATING_RULES_PENDING, EVALUATING_RULES, FAILED, ERROR, COMPLETED, COMPLETED_WITH_ERRORS, CANCELED
  duration_range: {
    min_seconds: 1,
    max_seconds: 1,
  },
  rules_package_arns: ["Arn"],
  start_time_range: {
    begin_date: Time.now,
    end_date: Time.now,
  },
  completion_time_range: {
    begin_date: Time.now,
    end_date: Time.now,
  },
  state_change_time_range: {
    begin_date: Time.now,
    end_date: Time.now,
  },
}

Used as the request parameter in the ListAssessmentRuns action.

Instance Attribute Summary collapse

Instance Attribute Details

#completion_time_rangeTypes::TimestampRange

For a record to match a filter, the value that is specified for this data type property must inclusively match any value between the specified minimum and maximum values of the completedAt property of the AssessmentRun data type.



337
338
339
340
341
342
343
344
345
346
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 337

class AssessmentRunFilter < Struct.new(
  :name_pattern,
  :states,
  :duration_range,
  :rules_package_arns,
  :start_time_range,
  :completion_time_range,
  :state_change_time_range)
  include Aws::Structure
end

#duration_rangeTypes::DurationRange

For a record to match a filter, the value that is specified for this data type property must inclusively match any value between the specified minimum and maximum values of the durationInSeconds property of the AssessmentRun data type.



337
338
339
340
341
342
343
344
345
346
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 337

class AssessmentRunFilter < Struct.new(
  :name_pattern,
  :states,
  :duration_range,
  :rules_package_arns,
  :start_time_range,
  :completion_time_range,
  :state_change_time_range)
  include Aws::Structure
end

#name_patternString

For a record to match a filter, an explicit value or a string containing a wildcard that is specified for this data type property must match the value of the assessmentRunName property of the AssessmentRun data type.

Returns:

  • (String)


337
338
339
340
341
342
343
344
345
346
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 337

class AssessmentRunFilter < Struct.new(
  :name_pattern,
  :states,
  :duration_range,
  :rules_package_arns,
  :start_time_range,
  :completion_time_range,
  :state_change_time_range)
  include Aws::Structure
end

#rules_package_arnsArray<String>

For a record to match a filter, the value that is specified for this data type property must be contained in the list of values of the rulesPackages property of the AssessmentRun data type.

Returns:

  • (Array<String>)


337
338
339
340
341
342
343
344
345
346
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 337

class AssessmentRunFilter < Struct.new(
  :name_pattern,
  :states,
  :duration_range,
  :rules_package_arns,
  :start_time_range,
  :completion_time_range,
  :state_change_time_range)
  include Aws::Structure
end

#start_time_rangeTypes::TimestampRange

For a record to match a filter, the value that is specified for this data type property must inclusively match any value between the specified minimum and maximum values of the startTime property of the AssessmentRun data type.



337
338
339
340
341
342
343
344
345
346
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 337

class AssessmentRunFilter < Struct.new(
  :name_pattern,
  :states,
  :duration_range,
  :rules_package_arns,
  :start_time_range,
  :completion_time_range,
  :state_change_time_range)
  include Aws::Structure
end

#state_change_time_rangeTypes::TimestampRange

For a record to match a filter, the value that is specified for this data type property must match the stateChangedAt property of the AssessmentRun data type.



337
338
339
340
341
342
343
344
345
346
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 337

class AssessmentRunFilter < Struct.new(
  :name_pattern,
  :states,
  :duration_range,
  :rules_package_arns,
  :start_time_range,
  :completion_time_range,
  :state_change_time_range)
  include Aws::Structure
end

#statesArray<String>

For a record to match a filter, one of the values specified for this data type property must be the exact match of the value of the assessmentRunState property of the AssessmentRun data type.

Returns:

  • (Array<String>)


337
338
339
340
341
342
343
344
345
346
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 337

class AssessmentRunFilter < Struct.new(
  :name_pattern,
  :states,
  :duration_range,
  :rules_package_arns,
  :start_time_range,
  :completion_time_range,
  :state_change_time_range)
  include Aws::Structure
end