Class: Aws::Continuum::Types::FindingSummary

Inherits:

Struct

• Object
• Struct
• Aws::Continuum::Types::FindingSummary

Defined in:

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

Overview

A summary of a finding returned in list responses. Shares FindingLifecycleFields with the read operations so the list and get projections cannot drift. Carries a lean content subset -- fetch the finding for its full contents.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #category ⇒ String

  The producer's vulnerability category.

• #completed_at ⇒ Time

  When processing finished, whether by creating an issue or discarding.

• #created_at ⇒ Time

  The timestamp when the finding was ingested.

• #created_issue_id ⇒ String

  The issue Continuum created from this finding.

• #discard_reason ⇒ String

  Why the finding was not escalated.

• #discard_reasoning ⇒ String

  Customer-facing explanation accompanying discardReason.

• #duplicate_of_issue_id ⇒ String

  The existing issue this finding duplicates.

• #environment_id ⇒ String

  The environment that owns the finding.

• #file_path ⇒ String

  The file the finding is about, when it has a code location.

• #finding_arn ⇒ String

  The ARN of the finding.

• #finding_id ⇒ String

  The unique identifier of the finding.

• #reported_at ⇒ Time

  When the producer reported the finding -- its own clock, which is not Continuum's ingestion time.

• #scan_run_id ⇒ String

  The scan that produced the finding, when it came from one.

• #severity ⇒ String

  The finding's severity.

• #source ⇒ String

  The system that produced the finding.

• #source_finding_id ⇒ String

  The producer's own identifier for the finding.

• #status ⇒ String

  The current lifecycle status of the finding.

• #status_message ⇒ String

  Human-readable context about the current status.

• #status_updated_at ⇒ Time

  The timestamp when the status last transitioned.

• #title ⇒ String

  The producer's title for the finding.

• #type ⇒ String

  What kind of finding this is.

Instance Attribute Details

#category ⇒ String

The producer's vulnerability category.

Returns:

• (String)

# File 'gems/aws-sdk-continuum/lib/aws-sdk-continuum/types.rb', line 1286

class FindingSummary < Struct.new(
  :finding_id,
  :finding_arn,
  :environment_id,
  :source,
  :source_finding_id,
  :reported_at,
  :status,
  :status_updated_at,
  :created_at,
  :scan_run_id,
  :status_message,
  :discard_reason,
  :discard_reasoning,
  :duplicate_of_issue_id,
  :created_issue_id,
  :completed_at,
  :type,
  :title,
  :severity,
  :category,
  :file_path)
  SENSITIVE = []
  include Aws::Structure
end

#completed_at ⇒ Time

When processing finished, whether by creating an issue or discarding. Absent while the finding is still in flight.

Returns:

• (Time)

# File 'gems/aws-sdk-continuum/lib/aws-sdk-continuum/types.rb', line 1286

class FindingSummary < Struct.new(
  :finding_id,
  :finding_arn,
  :environment_id,
  :source,
  :source_finding_id,
  :reported_at,
  :status,
  :status_updated_at,
  :created_at,
  :scan_run_id,
  :status_message,
  :discard_reason,
  :discard_reasoning,
  :duplicate_of_issue_id,
  :created_issue_id,
  :completed_at,
  :type,
  :title,
  :severity,
  :category,
  :file_path)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The timestamp when the finding was ingested.

Returns:

• (Time)

# File 'gems/aws-sdk-continuum/lib/aws-sdk-continuum/types.rb', line 1286

class FindingSummary < Struct.new(
  :finding_id,
  :finding_arn,
  :environment_id,
  :source,
  :source_finding_id,
  :reported_at,
  :status,
  :status_updated_at,
  :created_at,
  :scan_run_id,
  :status_message,
  :discard_reason,
  :discard_reasoning,
  :duplicate_of_issue_id,
  :created_issue_id,
  :completed_at,
  :type,
  :title,
  :severity,
  :category,
  :file_path)
  SENSITIVE = []
  include Aws::Structure
end

#created_issue_id ⇒ String

The issue Continuum created from this finding.

Returns:

• (String)

# File 'gems/aws-sdk-continuum/lib/aws-sdk-continuum/types.rb', line 1286

class FindingSummary < Struct.new(
  :finding_id,
  :finding_arn,
  :environment_id,
  :source,
  :source_finding_id,
  :reported_at,
  :status,
  :status_updated_at,
  :created_at,
  :scan_run_id,
  :status_message,
  :discard_reason,
  :discard_reasoning,
  :duplicate_of_issue_id,
  :created_issue_id,
  :completed_at,
  :type,
  :title,
  :severity,
  :category,
  :file_path)
  SENSITIVE = []
  include Aws::Structure
end

#discard_reason ⇒ String

Why the finding was not escalated. Present only when status is DISCARDED.

Returns:

• (String)

# File 'gems/aws-sdk-continuum/lib/aws-sdk-continuum/types.rb', line 1286

class FindingSummary < Struct.new(
  :finding_id,
  :finding_arn,
  :environment_id,
  :source,
  :source_finding_id,
  :reported_at,
  :status,
  :status_updated_at,
  :created_at,
  :scan_run_id,
  :status_message,
  :discard_reason,
  :discard_reasoning,
  :duplicate_of_issue_id,
  :created_issue_id,
  :completed_at,
  :type,
  :title,
  :severity,
  :category,
  :file_path)
  SENSITIVE = []
  include Aws::Structure
end

#discard_reasoning ⇒ String

Customer-facing explanation accompanying discardReason.

Returns:

• (String)

# File 'gems/aws-sdk-continuum/lib/aws-sdk-continuum/types.rb', line 1286

class FindingSummary < Struct.new(
  :finding_id,
  :finding_arn,
  :environment_id,
  :source,
  :source_finding_id,
  :reported_at,
  :status,
  :status_updated_at,
  :created_at,
  :scan_run_id,
  :status_message,
  :discard_reason,
  :discard_reasoning,
  :duplicate_of_issue_id,
  :created_issue_id,
  :completed_at,
  :type,
  :title,
  :severity,
  :category,
  :file_path)
  SENSITIVE = []
  include Aws::Structure
end

#duplicate_of_issue_id ⇒ String

The existing issue this finding duplicates. Present only for the DUPLICATE_OF_* discard reasons.

Returns:

• (String)

# File 'gems/aws-sdk-continuum/lib/aws-sdk-continuum/types.rb', line 1286

class FindingSummary < Struct.new(
  :finding_id,
  :finding_arn,
  :environment_id,
  :source,
  :source_finding_id,
  :reported_at,
  :status,
  :status_updated_at,
  :created_at,
  :scan_run_id,
  :status_message,
  :discard_reason,
  :discard_reasoning,
  :duplicate_of_issue_id,
  :created_issue_id,
  :completed_at,
  :type,
  :title,
  :severity,
  :category,
  :file_path)
  SENSITIVE = []
  include Aws::Structure
end

#environment_id ⇒ String

The environment that owns the finding.

Returns:

• (String)

# File 'gems/aws-sdk-continuum/lib/aws-sdk-continuum/types.rb', line 1286

class FindingSummary < Struct.new(
  :finding_id,
  :finding_arn,
  :environment_id,
  :source,
  :source_finding_id,
  :reported_at,
  :status,
  :status_updated_at,
  :created_at,
  :scan_run_id,
  :status_message,
  :discard_reason,
  :discard_reasoning,
  :duplicate_of_issue_id,
  :created_issue_id,
  :completed_at,
  :type,
  :title,
  :severity,
  :category,
  :file_path)
  SENSITIVE = []
  include Aws::Structure
end

#file_path ⇒ String

The file the finding is about, when it has a code location.

Returns:

• (String)

# File 'gems/aws-sdk-continuum/lib/aws-sdk-continuum/types.rb', line 1286

class FindingSummary < Struct.new(
  :finding_id,
  :finding_arn,
  :environment_id,
  :source,
  :source_finding_id,
  :reported_at,
  :status,
  :status_updated_at,
  :created_at,
  :scan_run_id,
  :status_message,
  :discard_reason,
  :discard_reasoning,
  :duplicate_of_issue_id,
  :created_issue_id,
  :completed_at,
  :type,
  :title,
  :severity,
  :category,
  :file_path)
  SENSITIVE = []
  include Aws::Structure
end

#finding_arn ⇒ String

The ARN of the finding.

Returns:

• (String)

# File 'gems/aws-sdk-continuum/lib/aws-sdk-continuum/types.rb', line 1286

class FindingSummary < Struct.new(
  :finding_id,
  :finding_arn,
  :environment_id,
  :source,
  :source_finding_id,
  :reported_at,
  :status,
  :status_updated_at,
  :created_at,
  :scan_run_id,
  :status_message,
  :discard_reason,
  :discard_reasoning,
  :duplicate_of_issue_id,
  :created_issue_id,
  :completed_at,
  :type,
  :title,
  :severity,
  :category,
  :file_path)
  SENSITIVE = []
  include Aws::Structure
end

#finding_id ⇒ String

The unique identifier of the finding.

Returns:

• (String)

# File 'gems/aws-sdk-continuum/lib/aws-sdk-continuum/types.rb', line 1286

class FindingSummary < Struct.new(
  :finding_id,
  :finding_arn,
  :environment_id,
  :source,
  :source_finding_id,
  :reported_at,
  :status,
  :status_updated_at,
  :created_at,
  :scan_run_id,
  :status_message,
  :discard_reason,
  :discard_reasoning,
  :duplicate_of_issue_id,
  :created_issue_id,
  :completed_at,
  :type,
  :title,
  :severity,
  :category,
  :file_path)
  SENSITIVE = []
  include Aws::Structure
end

#reported_at ⇒ Time

When the producer reported the finding -- its own clock, which is not Continuum's ingestion time. createdAt is when Continuum accepted it; these are genuinely different instants and a reader usually wants this one.

For CreateCodeFinding, this is the submitted OCSF document's own top-level time. For findings Continuum's scanner produces, it is the finding's own creation time.

Continuum does not validate it for plausibility: a producer's value is echoed as given, so a timestamp here asserts the unit and format, not that the instant is genuine.

Returns:

• (Time)

# File 'gems/aws-sdk-continuum/lib/aws-sdk-continuum/types.rb', line 1286

class FindingSummary < Struct.new(
  :finding_id,
  :finding_arn,
  :environment_id,
  :source,
  :source_finding_id,
  :reported_at,
  :status,
  :status_updated_at,
  :created_at,
  :scan_run_id,
  :status_message,
  :discard_reason,
  :discard_reasoning,
  :duplicate_of_issue_id,
  :created_issue_id,
  :completed_at,
  :type,
  :title,
  :severity,
  :category,
  :file_path)
  SENSITIVE = []
  include Aws::Structure
end

#scan_run_id ⇒ String

The scan that produced the finding, when it came from one. For a finding Continuum's scanner produced, this is the Continuum scan run (see GetCodeScan). For a finding submitted with CreateCodeFinding, it is the OCSF document's metadata.correlation_uid, when that value is a valid ScanRunId. Absent when the finding did not come from a scan.

Returns:

• (String)

# File 'gems/aws-sdk-continuum/lib/aws-sdk-continuum/types.rb', line 1286

class FindingSummary < Struct.new(
  :finding_id,
  :finding_arn,
  :environment_id,
  :source,
  :source_finding_id,
  :reported_at,
  :status,
  :status_updated_at,
  :created_at,
  :scan_run_id,
  :status_message,
  :discard_reason,
  :discard_reasoning,
  :duplicate_of_issue_id,
  :created_issue_id,
  :completed_at,
  :type,
  :title,
  :severity,
  :category,
  :file_path)
  SENSITIVE = []
  include Aws::Structure
end

#severity ⇒ String

The finding's severity.

Returns:

• (String)

# File 'gems/aws-sdk-continuum/lib/aws-sdk-continuum/types.rb', line 1286

class FindingSummary < Struct.new(
  :finding_id,
  :finding_arn,
  :environment_id,
  :source,
  :source_finding_id,
  :reported_at,
  :status,
  :status_updated_at,
  :created_at,
  :scan_run_id,
  :status_message,
  :discard_reason,
  :discard_reasoning,
  :duplicate_of_issue_id,
  :created_issue_id,
  :completed_at,
  :type,
  :title,
  :severity,
  :category,
  :file_path)
  SENSITIVE = []
  include Aws::Structure
end

#source ⇒ String

The system that produced the finding.

Returns:

• (String)

# File 'gems/aws-sdk-continuum/lib/aws-sdk-continuum/types.rb', line 1286

class FindingSummary < Struct.new(
  :finding_id,
  :finding_arn,
  :environment_id,
  :source,
  :source_finding_id,
  :reported_at,
  :status,
  :status_updated_at,
  :created_at,
  :scan_run_id,
  :status_message,
  :discard_reason,
  :discard_reasoning,
  :duplicate_of_issue_id,
  :created_issue_id,
  :completed_at,
  :type,
  :title,
  :severity,
  :category,
  :file_path)
  SENSITIVE = []
  include Aws::Structure
end

#source_finding_id ⇒ String

The producer's own identifier for the finding.

Returns:

• (String)

# File 'gems/aws-sdk-continuum/lib/aws-sdk-continuum/types.rb', line 1286

class FindingSummary < Struct.new(
  :finding_id,
  :finding_arn,
  :environment_id,
  :source,
  :source_finding_id,
  :reported_at,
  :status,
  :status_updated_at,
  :created_at,
  :scan_run_id,
  :status_message,
  :discard_reason,
  :discard_reasoning,
  :duplicate_of_issue_id,
  :created_issue_id,
  :completed_at,
  :type,
  :title,
  :severity,
  :category,
  :file_path)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current lifecycle status of the finding.

Returns:

• (String)

# File 'gems/aws-sdk-continuum/lib/aws-sdk-continuum/types.rb', line 1286

class FindingSummary < Struct.new(
  :finding_id,
  :finding_arn,
  :environment_id,
  :source,
  :source_finding_id,
  :reported_at,
  :status,
  :status_updated_at,
  :created_at,
  :scan_run_id,
  :status_message,
  :discard_reason,
  :discard_reasoning,
  :duplicate_of_issue_id,
  :created_issue_id,
  :completed_at,
  :type,
  :title,
  :severity,
  :category,
  :file_path)
  SENSITIVE = []
  include Aws::Structure
end

#status_message ⇒ String

Human-readable context about the current status.

Returns:

• (String)

# File 'gems/aws-sdk-continuum/lib/aws-sdk-continuum/types.rb', line 1286

class FindingSummary < Struct.new(
  :finding_id,
  :finding_arn,
  :environment_id,
  :source,
  :source_finding_id,
  :reported_at,
  :status,
  :status_updated_at,
  :created_at,
  :scan_run_id,
  :status_message,
  :discard_reason,
  :discard_reasoning,
  :duplicate_of_issue_id,
  :created_issue_id,
  :completed_at,
  :type,
  :title,
  :severity,
  :category,
  :file_path)
  SENSITIVE = []
  include Aws::Structure
end

#status_updated_at ⇒ Time

The timestamp when the status last transitioned.

Returns:

• (Time)

# File 'gems/aws-sdk-continuum/lib/aws-sdk-continuum/types.rb', line 1286

class FindingSummary < Struct.new(
  :finding_id,
  :finding_arn,
  :environment_id,
  :source,
  :source_finding_id,
  :reported_at,
  :status,
  :status_updated_at,
  :created_at,
  :scan_run_id,
  :status_message,
  :discard_reason,
  :discard_reasoning,
  :duplicate_of_issue_id,
  :created_issue_id,
  :completed_at,
  :type,
  :title,
  :severity,
  :category,
  :file_path)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ String

The producer's title for the finding.

Returns:

• (String)

# File 'gems/aws-sdk-continuum/lib/aws-sdk-continuum/types.rb', line 1286

class FindingSummary < Struct.new(
  :finding_id,
  :finding_arn,
  :environment_id,
  :source,
  :source_finding_id,
  :reported_at,
  :status,
  :status_updated_at,
  :created_at,
  :scan_run_id,
  :status_message,
  :discard_reason,
  :discard_reasoning,
  :duplicate_of_issue_id,
  :created_issue_id,
  :completed_at,
  :type,
  :title,
  :severity,
  :category,
  :file_path)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

What kind of finding this is.

Returns:

• (String)

# File 'gems/aws-sdk-continuum/lib/aws-sdk-continuum/types.rb', line 1286

class FindingSummary < Struct.new(
  :finding_id,
  :finding_arn,
  :environment_id,
  :source,
  :source_finding_id,
  :reported_at,
  :status,
  :status_updated_at,
  :created_at,
  :scan_run_id,
  :status_message,
  :discard_reason,
  :discard_reasoning,
  :duplicate_of_issue_id,
  :created_issue_id,
  :completed_at,
  :type,
  :title,
  :severity,
  :category,
  :file_path)
  SENSITIVE = []
  include Aws::Structure
end