1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListMetrics`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`namespace(impl Into<String>)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::namespace) / [`set_namespace(Option<String>)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::set_namespace):<br>required: **false**<br><p>The metric namespace to filter against. Only the namespace that matches exactly will be returned.</p><br>
    ///   - [`metric_name(impl Into<String>)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::metric_name) / [`set_metric_name(Option<String>)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::set_metric_name):<br>required: **false**<br><p>The name of the metric to filter against. Only the metrics with names that match exactly will be returned.</p><br>
    ///   - [`dimensions(DimensionFilter)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::dimensions) / [`set_dimensions(Option<Vec::<DimensionFilter>>)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::set_dimensions):<br>required: **false**<br><p>The dimensions to filter against. Only the dimensions that match exactly will be returned.</p><br>
    ///   - [`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>The token returned by a previous call to indicate that there is more data available.</p><br>
    ///   - [`recently_active(RecentlyActive)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::recently_active) / [`set_recently_active(Option<RecentlyActive>)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::set_recently_active):<br>required: **false**<br><p>To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of <code>PT3H</code>. This is the only valid value for this parameter.</p> <p>The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.</p><br>
    ///   - [`include_linked_accounts(bool)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::include_linked_accounts) / [`set_include_linked_accounts(Option<bool>)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::set_include_linked_accounts):<br>required: **false**<br><p>If you are using this operation in a monitoring account, specify <code>true</code> to include metrics from source accounts in the returned data.</p> <p>The default is <code>false</code>.</p><br>
    ///   - [`owning_account(impl Into<String>)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::owning_account) / [`set_owning_account(Option<String>)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::set_owning_account):<br>required: **false**<br><p>When you use this operation in a monitoring account, use this field to return metrics only from one source account. To do so, specify that source account ID in this field, and also specify <code>true</code> for <code>IncludeLinkedAccounts</code>.</p><br>
    /// - On success, responds with [`ListMetricsOutput`](crate::operation::list_metrics::ListMetricsOutput) with field(s):
    ///   - [`metrics(Option<Vec::<Metric>>)`](crate::operation::list_metrics::ListMetricsOutput::metrics): <p>The metrics that match your request.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_metrics::ListMetricsOutput::next_token): <p>The token that marks the start of the next batch of returned results.</p>
    ///   - [`owning_accounts(Option<Vec::<String>>)`](crate::operation::list_metrics::ListMetricsOutput::owning_accounts): <p>If you are using this operation in a monitoring account, this array contains the account IDs of the source accounts where the metrics in the returned data are from.</p> <p>This field is a 1:1 mapping between each metric that is returned and the ID of the owning account.</p>
    /// - On failure, responds with [`SdkError<ListMetricsError>`](crate::operation::list_metrics::ListMetricsError)
    pub fn list_metrics(&self) -> crate::operation::list_metrics::builders::ListMetricsFluentBuilder {
        crate::operation::list_metrics::builders::ListMetricsFluentBuilder::new(self.handle.clone())
    }
}