Skip to content
AWS for Query.Farm

aws.macie2.get_finding_statistics

Example SQL Queries

SELECT * FROM
aws.macie2.get_finding_statistics
WHERE
"group_by" = 'VALUE';

Description

Retrieves (queries) aggregated statistical data about findings.

Table Definition

Column NameColumn Data Type
group_by Required Input Column

The finding property to use to group the query results. Valid values are:

  • classificationDetails.jobId - The unique identifier for the classification job that produced the finding.

  • resourcesAffected.s3Bucket.name - The name of the S3 bucket that the finding applies to.

  • severity.description - The severity level of the finding, such as High or Medium.

  • type - The type of finding, such as Policy:IAMUser/S3BucketPublic and SensitiveData:S3Object/Personal.

VARCHAR
finding_criteria Input Column

The criteria to use to filter the query results.

STRUCT(
    "criterion" MAP(VARCHAR, STRUCT(
            "eq" VARCHAR[],
            "eq_exact_match" VARCHAR[],
            "gt" BIGINT,
            "gte" BIGINT,
            "lt" BIGINT,
            "lte" BIGINT,
            "neq" VARCHAR[]
        ))
)
Show child fields
finding_criteria.criterion

A condition that specifies the property, operator, and one or more values to use to filter the results.

size Input Column

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

BIGINT
sort_criteria Input Column

The criteria to use to sort the query results.

STRUCT(
    "attribute_name" VARCHAR,
    "order_by" VARCHAR
)
Show child fields
sort_criteria.attribute_name

The grouping to sort the results by. Valid values are: count, sort the results by the number of findings in each group of results; and, groupKey, sort the results by the name of each group of results.

sort_criteria.order_by

The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

_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.

_aws_region Input Column

The AWS region to use.

VARCHAR
counts_by_group

An array of objects, one for each group of findings that matches the filter criteria specified in the request.

STRUCT(
    "count" BIGINT,
    "group_key" VARCHAR
)[]
Show child fields
counts_by_group[]
Show child fields
counts_by_group[].count

The total number of findings in the group of query results.

counts_by_group[].group_key

The name of the property that defines the group in the query results, as specified by the groupBy property in the query request.