Skip to content

GetFindingStatisticsV2Request

Source code in docs_src/capo_securityhub/types/get_finding_statistics_v2_request.py 
14
15
16
17
18
19
20
21
22
23
24
class GetFindingStatisticsV2Request(TypedDict, closed=True):
    group_by_rules: NotRequired["capo_securityhub.types.group_by_rules.GroupByRules"]
    """<p>Specifies how security findings should be aggregated and organized in the statistical analysis. It can accept up to 5 <code>groupBy</code> fields in a single call.</p>"""
    scopes: NotRequired["capo_securityhub.types.finding_scopes.FindingScopes"]
    """<p>Limits the results to findings from specific organizational units or from the delegated administrator's organization. Only the delegated administrator account can use this parameter. Other accounts receive an <code>AccessDeniedException</code>.</p> <p>This parameter is optional. If you omit it, the delegated administrator sees statistics from all accounts across the entire organization. Other accounts see only statistics for their own findings.</p> <p>You can specify up to 10 entries in <code>Scopes.AwsOrganizations</code>. If multiple entries are specified, the entries are combined using OR logic.</p>"""
    sort_order: NotRequired["capo_securityhub.types.sort_order.SortOrder"]
    """<p>Orders the aggregation count in descending or ascending order. Descending order is the default.</p>"""
    max_statistic_results: NotRequired[
        "capo_securityhub.types.max_statistic_results.MaxStatisticResults"
    ]
    """<p>The maximum number of results to be returned.</p>"""

group_by_rules instance-attribute 

group_by_rules: NotRequired[GroupByRules]

Specifies how security findings should be aggregated and organized in the statistical analysis. It can accept up to 5 groupBy fields in a single call.

max_statistic_results instance-attribute 

max_statistic_results: NotRequired[MaxStatisticResults]

The maximum number of results to be returned.

scopes instance-attribute 

scopes: NotRequired[FindingScopes]

Limits the results to findings from specific organizational units or from the delegated administrator's organization. Only the delegated administrator account can use this parameter. Other accounts receive an AccessDeniedException.

This parameter is optional. If you omit it, the delegated administrator sees statistics from all accounts across the entire organization. Other accounts see only statistics for their own findings.

You can specify up to 10 entries in Scopes.AwsOrganizations. If multiple entries are specified, the entries are combined using OR logic.

sort_order instance-attribute 

sort_order: NotRequired[SortOrder]

Orders the aggregation count in descending or ascending order. Descending order is the default.