Class: Aws::GuardDuty::Types::GetFindingsStatisticsRequest

Inherits:

Struct

• Object
• Struct
• Aws::GuardDuty::Types::GetFindingsStatisticsRequest

Defined in:

gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #detector_id ⇒ String

  The ID of the detector whose findings statistics you want to retrieve.

• #finding_criteria ⇒ Types::FindingCriteria

  Represents the criteria that is used for querying findings.

• #finding_statistic_types ⇒ Array<String>

  The types of finding statistics to retrieve.

• #group_by ⇒ String

  Displays the findings statistics grouped by one of the listed valid values.

• #max_results ⇒ Integer

  The maximum number of results to be returned in the response.

• #order_by ⇒ String

  Displays the sorted findings in the requested order.

Instance Attribute Details

#detector_id ⇒ String

The ID of the detector whose findings statistics you want to retrieve.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

Returns:

• (String)

# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 4307

class GetFindingsStatisticsRequest < Struct.new(
  :detector_id,
  :finding_statistic_types,
  :finding_criteria,
  :group_by,
  :order_by,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#finding_criteria ⇒ Types::FindingCriteria

Represents the criteria that is used for querying findings.

Returns:

• (Types::FindingCriteria)

# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 4307

class GetFindingsStatisticsRequest < Struct.new(
  :detector_id,
  :finding_statistic_types,
  :finding_criteria,
  :group_by,
  :order_by,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#finding_statistic_types ⇒ Array<String>

The types of finding statistics to retrieve.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 4307

class GetFindingsStatisticsRequest < Struct.new(
  :detector_id,
  :finding_statistic_types,
  :finding_criteria,
  :group_by,
  :order_by,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#group_by ⇒ String

Displays the findings statistics grouped by one of the listed valid values.

Returns:

• (String)

# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 4307

class GetFindingsStatisticsRequest < Struct.new(
  :detector_id,
  :finding_statistic_types,
  :finding_criteria,
  :group_by,
  :order_by,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to be returned in the response. The default value is 25.

You can use this parameter only with the groupBy parameter.

Returns:

• (Integer)

# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 4307

class GetFindingsStatisticsRequest < Struct.new(
  :detector_id,
  :finding_statistic_types,
  :finding_criteria,
  :group_by,
  :order_by,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#order_by ⇒ String

Displays the sorted findings in the requested order. The default value of orderBy is DESC.

You can use this parameter only with the groupBy parameter.

Returns:

• (String)

# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 4307

class GetFindingsStatisticsRequest < Struct.new(
  :detector_id,
  :finding_statistic_types,
  :finding_criteria,
  :group_by,
  :order_by,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end