Class: Aws::SecurityHub::Types::FindingHistoryRecord

Inherits:

Struct

• Object
• Struct
• Aws::SecurityHub::Types::FindingHistoryRecord

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-securityhub/types.rb

Overview

A list of events that changed the specified finding during the specified time period. Each record represents a single finding change event.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #finding_created ⇒ Boolean

  Identifies whether the event marks the creation of a new finding.

• #finding_identifier ⇒ Types::AwsSecurityFindingIdentifier

  Identifies which finding to get the finding history for.

• #next_token ⇒ String

  A token for pagination purposes.

• #update_source ⇒ Types::FindingHistoryUpdateSource

  Identifies the source of the event that changed the finding.

• #update_time ⇒ Time

  A timestamp that indicates when Security Hub processed the updated finding record.

• #updates ⇒ Array<Types::FindingHistoryUpdate>

  An array of objects that provides details about the finding change event, including the Amazon Web Services Security Finding Format (ASFF) field that changed, the value of the field before the change, and the value of the field after the change.

Instance Attribute Details

#finding_created ⇒ Boolean

Identifies whether the event marks the creation of a new finding. A value of ‘True` means that the finding is newly created. A value of `False` means that the finding isn’t newly created.

Returns:

• (Boolean)

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

class FindingHistoryRecord < Struct.new(
  :finding_identifier,
  :update_time,
  :finding_created,
  :update_source,
  :updates,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#finding_identifier ⇒ Types::AwsSecurityFindingIdentifier

Identifies which finding to get the finding history for.

Returns:

• (Types::AwsSecurityFindingIdentifier)

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

class FindingHistoryRecord < Struct.new(
  :finding_identifier,
  :update_time,
  :finding_created,
  :update_source,
  :updates,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

A token for pagination purposes. Provide this token in the subsequent request to [ ‘GetFindingsHistory` ][1] to get up to an additional 100 results of history for the same finding that you specified in your initial request.

[1]: docs.aws.amazon.com/securityhub/1.0/APIReference/API_GetFindingsHistory.html

Returns:

• (String)

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

class FindingHistoryRecord < Struct.new(
  :finding_identifier,
  :update_time,
  :finding_created,
  :update_source,
  :updates,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#update_source ⇒ Types::FindingHistoryUpdateSource

Identifies the source of the event that changed the finding. For example, an integrated Amazon Web Services service or third-party partner integration may call [ ‘BatchImportFindings` ][1], or an Security Hub customer may call [ `BatchUpdateFindings` ][2].

[1]: docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchImportFindings.html [2]: docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateFindings.html

Returns:

• (Types::FindingHistoryUpdateSource)

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

class FindingHistoryRecord < Struct.new(
  :finding_identifier,
  :update_time,
  :finding_created,
  :update_source,
  :updates,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#update_time ⇒ Time

A timestamp that indicates when Security Hub processed the updated finding record.

For more information about the validation and formatting of timestamp fields in Security Hub, see [Timestamps].

[1]: docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps

Returns:

• (Time)

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

class FindingHistoryRecord < Struct.new(
  :finding_identifier,
  :update_time,
  :finding_created,
  :update_source,
  :updates,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#updates ⇒ Array<Types::FindingHistoryUpdate>

An array of objects that provides details about the finding change event, including the Amazon Web Services Security Finding Format (ASFF) field that changed, the value of the field before the change, and the value of the field after the change.

Returns:

• (Array<Types::FindingHistoryUpdate>)

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

class FindingHistoryRecord < Struct.new(
  :finding_identifier,
  :update_time,
  :finding_created,
  :update_source,
  :updates,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end