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

Class: Aws::GuardDuty::Types::ListFindingsRequest

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

Overview

Note:

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

{
  detector_id: "__string", # required
  finding_criteria: {
    criterion: {
      "__string" => {
        eq: ["__string"],
        gt: 1,
        gte: 1,
        lt: 1,
        lte: 1,
        neq: ["__string"],
      },
    },
  },
  max_results: 1,
  next_token: "NextToken",
  sort_criteria: {
    attribute_name: "__string",
    order_by: "ASC", # accepts ASC, DESC
  },
}

List Findings Request

Instance Attribute Summary collapse

Instance Attribute Details

#detector_idString

Returns:

  • (String)


1555
1556
1557
1558
1559
1560
1561
1562
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 1555

class ListFindingsRequest < Struct.new(
  :detector_id,
  :finding_criteria,
  :max_results,
  :next_token,
  :sort_criteria)
  include Aws::Structure
end

#finding_criteriaTypes::FindingCriteria

Represents the criteria used for querying findings.



1555
1556
1557
1558
1559
1560
1561
1562
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 1555

class ListFindingsRequest < Struct.new(
  :detector_id,
  :finding_criteria,
  :max_results,
  :next_token,
  :sort_criteria)
  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 50. The maximum value is 50.

Returns:

  • (Integer)


1555
1556
1557
1558
1559
1560
1561
1562
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 1555

class ListFindingsRequest < Struct.new(
  :detector_id,
  :finding_criteria,
  :max_results,
  :next_token,
  :sort_criteria)
  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. For 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)


1555
1556
1557
1558
1559
1560
1561
1562
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 1555

class ListFindingsRequest < Struct.new(
  :detector_id,
  :finding_criteria,
  :max_results,
  :next_token,
  :sort_criteria)
  include Aws::Structure
end

#sort_criteriaTypes::SortCriteria

Represents the criteria used for sorting findings.

Returns:



1555
1556
1557
1558
1559
1560
1561
1562
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 1555

class ListFindingsRequest < Struct.new(
  :detector_id,
  :finding_criteria,
  :max_results,
  :next_token,
  :sort_criteria)
  include Aws::Structure
end