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

Class: Aws::Inspector::Types::ListAssessmentRunsRequest

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 ListAssessmentRunsRequest data as a hash:

{
  assessment_template_arns: ["Arn"],
  filter: {
    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,
    },
  },
  next_token: "PaginationToken",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#assessment_template_arnsArray<String>

The ARNs that specify the assessment templates whose assessment runs you want to list.

Returns:

  • (Array<String>)


1572
1573
1574
1575
1576
1577
1578
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 1572

class ListAssessmentRunsRequest < Struct.new(
  :assessment_template_arns,
  :filter,
  :next_token,
  :max_results)
  include Aws::Structure
end

#filterTypes::AssessmentRunFilter

You can use this parameter to specify a subset of data to be included in the action's response.

For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.



1572
1573
1574
1575
1576
1577
1578
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 1572

class ListAssessmentRunsRequest < Struct.new(
  :assessment_template_arns,
  :filter,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_resultsInteger

You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 10. The maximum value is 500.

Returns:

  • (Integer)


1572
1573
1574
1575
1576
1577
1578
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 1572

class ListAssessmentRunsRequest < Struct.new(
  :assessment_template_arns,
  :filter,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_tokenString

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListAssessmentRuns action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

Returns:

  • (String)


1572
1573
1574
1575
1576
1577
1578
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 1572

class ListAssessmentRunsRequest < Struct.new(
  :assessment_template_arns,
  :filter,
  :next_token,
  :max_results)
  include Aws::Structure
end