Amazon Macie · Schema

GetFindingStatisticsRequest

GetFindingStatisticsRequest schema from Amazon Macie API

Data SecuritySensitive DataPrivacyComplianceMachine LearningS3

Properties

Name Type Description
findingCriteria object
groupBy object
size object
sortCriteria object
View JSON Schema on GitHub

JSON Schema

amazon-macie-get-finding-statistics-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-macie/refs/heads/main/json-schema/amazon-macie-get-finding-statistics-request-schema.json",
  "title": "GetFindingStatisticsRequest",
  "description": "GetFindingStatisticsRequest schema from Amazon Macie API",
  "type": "object",
  "properties": {
    "findingCriteria": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FindingCriteria"
        },
        {
          "description": "The criteria to use to filter the query results."
        }
      ]
    },
    "groupBy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GroupBy"
        },
        {
          "description": "<p>The finding property to use to group the query results. Valid values are:</p> <ul><li><p>classificationDetails.jobId - The unique identifier for the classification job that produced the finding.</p></li> <li><p>resourcesAffected.s3Bucket.name - The name of the S3 bucket that the finding applies to.</p></li> <li><p>severity.description - The severity level of the finding, such as High or Medium.</p></li> <li><p>type - The type of finding, such as Policy:IAMUser/S3BucketPublic and SensitiveData:S3Object/Personal.</p></li></ul>"
        }
      ]
    },
    "size": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "description": "The maximum number of items to include in each page of the response."
        }
      ]
    },
    "sortCriteria": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FindingStatisticsSortCriteria"
        },
        {
          "description": "The criteria to use to sort the query results."
        }
      ]
    }
  },
  "required": [
    "groupBy"
  ]
}