POST

/findings/statistics

http://macie2.{region}.amazonaws.com/findings/statistics

Retrieves (queries) aggregated statistical data about findings.

Access Token Required: API Key

Body Params

sizeinteger

The maximum number of items to include in each page of the response.

groupBystringrequired

The finding property to use to group the query results. Valid values are: <ul><li>classificationDetails.jobId - The unique identifier for the classification job that produced the finding.</li> <li>resourcesAffected.s3Bucket.name - The name of the S3 bucket that the finding applies to.</li> <li>severity.description - The severity level of the finding, such as High or Medium.</li> <li>type - The type of finding, such as Policy:IAMUser/S3BucketPublic and SensitiveData:S3Object/Personal.</li></ul>

sortCriteriaobject

Specifies criteria for sorting the results of a query that retrieves aggregated statistical data about findings.

findingCriteriaobject

Specifies, as a map, one or more property-based conditions that filter the results of a query for findings.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://macie2.{region}.amazonaws.com/findings/statistics' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}