Class: Aws::SecurityHub::Types::FindingsOutput

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

Overview

The configuration for a findings export: the output format, an optional set of filters, and the fields to include.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filters ⇒ Types::OcsfFindingFilters

An optional set of OCSF finding filters that restrict which findings are exported. The filter structure is the same as the one used by GetFindingsV2. If you omit this member, Security Hub exports all findings available to the caller. When echoed by GetExportJobV2, relative date ranges are returned unresolved.

Returns:



25981
25982
25983
25984
25985
25986
25987
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 25981

class FindingsOutput < Struct.new(
  :format,
  :filters,
  :selected_fields)
  SENSITIVE = []
  include Aws::Structure
end

#format ⇒ String

The output format of the export. CSV produces comma-separated rows that are suitable for spreadsheets and analysis tools. OCSF_JSON produces newline-delimited JSON records in the Open Cybersecurity Schema Framework (OCSF) format used elsewhere in Security Hub.

Returns:

  • (String) 


25981
25982
25983
25984
25985
25986
25987
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 25981

class FindingsOutput < Struct.new(
  :format,
  :filters,
  :selected_fields)
  SENSITIVE = []
  include Aws::Structure
end

#selected_fields ⇒ Array<String>

The OCSF finding fields to include in the export, specified as OCSF field paths (for example, finding_info.title or severity). You can specify from 1 to 50 fields.

Whether this parameter is required depends on the value of Format:

  • CSV – Required. The field paths that you specify become the columns of the output, in the order that you provide them. If you omit this parameter, the request returns a ValidationException.

  • OCSF_JSON – Not supported. This format includes each finding in full, so field selection doesn't apply. If you specify this parameter, the request returns a ValidationException.

Returns:

  • (Array<String>) 


25981
25982
25983
25984
25985
25986
25987
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 25981

class FindingsOutput < Struct.new(
  :format,
  :filters,
  :selected_fields)
  SENSITIVE = []
  include Aws::Structure
end