aws_sdk_securityhub/client/get_finding_statistics_v2.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`GetFindingStatisticsV2`](crate::operation::get_finding_statistics_v2::builders::GetFindingStatisticsV2FluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`group_by_rules(GroupByRule)`](crate::operation::get_finding_statistics_v2::builders::GetFindingStatisticsV2FluentBuilder::group_by_rules) / [`set_group_by_rules(Option<Vec::<GroupByRule>>)`](crate::operation::get_finding_statistics_v2::builders::GetFindingStatisticsV2FluentBuilder::set_group_by_rules):<br>required: **true**<br><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><br>
7 /// - [`scopes(FindingScopes)`](crate::operation::get_finding_statistics_v2::builders::GetFindingStatisticsV2FluentBuilder::scopes) / [`set_scopes(Option<FindingScopes>)`](crate::operation::get_finding_statistics_v2::builders::GetFindingStatisticsV2FluentBuilder::set_scopes):<br>required: **false**<br><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><br>
8 /// - [`sort_order(SortOrder)`](crate::operation::get_finding_statistics_v2::builders::GetFindingStatisticsV2FluentBuilder::sort_order) / [`set_sort_order(Option<SortOrder>)`](crate::operation::get_finding_statistics_v2::builders::GetFindingStatisticsV2FluentBuilder::set_sort_order):<br>required: **false**<br><p>Orders the aggregation count in descending or ascending order. Descending order is the default.</p><br>
9 /// - [`max_statistic_results(i32)`](crate::operation::get_finding_statistics_v2::builders::GetFindingStatisticsV2FluentBuilder::max_statistic_results) / [`set_max_statistic_results(Option<i32>)`](crate::operation::get_finding_statistics_v2::builders::GetFindingStatisticsV2FluentBuilder::set_max_statistic_results):<br>required: **false**<br><p>The maximum number of results to be returned.</p><br>
10 /// - On success, responds with [`GetFindingStatisticsV2Output`](crate::operation::get_finding_statistics_v2::GetFindingStatisticsV2Output) with field(s):
11 /// - [`group_by_results(Option<Vec::<GroupByResult>>)`](crate::operation::get_finding_statistics_v2::GetFindingStatisticsV2Output::group_by_results): <p>Aggregated statistics about security findings based on specified grouping criteria.</p>
12 /// - On failure, responds with [`SdkError<GetFindingStatisticsV2Error>`](crate::operation::get_finding_statistics_v2::GetFindingStatisticsV2Error)
13 pub fn get_finding_statistics_v2(&self) -> crate::operation::get_finding_statistics_v2::builders::GetFindingStatisticsV2FluentBuilder {
14 crate::operation::get_finding_statistics_v2::builders::GetFindingStatisticsV2FluentBuilder::new(self.handle.clone())
15 }
16}