findings_metrics
Creates, updates, deletes, gets or lists a findings_metrics resource.
Overview
| Name | findings_metrics |
| Type | Resource |
| Id | aws.codeguru_security.findings_metrics |
Fields
The following fields are returned by SELECT queries:
- list_findings_metrics
| Name | Datatype | Description |
|---|---|---|
closed_findings | object | The number of closed findings of each severity on the specified date. |
date | string (date-time) | The date from which the findings metrics were retrieved. |
mean_time_to_close | object | The average time in days it takes to close findings of each severity as of a specified date. |
new_findings | object | The number of new findings of each severity on the specified date. |
open_findings | object | The number of open findings of each severity as of the specified date. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_findings_metrics | select | startDate, endDate, region | nextToken, maxResults | Returns metrics about all findings in an account within a specified time range. |
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 |
|---|---|---|
endDate | string (date-time) | The end date of the interval which you want to retrieve metrics from. Round to the nearest day. |
region | string | AWS region (default: us-east-1) |
startDate | string (date-time) | The start date of the interval which you want to retrieve metrics from. Rounds to the nearest day. |
maxResults | integer | The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the nextToken element is returned in the response. Use nextToken in a subsequent request to retrieve additional results. If not specified, returns 1000 results. |
nextToken | string | A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page. |
SELECT examples
- list_findings_metrics
Returns metrics about all findings in an account within a specified time range.
SELECT
closed_findings,
date,
mean_time_to_close,
new_findings,
open_findings
FROM aws.codeguru_security.findings_metrics
WHERE startDate = '{{ startDate }}' -- required
AND endDate = '{{ endDate }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;