aws_sdk_resiliencehub/client/
list_metrics.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 [`ListMetrics`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`next_token(impl Into<String>)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::set_next_token):<br>required: **false**<br><p>Null, or the token from a previous call to get the next set of results.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::set_max_results):<br>required: **false**<br><p>Maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p><br>
9    ///   - [`fields(Field)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::fields) / [`set_fields(Option<Vec::<Field>>)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::set_fields):<br>required: **false**<br><p>Indicates the list of fields in the data source.</p><br>
10    ///   - [`data_source(impl Into<String>)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::data_source) / [`set_data_source(Option<String>)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::set_data_source):<br>required: **false**<br><p>Indicates the data source of the metrics.</p><br>
11    ///   - [`conditions(Condition)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::conditions) / [`set_conditions(Option<Vec::<Condition>>)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::set_conditions):<br>required: **false**<br><p>Indicates the list of all the conditions that were applied on the metrics.</p><br>
12    ///   - [`sorts(Sort)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::sorts) / [`set_sorts(Option<Vec::<Sort>>)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::set_sorts):<br>required: **false**<br><p>(Optional) Indicates the order in which you want to sort the fields in the metrics. By default, the fields are sorted in the ascending order.</p><br>
13    /// - On success, responds with [`ListMetricsOutput`](crate::operation::list_metrics::ListMetricsOutput) with field(s):
14    ///   - [`rows(Vec::<Vec::<String>>)`](crate::operation::list_metrics::ListMetricsOutput::rows): <p>Specifies all the list of metric values for each row of metrics.</p>
15    ///   - [`next_token(Option<String>)`](crate::operation::list_metrics::ListMetricsOutput::next_token): <p>Token for the next set of results, or null if there are no more results.</p>
16    /// - On failure, responds with [`SdkError<ListMetricsError>`](crate::operation::list_metrics::ListMetricsError)
17    pub fn list_metrics(&self) -> crate::operation::list_metrics::builders::ListMetricsFluentBuilder {
18        crate::operation::list_metrics::builders::ListMetricsFluentBuilder::new(self.handle.clone())
19    }
20}