GetFindingsStatistics
Lists Amazon GuardDuty findings statistics for the specified detector ID.
There might be regional differences because some flags might not be available in all the Regions where GuardDuty is currently supported. For more information, see Regions and endpoints.
Request Syntax
POST /detector/detectorId
/findings/statistics HTTP/1.1
Content-type: application/json
{
"findingCriteria": {
"criterion": {
"string
" : {
"eq": [ "string
" ],
"equals": [ "string
" ],
"greaterThan": number
,
"greaterThanOrEqual": number
,
"gt": number
,
"gte": number
,
"lessThan": number
,
"lessThanOrEqual": number
,
"lt": number
,
"lte": number
,
"neq": [ "string
" ],
"notEquals": [ "string
" ]
}
}
},
"findingStatisticTypes": [ "string
" ]
}
URI Request Parameters
The request uses the following URI parameters.
- detectorId
-
The ID of the detector that specifies the GuardDuty service whose findings' statistics you want to retrieve.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- findingCriteria
-
Represents the criteria that is used for querying findings.
Type: FindingCriteria object
Required: No
- findingStatisticTypes
-
The types of finding statistics to retrieve.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Valid Values:
COUNT_BY_SEVERITY
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"findingStatistics": {
"countBySeverity": {
"string" : number
}
}
}
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.
- findingStatistics
-
The finding statistics object.
Type: FindingStatistics object
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
A bad request exception object.
HTTP Status Code: 400
- InternalServerErrorException
-
An internal server error exception object.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: