Get Finding Statistics

macie2_get_finding_statistics

R Documentation

Retrieves (queries) aggregated statistical data about findings¶

Description¶

Retrieves (queries) aggregated statistical data about findings.

Usage¶

macie2_get_finding_statistics(findingCriteria, groupBy, size,
  sortCriteria)

Arguments¶

findingCriteria

The criteria to use to filter the query results.

groupBy

[required] 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.

size

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

sortCriteria

The criteria to use to sort the query results.

Value¶

A list with the following syntax:

list(
  countsByGroup = list(
    list(
      count = 123,
      groupKey = "string"
    )
  )
)

Request syntax¶

svc$get_finding_statistics(
  findingCriteria = list(
    criterion = list(
      list(
        eq = list(
          "string"
        ),
        eqExactMatch = list(
          "string"
        ),
        gt = 123,
        gte = 123,
        lt = 123,
        lte = 123,
        neq = list(
          "string"
        )
      )
    )
  ),
  groupBy = "resourcesAffected.s3Bucket.name"|"type"|"classificationDetails.jobId"|"severity.description",
  size = 123,
  sortCriteria = list(
    attributeName = "groupKey"|"count",
    orderBy = "ASC"|"DESC"
  )
)