Class: Aws::ApplicationSignals::Types::ListAuditFindingsInput

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#audit_targetsArray<Types::AuditTarget>

A list of audit targets to filter the findings by. You can specify services, SLOs, or service operations to limit the audit findings to specific entities.

Returns:



2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 2099

class ListAuditFindingsInput < Struct.new(
  :start_time,
  :end_time,
  :auditors,
  :audit_targets,
  :detail_level,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#auditorsArray<String>

A list of auditor names to filter the findings by. Only findings generated by the specified auditors will be returned.

The following auditors are available for configuration:

  • slo - SloAuditor: Identifies SLO violations and detects breached thresholds during the Assessment phase.

  • operation_metric - OperationMetricAuditor: Detects anomalies in service operation metrics from Application Signals RED metrics during the Assessment phase

    Anomaly detection is not supported for sparse metrics (those missing more than 80% of datapoints within the given time period).

  • service_quota - ServiceQuotaAuditor: Monitors resource utilization against service quotas during the Assessment phase

  • trace - TraceAuditor: Performs deep-dive analysis of distributed traces, correlating traces with breached SLOs or abnormal RED metrics during the Analysis phase

  • dependency_metric - CriticalPathAuditor: Analyzes service dependency impacts and maps dependency relationships from Application Signals RED metrics during the Analysis phase

  • top_contributor - TopContributorAuditor: Identifies infrastructure-level contributors to issues by analyzing EMF logs of Application Signals RED metrics during the Analysis phase

  • log - LogAuditor: Extracts insights from application logs, categorizing error types and ranking severity by frequency during the Analysis phase

  • change_indicator - ChangeIndicatorAuditor: Detects change events (deployments, configuration changes) that occurred within 10 minutes before and during a detected anomaly, and surfaces them as findings with deployment timestamps in the Analysis phase. When changes are detected, the top_contributor auditor skips its analysis to avoid redundancy.

InitAuditor and Summarizer auditors are not configurable as they are automatically triggered during the audit process.

Returns:

  • (Array<String>)


2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 2099

class ListAuditFindingsInput < Struct.new(
  :start_time,
  :end_time,
  :auditors,
  :audit_targets,
  :detail_level,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#detail_levelString

The level of details of the audit findings. Supported values: BRIEF, DETAILED.

Returns:

  • (String)


2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 2099

class ListAuditFindingsInput < Struct.new(
  :start_time,
  :end_time,
  :auditors,
  :audit_targets,
  :detail_level,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#end_timeTime

The end of the time period to retrieve audit findings for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, 1698778057

Returns:

  • (Time)


2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 2099

class ListAuditFindingsInput < Struct.new(
  :start_time,
  :end_time,
  :auditors,
  :audit_targets,
  :detail_level,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of audit findings to return in one operation. If you omit this parameter, the default of 10 is used.

Returns:

  • (Integer)


2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 2099

class ListAuditFindingsInput < Struct.new(
  :start_time,
  :end_time,
  :auditors,
  :audit_targets,
  :detail_level,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

Include this value, if it was returned by the previous operation, to get the next set of audit findings.

Returns:

  • (String)


2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 2099

class ListAuditFindingsInput < Struct.new(
  :start_time,
  :end_time,
  :auditors,
  :audit_targets,
  :detail_level,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#start_timeTime

The start of the time period to retrieve audit findings for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, 1698778057

Returns:

  • (Time)


2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 2099

class ListAuditFindingsInput < Struct.new(
  :start_time,
  :end_time,
  :auditors,
  :audit_targets,
  :detail_level,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end