aws_sdk_macie2/client/
get_finding_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 [`GetFindingStatistics`](crate::operation::get_finding_statistics::builders::GetFindingStatisticsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`finding_criteria(FindingCriteria)`](crate::operation::get_finding_statistics::builders::GetFindingStatisticsFluentBuilder::finding_criteria) / [`set_finding_criteria(Option<FindingCriteria>)`](crate::operation::get_finding_statistics::builders::GetFindingStatisticsFluentBuilder::set_finding_criteria):<br>required: **false**<br><p>The criteria to use to filter the query results.</p><br>
7    ///   - [`group_by(GroupBy)`](crate::operation::get_finding_statistics::builders::GetFindingStatisticsFluentBuilder::group_by) / [`set_group_by(Option<GroupBy>)`](crate::operation::get_finding_statistics::builders::GetFindingStatisticsFluentBuilder::set_group_by):<br>required: **true**<br><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><br>
8    ///   - [`size(i32)`](crate::operation::get_finding_statistics::builders::GetFindingStatisticsFluentBuilder::size) / [`set_size(Option<i32>)`](crate::operation::get_finding_statistics::builders::GetFindingStatisticsFluentBuilder::set_size):<br>required: **false**<br><p>The maximum number of items to include in each page of the response.</p><br>
9    ///   - [`sort_criteria(FindingStatisticsSortCriteria)`](crate::operation::get_finding_statistics::builders::GetFindingStatisticsFluentBuilder::sort_criteria) / [`set_sort_criteria(Option<FindingStatisticsSortCriteria>)`](crate::operation::get_finding_statistics::builders::GetFindingStatisticsFluentBuilder::set_sort_criteria):<br>required: **false**<br><p>The criteria to use to sort the query results.</p><br>
10    /// - On success, responds with [`GetFindingStatisticsOutput`](crate::operation::get_finding_statistics::GetFindingStatisticsOutput) with field(s):
11    ///   - [`counts_by_group(Option<Vec::<GroupCount>>)`](crate::operation::get_finding_statistics::GetFindingStatisticsOutput::counts_by_group): <p>An array of objects, one for each group of findings that matches the filter criteria specified in the request.</p>
12    /// - On failure, responds with [`SdkError<GetFindingStatisticsError>`](crate::operation::get_finding_statistics::GetFindingStatisticsError)
13    pub fn get_finding_statistics(&self) -> crate::operation::get_finding_statistics::builders::GetFindingStatisticsFluentBuilder {
14        crate::operation::get_finding_statistics::builders::GetFindingStatisticsFluentBuilder::new(self.handle.clone())
15    }
16}