aws_sdk_securityhub/client/
get_findings_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 [`GetFindingsV2`](crate::operation::get_findings_v2::builders::GetFindingsV2FluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_findings_v2::builders::GetFindingsV2FluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`filters(OcsfFindingFilters)`](crate::operation::get_findings_v2::builders::GetFindingsV2FluentBuilder::filters) / [`set_filters(Option<OcsfFindingFilters>)`](crate::operation::get_findings_v2::builders::GetFindingsV2FluentBuilder::set_filters):<br>required: **false**<br><p>The finding attributes used to define a condition to filter the returned OCSF findings. You can filter up to 10 composite filters. For each filter type inside of a composite filter, you can provide up to 20 filters.</p><br>
8    ///   - [`sort_criteria(SortCriterion)`](crate::operation::get_findings_v2::builders::GetFindingsV2FluentBuilder::sort_criteria) / [`set_sort_criteria(Option<Vec::<SortCriterion>>)`](crate::operation::get_findings_v2::builders::GetFindingsV2FluentBuilder::set_sort_criteria):<br>required: **false**<br><p>The finding attributes used to sort the list of returned findings.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::get_findings_v2::builders::GetFindingsV2FluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_findings_v2::builders::GetFindingsV2FluentBuilder::set_next_token):<br>required: **false**<br><p>The token required for pagination. On your first call, set the value of this parameter to <code>NULL</code>. For subsequent calls, to continue listing data, set the value of this parameter to the value returned in the previous response.</p><br>
10    ///   - [`max_results(i32)`](crate::operation::get_findings_v2::builders::GetFindingsV2FluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_findings_v2::builders::GetFindingsV2FluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return.</p><br>
11    /// - On success, responds with [`GetFindingsV2Output`](crate::operation::get_findings_v2::GetFindingsV2Output) with field(s):
12    ///   - [`findings(Option<Vec::<Document>>)`](crate::operation::get_findings_v2::GetFindingsV2Output::findings): <p>An array of security findings returned by the operation.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::get_findings_v2::GetFindingsV2Output::next_token): <p>The pagination token to use to request the next page of results. Otherwise, this parameter is null.</p>
14    /// - On failure, responds with [`SdkError<GetFindingsV2Error>`](crate::operation::get_findings_v2::GetFindingsV2Error)
15    pub fn get_findings_v2(&self) -> crate::operation::get_findings_v2::builders::GetFindingsV2FluentBuilder {
16        crate::operation::get_findings_v2::builders::GetFindingsV2FluentBuilder::new(self.handle.clone())
17    }
18}