metrics_summaries
Creates, updates, deletes, gets or lists a metrics_summaries resource.
Overview
| Name | metrics_summaries |
| Type | Resource |
| Id | aws.codeguru_security.metrics_summaries |
Fields
The following fields are returned by SELECT queries:
- get_metrics_summary
| Name | Datatype | Description |
|---|---|---|
categories_with_most_findings | array | A list of CategoryWithFindingNum objects for the top 5 finding categories with the most findings. |
date | string (date-time) | The date from which the metrics summary information was retrieved. |
open_findings | object | The number of open findings of each severity. |
scans_with_most_open_critical_findings | array | A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open critical findings. |
scans_with_most_open_findings | array | A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open findings. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_metrics_summary | select | date, region | Returns a summary of metrics for an account from a specified date, including number of open findings, the categories with most findings, the scans with most open findings, and scans with most open critical findings. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
date | string (date-time) | The date you want to retrieve summary metrics from, rounded to the nearest day. The date must be within the past two years. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_metrics_summary
Returns a summary of metrics for an account from a specified date, including number of open findings, the categories with most findings, the scans with most open findings, and scans with most open critical findings.
SELECT
categories_with_most_findings,
date,
open_findings,
scans_with_most_open_critical_findings,
scans_with_most_open_findings
FROM aws.codeguru_security.metrics_summaries
WHERE date = '{{ date }}' -- required
AND region = '{{ region }}' -- required
;