aws_sdk_guardduty/client/
get_findings_statistics.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 [`GetFindingsStatistics`](crate::operation::get_findings_statistics::builders::GetFindingsStatisticsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`detector_id(impl Into<String>)`](crate::operation::get_findings_statistics::builders::GetFindingsStatisticsFluentBuilder::detector_id) / [`set_detector_id(Option<String>)`](crate::operation::get_findings_statistics::builders::GetFindingsStatisticsFluentBuilder::set_detector_id):<br>required: **true**<br><p>The ID of the detector whose findings statistics you want to retrieve.</p> <p>To find the <code>detectorId</code> in the current Region, see the Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p><br>
7    ///   - [`finding_statistic_types(FindingStatisticType)`](crate::operation::get_findings_statistics::builders::GetFindingsStatisticsFluentBuilder::finding_statistic_types) / [`set_finding_statistic_types(Option<Vec::<FindingStatisticType>>)`](crate::operation::get_findings_statistics::builders::GetFindingsStatisticsFluentBuilder::set_finding_statistic_types):<br>required: **false**<br><p>The types of finding statistics to retrieve.</p><br>
8    ///   - [`finding_criteria(FindingCriteria)`](crate::operation::get_findings_statistics::builders::GetFindingsStatisticsFluentBuilder::finding_criteria) / [`set_finding_criteria(Option<FindingCriteria>)`](crate::operation::get_findings_statistics::builders::GetFindingsStatisticsFluentBuilder::set_finding_criteria):<br>required: **false**<br><p>Represents the criteria that is used for querying findings.</p><br>
9    ///   - [`group_by(GroupByType)`](crate::operation::get_findings_statistics::builders::GetFindingsStatisticsFluentBuilder::group_by) / [`set_group_by(Option<GroupByType>)`](crate::operation::get_findings_statistics::builders::GetFindingsStatisticsFluentBuilder::set_group_by):<br>required: **false**<br><p>Displays the findings statistics grouped by one of the listed valid values.</p><br>
10    ///   - [`order_by(OrderBy)`](crate::operation::get_findings_statistics::builders::GetFindingsStatisticsFluentBuilder::order_by) / [`set_order_by(Option<OrderBy>)`](crate::operation::get_findings_statistics::builders::GetFindingsStatisticsFluentBuilder::set_order_by):<br>required: **false**<br><p>Displays the sorted findings in the requested order. The default value of <code>orderBy</code> is <code>DESC</code>.</p> <p>You can use this parameter only with the <code>groupBy</code> parameter.</p><br>
11    ///   - [`max_results(i32)`](crate::operation::get_findings_statistics::builders::GetFindingsStatisticsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_findings_statistics::builders::GetFindingsStatisticsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to be returned in the response. The default value is 25.</p> <p>You can use this parameter only with the <code>groupBy</code> parameter.</p><br>
12    /// - On success, responds with [`GetFindingsStatisticsOutput`](crate::operation::get_findings_statistics::GetFindingsStatisticsOutput) with field(s):
13    ///   - [`finding_statistics(Option<FindingStatistics>)`](crate::operation::get_findings_statistics::GetFindingsStatisticsOutput::finding_statistics): <p>The finding statistics object.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::get_findings_statistics::GetFindingsStatisticsOutput::next_token): <p>The pagination parameter to be used on the next list operation to retrieve more items.</p> <p>This parameter is currently not supported.</p>
15    /// - On failure, responds with [`SdkError<GetFindingsStatisticsError>`](crate::operation::get_findings_statistics::GetFindingsStatisticsError)
16    pub fn get_findings_statistics(&self) -> crate::operation::get_findings_statistics::builders::GetFindingsStatisticsFluentBuilder {
17        crate::operation::get_findings_statistics::builders::GetFindingsStatisticsFluentBuilder::new(self.handle.clone())
18    }
19}
aws_sdk_guardduty/client/get_findings_statistics.rs

aws_sdk_guardduty/client/
get_findings_statistics.rs
