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

Class: Aws::Inspector::Types::ListFindingsRequest

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

{
  assessment_run_arns: ["Arn"],
  filter: {
    agent_ids: ["AgentId"],
    auto_scaling_groups: ["AutoScalingGroup"],
    rule_names: ["RuleName"],
    severities: ["Low"], # accepts Low, Medium, High, Informational, Undefined
    rules_package_arns: ["Arn"],
    attributes: [
      {
        key: "AttributeKey", # required
        value: "AttributeValue",
      },
    ],
    user_attributes: [
      {
        key: "AttributeKey", # required
        value: "AttributeValue",
      },
    ],
    creation_time_range: {
      begin_date: Time.now,
      end_date: Time.now,
    },
  },
  next_token: "PaginationToken",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#assessment_run_arnsArray<String>

The ARNs of the assessment runs that generate the findings that you want to list.

Returns:

  • (Array<String>)


1860
1861
1862
1863
1864
1865
1866
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 1860

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

#filterTypes::FindingFilter

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.



1860
1861
1862
1863
1864
1865
1866
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 1860

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

#max_resultsInteger

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

Returns:

  • (Integer)


1860
1861
1862
1863
1864
1865
1866
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 1860

class ListFindingsRequest < Struct.new(
  :assessment_run_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 ListFindings 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)


1860
1861
1862
1863
1864
1865
1866
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 1860

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