aws_sdk_codeguruprofiler/client/

list_findings_reports.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListFindingsReports`](crate::operation::list_findings_reports::builders::ListFindingsReportsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_findings_reports::builders::ListFindingsReportsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`profiling_group_name(impl Into<String>)`](crate::operation::list_findings_reports::builders::ListFindingsReportsFluentBuilder::profiling_group_name) / [`set_profiling_group_name(Option<String>)`](crate::operation::list_findings_reports::builders::ListFindingsReportsFluentBuilder::set_profiling_group_name):<br>required: **true**<br><p>The name of the profiling group from which to search for analysis data.</p><br>
    ///   - [`start_time(DateTime)`](crate::operation::list_findings_reports::builders::ListFindingsReportsFluentBuilder::start_time) / [`set_start_time(Option<DateTime>)`](crate::operation::list_findings_reports::builders::ListFindingsReportsFluentBuilder::set_start_time):<br>required: **true**<br><p>The start time of the profile to get analysis data about. You must specify <code>startTime</code> and <code>endTime</code>. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.</p><br>
    ///   - [`end_time(DateTime)`](crate::operation::list_findings_reports::builders::ListFindingsReportsFluentBuilder::end_time) / [`set_end_time(Option<DateTime>)`](crate::operation::list_findings_reports::builders::ListFindingsReportsFluentBuilder::set_end_time):<br>required: **true**<br><p>The end time of the profile to get analysis data about. You must specify <code>startTime</code> and <code>endTime</code>. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_findings_reports::builders::ListFindingsReportsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_findings_reports::builders::ListFindingsReportsFluentBuilder::set_next_token):<br>required: **false**<br><p>The <code>nextToken</code> value returned from a previous paginated <code>ListFindingsReportsRequest</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value.</p><note>  <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note><br>
    ///   - [`max_results(i32)`](crate::operation::list_findings_reports::builders::ListFindingsReportsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_findings_reports::builders::ListFindingsReportsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of report results returned by <code>ListFindingsReports</code> in paginated output. When this parameter is used, <code>ListFindingsReports</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListFindingsReports</code> request with the returned <code>nextToken</code> value.</p><br>
    ///   - [`daily_reports_only(bool)`](crate::operation::list_findings_reports::builders::ListFindingsReportsFluentBuilder::daily_reports_only) / [`set_daily_reports_only(Option<bool>)`](crate::operation::list_findings_reports::builders::ListFindingsReportsFluentBuilder::set_daily_reports_only):<br>required: **false**<br><p>A <code>Boolean</code> value indicating whether to only return reports from daily profiles. If set to <code>True</code>, only analysis data from daily profiles is returned. If set to <code>False</code>, analysis data is returned from smaller time windows (for example, one hour).</p><br>
    /// - On success, responds with [`ListFindingsReportsOutput`](crate::operation::list_findings_reports::ListFindingsReportsOutput) with field(s):
    ///   - [`findings_report_summaries(Vec::<FindingsReportSummary>)`](crate::operation::list_findings_reports::ListFindingsReportsOutput::findings_report_summaries): <p>The list of analysis results summaries.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_findings_reports::ListFindingsReportsOutput::next_token): <p>The <code>nextToken</code> value to include in a future <code>ListFindingsReports</code> request. When the results of a <code>ListFindingsReports</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
    /// - On failure, responds with [`SdkError<ListFindingsReportsError>`](crate::operation::list_findings_reports::ListFindingsReportsError)
    pub fn list_findings_reports(&self) -> crate::operation::list_findings_reports::builders::ListFindingsReportsFluentBuilder {
        crate::operation::list_findings_reports::builders::ListFindingsReportsFluentBuilder::new(self.handle.clone())
    }
}