Get Findings Trends V2

securityhub_get_findings_trends_v2

R Documentation

Returns findings trend data based on the specified criteria

Description

Returns findings trend data based on the specified criteria. This operation helps you analyze patterns and changes in findings over time.

Usage

securityhub_get_findings_trends_v2(Filters, StartTime, EndTime,
  NextToken, MaxResults)

Arguments

Filters	The filters to apply to the findings trend data.
StartTime	[required] The starting timestamp for the time period to analyze findings trends, in ISO 8601 format.
EndTime	[required] The ending timestamp for the time period to analyze findings trends, in ISO 8601 format.
NextToken	The token to use for paginating results. This value is returned in the response if more results are available.
MaxResults	The maximum number of trend data points to return in a single response.

Value

A list with the following syntax:

list(
  Granularity = "Daily"|"Weekly"|"Monthly",
  TrendsMetrics = list(
    list(
      Timestamp = as.POSIXct(
        "2015-01-01"
      ),
      TrendsValues = list(
        SeverityTrends = list(
          Unknown = 123,
          Informational = 123,
          Low = 123,
          Medium = 123,
          High = 123,
          Critical = 123,
          Fatal = 123,
          Other = 123
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$get_findings_trends_v2(
  Filters = list(
    CompositeFilters = list(
      list(
        StringFilters = list(
          list(
            FieldName = "account_id"|"region"|"finding_types"|"finding_status"|"finding_cve_ids"|"finding_compliance_status"|"finding_control_id"|"finding_class_name"|"finding_provider"|"finding_activity_name",
            Filter = list(
              Value = "string",
              Comparison = "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"|"CONTAINS_WORD"
            )
          )
        ),
        NestedCompositeFilters = list(),
        Operator = "AND"|"OR"
      )
    ),
    CompositeOperator = "AND"|"OR"
  ),
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  NextToken = "string",
  MaxResults = 123
)