Skip to content
AWS for Query.Farm

aws.codeguru_security.get_metrics_summary

Example SQL Queries

SELECT * FROM
aws.codeguru_security.get_metrics_summary
WHERE
"date" = 'VALUE';

Description

Returns a summary of metrics for an account from a specified date, including number of open findings, the categories with most findings, the scans with most open findings, and scans with most open critical findings.

Table Definition

Column NameColumn Data Type
date Required Input Column

The date you want to retrieve summary metrics from, rounded to the nearest day. The date must be within the past two years.

TIMESTAMP_S
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

metrics_summary

The summary metrics from the specified date.

STRUCT(
    "categories_with_most_findings" STRUCT(
        "category_name" VARCHAR,
        "finding_number" BIGINT
    )[],
    "date" TIMESTAMP_S,
    "open_findings" STRUCT(
        "critical" DOUBLE,
        "high" DOUBLE,
        "info" DOUBLE,
        "low" DOUBLE,
        "medium" DOUBLE
    ),
    "scans_with_most_open_critical_findings" STRUCT(
        "finding_number" BIGINT,
        "scan_name" VARCHAR
    )[],
    "scans_with_most_open_findings" STRUCT(
        "finding_number" BIGINT,
        "scan_name" VARCHAR
    )[]
)
Show child fields
metrics_summary.categories_with_most_findings[]
Show child fields
metrics_summary.categories_with_most_findings[].category_name

The name of the finding category. A finding category is determined by the detector that detected the finding.

metrics_summary.categories_with_most_findings[].finding_number

The number of open findings in the category.

metrics_summary.date

The date from which the metrics summary information was retrieved.

metrics_summary.open_findings

The number of open findings of each severity.

Show child fields
metrics_summary.open_findings.critical

A numeric value corresponding to a critical finding.

metrics_summary.open_findings.high

A numeric value corresponding to a high severity finding.

metrics_summary.open_findings.info

A numeric value corresponding to an informational finding.

metrics_summary.open_findings.low

A numeric value corresponding to a low severity finding.

metrics_summary.open_findings.medium

A numeric value corresponding to a medium severity finding.

metrics_summary.scans_with_most_open_critical_findings[]
Show child fields
metrics_summary.scans_with_most_open_critical_findings[].finding_number

The number of findings generated by a scan.

metrics_summary.scans_with_most_open_critical_findings[].scan_name

The name of the scan.

metrics_summary.scans_with_most_open_findings[]
Show child fields
metrics_summary.scans_with_most_open_findings[].finding_number

The number of findings generated by a scan.

metrics_summary.scans_with_most_open_findings[].scan_name

The name of the scan.