MetricsSummary

Information about summary metrics in an account.

AmazonSecuritySASTCode AnalysisDevSecOpsDeveloper Tools

Properties

Name Type Description
categoriesWithMostFindings object
date object
openFindings object
scansWithMostOpenCriticalFindings object
scansWithMostOpenFindings object
View JSON Schema on GitHub

JSON Schema

amazon-codeguru-security-metrics-summary-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codeguru-security/refs/heads/main/json-schema/amazon-codeguru-security-metrics-summary-schema.json",
  "title": "MetricsSummary",
  "description": "Information about summary metrics in an account.",
  "type": "object",
  "properties": {
    "categoriesWithMostFindings": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CategoriesWithMostFindings"
        },
        {
          "description": "A list of <code>CategoryWithFindingNum</code> objects for the top 5 finding categories with the most open findings in an account."
        }
      ]
    },
    "date": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The date from which the metrics summary information was retrieved."
        }
      ]
    },
    "openFindings": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FindingMetricsValuePerSeverity"
        },
        {
          "description": "The number of open findings of each severity in an account."
        }
      ]
    },
    "scansWithMostOpenCriticalFindings": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ScansWithMostOpenCriticalFindings"
        },
        {
          "description": "A list of <code>ScanNameWithFindingNum</code> objects for the top 3 scans with the most number of open findings in an account."
        }
      ]
    },
    "scansWithMostOpenFindings": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ScansWithMostOpenFindings"
        },
        {
          "description": "A list of <code>ScanNameWithFindingNum</code> objects for the top 3 scans with the most number of open critical findings in an account."
        }
      ]
    }
  }
}