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

GetFindingStatisticsV2

Returns aggregated statistical data about findings. GetFindingStatisticsV2 use securityhub:GetAdhocInsightResults in the Action element of an IAM policy statement. You must have permission to perform the s action. This API is in private preview and subject to change.

Request Syntax


POST /findingsv2/statistics HTTP/1.1
Content-type: application/json

{
   "GroupByRules": [ 
      { 
         "Filters": { 
            "CompositeFilters": [ 
               { 
                  "BooleanFilters": [ 
                     { 
                        "FieldName": "string",
                        "Filter": { 
                           "Value": boolean
                        }
                     }
                  ],
                  "DateFilters": [ 
                     { 
                        "FieldName": "string",
                        "Filter": { 
                           "DateRange": { 
                              "Unit": "string",
                              "Value": number
                           },
                           "End": "string",
                           "Start": "string"
                        }
                     }
                  ],
                  "MapFilters": [ 
                     { 
                        "FieldName": "string",
                        "Filter": { 
                           "Comparison": "string",
                           "Key": "string",
                           "Value": "string"
                        }
                     }
                  ],
                  "NumberFilters": [ 
                     { 
                        "FieldName": "string",
                        "Filter": { 
                           "Eq": number,
                           "Gt": number,
                           "Gte": number,
                           "Lt": number,
                           "Lte": number
                        }
                     }
                  ],
                  "Operator": "string",
                  "StringFilters": [ 
                     { 
                        "FieldName": "string",
                        "Filter": { 
                           "Comparison": "string",
                           "Value": "string"
                        }
                     }
                  ]
               }
            ],
            "CompositeOperator": "string"
         },
         "GroupByField": "string"
      }
   ],
   "MaxStatisticResults": number,
   "SortOrder": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

GroupByRules

Specifies how security findings should be aggregated and organized in the statistical analysis. It can accept up to 5 groupBy fields in a single call.

Type: Array of GroupByRule objects

Required: Yes

MaxStatisticResults

The maximum number of results to be returned.

Type: Integer

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

Required: No

SortOrder

Orders the aggregation count in descending or ascending order. Descending order is the default.

Type: String

Valid Values: asc | desc

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "GroupByResults": [ 
      { 
         "GroupByField": "string",
         "GroupByValues": [ 
            { 
               "Count": number,
               "FieldValue": "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.

GroupByResults

Aggregated statistics about security findings based on specified grouping criteria.

Type: Array of GroupByResult objects

Errors

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

AccessDeniedException

You don't have permission to perform the action specified in the request.

HTTP Status Code: 403

ConflictException

The request causes conflict with the current state of the service resource.

HTTP Status Code: 409

InternalServerException

The request has failed due to an internal failure of the service.

HTTP Status Code: 500

ThrottlingException

The limit on the number of requests per second was exceeded.

HTTP Status Code: 429

ValidationException

The request has failed validation because it's missing required fields or has invalid inputs.

HTTP Status Code: 400