Class: Aws::SecurityHub::Types::GetFindingsRequest

Inherits:

Struct

• Object
• Struct
• Aws::SecurityHub::Types::GetFindingsRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-securityhub/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #filters ⇒ Types::AwsSecurityFindingFilters

  The finding attributes used to define a condition to filter the returned findings.

• #max_results ⇒ Integer

  The maximum number of findings to return.

• #next_token ⇒ String

  The token that is required for pagination.

• #sort_criteria ⇒ Array<Types::SortCriterion>

  The finding attributes used to sort the list of returned findings.

Instance Attribute Details

#filters ⇒ Types::AwsSecurityFindingFilters

The finding attributes used to define a condition to filter the returned findings.

You can filter by up to 10 finding attributes. For each attribute, you can provide up to 20 filter values.

Note that in the available filter fields, ‘WorkflowState` is deprecated. To search for a finding based on its workflow status, use `WorkflowStatus`.

Returns:

• (Types::AwsSecurityFindingFilters)

# File 'lib/aws-sdk-securityhub/types.rb', line 25631

class GetFindingsRequest < Struct.new(
  :filters,
  :sort_criteria,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of findings to return.

Returns:

• (Integer)

# File 'lib/aws-sdk-securityhub/types.rb', line 25631

class GetFindingsRequest < Struct.new(
  :filters,
  :sort_criteria,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token that is required for pagination. On your first call to the ‘GetFindings` operation, set the value of this parameter to `NULL`.

For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

Returns:

• (String)

# File 'lib/aws-sdk-securityhub/types.rb', line 25631

class GetFindingsRequest < Struct.new(
  :filters,
  :sort_criteria,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#sort_criteria ⇒ Array<Types::SortCriterion>

The finding attributes used to sort the list of returned findings.

Returns:

• (Array<Types::SortCriterion>)

# File 'lib/aws-sdk-securityhub/types.rb', line 25631

class GetFindingsRequest < Struct.new(
  :filters,
  :sort_criteria,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end