aws_sdk_codegurusecurity/client/

list_findings_metrics.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListFindingsMetrics`](crate::operation::list_findings_metrics::builders::ListFindingsMetricsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_findings_metrics::builders::ListFindingsMetricsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_findings_metrics::builders::ListFindingsMetricsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_findings_metrics::builders::ListFindingsMetricsFluentBuilder::set_next_token):<br>required: **false**<br><p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the <code>nextToken</code> value returned from the previous request to continue listing results after the first page.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_findings_metrics::builders::ListFindingsMetricsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_findings_metrics::builders::ListFindingsMetricsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the <code>nextToken</code> element is returned in the response. Use <code>nextToken</code> in a subsequent request to retrieve additional results. If not specified, returns 1000 results.</p><br>
    ///   - [`start_date(DateTime)`](crate::operation::list_findings_metrics::builders::ListFindingsMetricsFluentBuilder::start_date) / [`set_start_date(Option<DateTime>)`](crate::operation::list_findings_metrics::builders::ListFindingsMetricsFluentBuilder::set_start_date):<br>required: **true**<br><p>The start date of the interval which you want to retrieve metrics from. Rounds to the nearest day.</p><br>
    ///   - [`end_date(DateTime)`](crate::operation::list_findings_metrics::builders::ListFindingsMetricsFluentBuilder::end_date) / [`set_end_date(Option<DateTime>)`](crate::operation::list_findings_metrics::builders::ListFindingsMetricsFluentBuilder::set_end_date):<br>required: **true**<br><p>The end date of the interval which you want to retrieve metrics from. Round to the nearest day.</p><br>
    /// - On success, responds with [`ListFindingsMetricsOutput`](crate::operation::list_findings_metrics::ListFindingsMetricsOutput) with field(s):
    ///   - [`findings_metrics(Option<Vec::<AccountFindingsMetric>>)`](crate::operation::list_findings_metrics::ListFindingsMetricsOutput::findings_metrics): <p>A list of <code>AccountFindingsMetric</code> objects retrieved from the specified time interval.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_findings_metrics::ListFindingsMetricsOutput::next_token): <p>A pagination token. You can use this in future calls to <code>ListFindingMetrics</code> to continue listing results after the current page.</p>
    /// - On failure, responds with [`SdkError<ListFindingsMetricsError>`](crate::operation::list_findings_metrics::ListFindingsMetricsError)
    pub fn list_findings_metrics(&self) -> crate::operation::list_findings_metrics::builders::ListFindingsMetricsFluentBuilder {
        crate::operation::list_findings_metrics::builders::ListFindingsMetricsFluentBuilder::new(self.handle.clone())
    }
}