Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListAuditFindings

Returns a list of audit findings that provide automated analysis of service behavior and root cause analysis. These findings help identify the most significant observations about your services, including performance issues, anomalies, and potential problems. The findings are generated using heuristic algorithms based on established troubleshooting patterns.

Request Syntax


POST /auditFindings?EndTime=EndTime&StartTime=StartTime HTTP/1.1
Content-type: application/json

{
   "Auditors": [ "string" ],
   "AuditTargets": [ 
      { 
         "Data": { ... },
         "Type": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}

URI Request Parameters

The request uses the following URI parameters.

EndTime

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

Required: Yes

StartTime

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

Auditors

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

Note
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

Note

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

Type: Array of strings

Required: No

AuditTargets

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.

Type: Array of AuditTarget objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: Yes

MaxResults

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 10.

Required: No

NextToken

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

Type: String

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "AuditFindings": [ 
      { 
         "AuditorResults": [ 
            { 
               "Auditor": "string",
               "Description": "string",
               "Severity": "string"
            }
         ],
         "DependencyGraph": { 
            "Edges": [ 
               { 
                  "ConnectionType": "string",
                  "DestinationNodeId": "string",
                  "Duration": number,
                  "SourceNodeId": "string"
               }
            ],
            "Nodes": [ 
               { 
                  "Duration": number,
                  "KeyAttributes": { 
                     "string" : "string" 
                  },
                  "Name": "string",
                  "NodeId": "string",
                  "Operation": "string",
                  "Status": "string",
                  "Type": "string"
               }
            ]
         },
         "KeyAttributes": { 
            "string" : "string" 
         },
         "MetricGraph": { 
            "EndTime": number,
            "MetricDataQueries": [ 
               { 
                  "AccountId": "string",
                  "Expression": "string",
                  "Id": "string",
                  "Label": "string",
                  "MetricStat": { 
                     "Metric": { 
                        "Dimensions": [ 
                           { 
                              "Name": "string",
                              "Value": "string"
                           }
                        ],
                        "MetricName": "string",
                        "Namespace": "string"
                     },
                     "Period": number,
                     "Stat": "string",
                     "Unit": "string"
                  },
                  "Period": number,
                  "ReturnData": boolean
               }
            ],
            "StartTime": number
         },
         "Operation": "string",
         "Type": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AuditFindings

An array of structures, where each structure contains information about one audit finding, including the auditor results, severity, and associated metric and dependency graphs.

Type: Array of AuditFinding objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

NextToken

Include this value in your next use of this API to get the next set of audit findings.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

ThrottlingException

The request was throttled because of quota limits.

HTTP Status Code: 429

ValidationException

The resource is not valid.

HTTP Status Code: 400