aws_sdk_securityhub/client/get_findings_trends_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 [`GetFindingsTrendsV2`](crate::operation::get_findings_trends_v2::builders::GetFindingsTrendsV2FluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_findings_trends_v2::builders::GetFindingsTrendsV2FluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`filters(FindingsTrendsFilters)`](crate::operation::get_findings_trends_v2::builders::GetFindingsTrendsV2FluentBuilder::filters) / [`set_filters(Option<FindingsTrendsFilters>)`](crate::operation::get_findings_trends_v2::builders::GetFindingsTrendsV2FluentBuilder::set_filters):<br>required: **false**<br><p>The filters to apply to the findings trend data.</p><br>
8 /// - [`start_time(DateTime)`](crate::operation::get_findings_trends_v2::builders::GetFindingsTrendsV2FluentBuilder::start_time) / [`set_start_time(Option<DateTime>)`](crate::operation::get_findings_trends_v2::builders::GetFindingsTrendsV2FluentBuilder::set_start_time):<br>required: **true**<br><p>The starting timestamp for the time period to analyze findings trends, in ISO 8601 format.</p><br>
9 /// - [`end_time(DateTime)`](crate::operation::get_findings_trends_v2::builders::GetFindingsTrendsV2FluentBuilder::end_time) / [`set_end_time(Option<DateTime>)`](crate::operation::get_findings_trends_v2::builders::GetFindingsTrendsV2FluentBuilder::set_end_time):<br>required: **true**<br><p>The ending timestamp for the time period to analyze findings trends, in ISO 8601 format.</p><br>
10 /// - [`next_token(impl Into<String>)`](crate::operation::get_findings_trends_v2::builders::GetFindingsTrendsV2FluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_findings_trends_v2::builders::GetFindingsTrendsV2FluentBuilder::set_next_token):<br>required: **false**<br><p>The token to use for paginating results. This value is returned in the response if more results are available.</p><br>
11 /// - [`max_results(i32)`](crate::operation::get_findings_trends_v2::builders::GetFindingsTrendsV2FluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_findings_trends_v2::builders::GetFindingsTrendsV2FluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of trend data points to return in a single response.</p><br>
12 /// - On success, responds with [`GetFindingsTrendsV2Output`](crate::operation::get_findings_trends_v2::GetFindingsTrendsV2Output) with field(s):
13 /// - [`granularity(Option<GranularityField>)`](crate::operation::get_findings_trends_v2::GetFindingsTrendsV2Output::granularity): <p>The time interval granularity for the returned trend data.</p>
14 /// - [`trends_metrics(Option<Vec::<TrendsMetricsResult>>)`](crate::operation::get_findings_trends_v2::GetFindingsTrendsV2Output::trends_metrics): <p>The collection of time-series trend metrics, including counts of findings by severity across the specified time period.</p>
15 /// - [`next_token(Option<String>)`](crate::operation::get_findings_trends_v2::GetFindingsTrendsV2Output::next_token): <p>The token to use for retrieving the next page of results, if more trend data is available.</p>
16 /// - On failure, responds with [`SdkError<GetFindingsTrendsV2Error>`](crate::operation::get_findings_trends_v2::GetFindingsTrendsV2Error)
17 pub fn get_findings_trends_v2(&self) -> crate::operation::get_findings_trends_v2::builders::GetFindingsTrendsV2FluentBuilder {
18 crate::operation::get_findings_trends_v2::builders::GetFindingsTrendsV2FluentBuilder::new(self.handle.clone())
19 }
20}