Skip to content

GetFindingStatisticsRequest

Source code in docs_src/capo_macie2/types/get_finding_statistics_request.py
class GetFindingStatisticsRequest(TypedDict, closed=True):
    finding_criteria: NotRequired["capo_macie2.types.finding_criteria.FindingCriteria"]
    """<p>The criteria to use to filter the query results.</p>"""
    group_by: NotRequired["capo_macie2.types.group_by.GroupBy"]
    """<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: NotRequired["capo_macie2.types.__integer.__integer"]
    """<p>The maximum number of items to include in each page of the response.</p>"""
    sort_criteria: NotRequired[
        "capo_macie2.types.finding_statistics_sort_criteria.FindingStatisticsSortCriteria"
    ]
    """<p>The criteria to use to sort the query results.</p>"""

finding_criteria instance-attribute

finding_criteria: NotRequired[FindingCriteria]

The criteria to use to filter the query results.

group_by instance-attribute

group_by: NotRequired[GroupBy]

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 instance-attribute

size: NotRequired[__integer]

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

sort_criteria instance-attribute

sort_criteria: NotRequired[FindingStatisticsSortCriteria]

The criteria to use to sort the query results.