Class: Aws::SecurityHub::Types::GetFindingHistoryRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#end_time ⇒ Time

An ISO 8601-formatted timestamp that indicates the end time of the requested finding history.

If you provide values for both ‘StartTime` and `EndTime`, Security Hub returns finding history for the specified time period. If you provide a value for `StartTime` but not for `EndTime`, Security Hub returns finding history from the `StartTime` to the time at which the API is called. If you provide a value for `EndTime` but not for `StartTime`, Security Hub returns finding history from the

CreatedAt][1

timestamp of the finding to the ‘EndTime`. If you

provide neither ‘StartTime` nor `EndTime`, Security Hub returns finding history from the CreatedAt timestamp of the finding to the time at which the API is called. In all of these scenarios, the response is limited to 100 results, and the maximum time period is limited to 90 days.

This field accepts only the specified formats. Timestamps can end with ‘Z` or `(“+” / “-”) time-hour [“:” time-minute]`. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • ‘YYYY-MM-DDTHH:MM:SSZ` (for example, `2019-01-31T23:00:00Z`)

  • ‘YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ` (for example, `2019-01-31T23:00:00.123456789Z`)

  • ‘YYYY-MM-DDTHH:MM:SS+HH:MM` (for example, `2024-01-04T15:25:10+17:59`)

  • ‘YYYY-MM-DDTHH:MM:SS-HHMM` (for example, `2024-01-04T15:25:10-1759`)

  • ‘YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM` (for example, `2024-01-04T15:25:10.123456789+17:59`)

[1]: docs.aws.amazon.com/securityhub/1.0/APIReference/API_AwsSecurityFindingFilters.html#securityhub-Type-AwsSecurityFindingFilters-CreatedAt

Returns:

  • (Time) 


25735
25736
25737
25738
25739
25740
25741
25742
25743
 
# File 'lib/aws-sdk-securityhub/types.rb', line 25735

class GetFindingHistoryRequest < Struct.new(
  :finding_identifier,
  :start_time,
  :end_time,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#finding_identifier ⇒ Types::AwsSecurityFindingIdentifier

Identifies which finding to get the finding history for.

Returns:



25735
25736
25737
25738
25739
25740
25741
25742
25743
 
# File 'lib/aws-sdk-securityhub/types.rb', line 25735

class GetFindingHistoryRequest < Struct.new(
  :finding_identifier,
  :start_time,
  :end_time,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to be returned. If you don’t provide it, Security Hub returns up to 100 results of finding history.

Returns:

  • (Integer) 


25735
25736
25737
25738
25739
25740
25741
25742
25743
 
# File 'lib/aws-sdk-securityhub/types.rb', line 25735

class GetFindingHistoryRequest < Struct.new(
  :finding_identifier,
  :start_time,
  :end_time,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

A token for pagination purposes. Provide ‘NULL` as the initial value. In subsequent requests, provide the token included in the response to get up to an additional 100 results of finding history. If you don’t provide `NextToken`, Security Hub returns up to 100 results of finding history for each request.

Returns:

  • (String) 


25735
25736
25737
25738
25739
25740
25741
25742
25743
 
# File 'lib/aws-sdk-securityhub/types.rb', line 25735

class GetFindingHistoryRequest < Struct.new(
  :finding_identifier,
  :start_time,
  :end_time,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

A timestamp that indicates the start time of the requested finding history.

If you provide values for both ‘StartTime` and `EndTime`, Security Hub returns finding history for the specified time period. If you provide a value for `StartTime` but not for `EndTime`, Security Hub returns finding history from the `StartTime` to the time at which the API is called. If you provide a value for `EndTime` but not for `StartTime`, Security Hub returns finding history from the

CreatedAt][1

timestamp of the finding to the ‘EndTime`. If you

provide neither ‘StartTime` nor `EndTime`, Security Hub returns finding history from the CreatedAt timestamp of the finding to the time at which the API is called. In all of these scenarios, the response is limited to 100 results, and the maximum time period is limited to 90 days.

This field accepts only the specified formats. Timestamps can end with ‘Z` or `(“+” / “-”) time-hour [“:” time-minute]`. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • ‘YYYY-MM-DDTHH:MM:SSZ` (for example, `2019-01-31T23:00:00Z`)

  • ‘YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ` (for example, `2019-01-31T23:00:00.123456789Z`)

  • ‘YYYY-MM-DDTHH:MM:SS+HH:MM` (for example, `2024-01-04T15:25:10+17:59`)

  • ‘YYYY-MM-DDTHH:MM:SS-HHMM` (for example, `2024-01-04T15:25:10-1759`)

  • ‘YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM` (for example, `2024-01-04T15:25:10.123456789+17:59`)

[1]: docs.aws.amazon.com/securityhub/1.0/APIReference/API_AwsSecurityFindingFilters.html#securityhub-Type-AwsSecurityFindingFilters-CreatedAt

Returns:

  • (Time) 


25735
25736
25737
25738
25739
25740
25741
25742
25743
 
# File 'lib/aws-sdk-securityhub/types.rb', line 25735

class GetFindingHistoryRequest < Struct.new(
  :finding_identifier,
  :start_time,
  :end_time,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end