Struct aws_sdk_cloudwatch::client::fluent_builders::ListMetrics

pub struct ListMetrics<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to ListMetrics.

List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to obtain statistical data.

Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.

After you create a metric, allow up to 15 minutes before the metric appears. You can see statistics about the metric sooner by using GetMetricData or GetMetricStatistics.

ListMetrics doesn't return information about metrics if those metrics haven't reported data in the past two weeks. To retrieve those metrics, use GetMetricData or GetMetricStatistics.

Implementations

impl<C, M, R> ListMetrics<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(self) -> Result<ListMetricsOutput, SdkError<ListMetricsError>> where
    R::Policy: SmithyRetryPolicy<ListMetricsInputOperationOutputAlias, ListMetricsOutput, ListMetricsError, ListMetricsInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn namespace(self, inp: impl Into<String>) -> Self

The metric namespace to filter against. Only the namespace that matches exactly will be returned.

pub fn set_namespace(self, input: Option<String>) -> Self

The metric namespace to filter against. Only the namespace that matches exactly will be returned.

pub fn metric_name(self, inp: impl Into<String>) -> Self

The name of the metric to filter against. Only the metrics with names that match exactly will be returned.

pub fn set_metric_name(self, input: Option<String>) -> Self

The name of the metric to filter against. Only the metrics with names that match exactly will be returned.

pub fn dimensions(self, inp: impl Into<DimensionFilter>) -> Self

Appends an item to Dimensions.

To override the contents of this collection use set_dimensions.

The dimensions to filter against. Only the dimensions that match exactly will be returned.

pub fn set_dimensions(self, input: Option<Vec<DimensionFilter>>) -> Self

The dimensions to filter against. Only the dimensions that match exactly will be returned.

pub fn next_token(self, inp: impl Into<String>) -> Self

The token returned by a previous call to indicate that there is more data available.

pub fn set_next_token(self, input: Option<String>) -> Self

The token returned by a previous call to indicate that there is more data available.

pub fn recently_active(self, inp: RecentlyActive) -> Self

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 PT3H. This is the only valid value for this parameter.

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.

pub fn set_recently_active(self, input: Option<RecentlyActive>) -> Self

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 PT3H. This is the only valid value for this parameter.

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.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for ListMetrics<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.