Struct aws_sdk_pi::client::fluent_builders::GetResourceMetrics

pub struct GetResourceMetrics { /* private fields */ }

Fluent builder constructing a request to GetResourceMetrics.

Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide specific dimension groups and dimensions, and provide aggregation and filtering criteria for each group.

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

Implementations

impl GetResourceMetrics

pub async fn send(
    self
) -> Result<GetResourceMetricsOutput, SdkError<GetResourceMetricsError>>

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 into_paginator(self) -> GetResourceMetricsPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn service_type(self, input: ServiceType) -> Self

The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:

• RDS

• DOCDB

pub fn set_service_type(self, input: Option<ServiceType>) -> Self

The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:

• RDS

• DOCDB

pub fn identifier(self, input: impl Into<String>) -> Self

An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId.

To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

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

An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId.

To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

pub fn metric_queries(self, input: MetricQuery) -> Self

Appends an item to MetricQueries.

To override the contents of this collection use set_metric_queries.

An array of one or more queries to perform. Each query must specify a Performance Insights metric, and can optionally specify aggregation and filtering criteria.

pub fn set_metric_queries(self, input: Option<Vec<MetricQuery>>) -> Self

An array of one or more queries to perform. Each query must specify a Performance Insights metric, and can optionally specify aggregation and filtering criteria.

pub fn start_time(self, input: DateTime) -> Self

The date and time specifying the beginning of the requested time series query range. You can't specify a StartTime that is earlier than 7 days ago. By default, Performance Insights has 7 days of retention, but you can extend this range up to 2 years. The value specified is inclusive. Thus, the command returns data points equal to or greater than StartTime.

The value for StartTime must be earlier than the value for EndTime.

pub fn set_start_time(self, input: Option<DateTime>) -> Self

The date and time specifying the beginning of the requested time series query range. You can't specify a StartTime that is earlier than 7 days ago. By default, Performance Insights has 7 days of retention, but you can extend this range up to 2 years. The value specified is inclusive. Thus, the command returns data points equal to or greater than StartTime.

The value for StartTime must be earlier than the value for EndTime.

pub fn end_time(self, input: DateTime) -> Self

The date and time specifying the end of the requested time series query range. The value specified is exclusive. Thus, the command returns data points less than (but not equal to) EndTime.

The value for EndTime must be later than the value for StartTime.

pub fn set_end_time(self, input: Option<DateTime>) -> Self

The date and time specifying the end of the requested time series query range. The value specified is exclusive. Thus, the command returns data points less than (but not equal to) EndTime.

The value for EndTime must be later than the value for StartTime.

pub fn period_in_seconds(self, input: i32) -> Self

The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:

• 1 (one second)

• 60 (one minute)

• 300 (five minutes)

• 3600 (one hour)

• 86400 (twenty-four hours)

If you don't specify PeriodInSeconds, then Performance Insights will choose a value for you, with a goal of returning roughly 100-200 data points in the response.

pub fn set_period_in_seconds(self, input: Option<i32>) -> Self

The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:

• 1 (one second)

• 60 (one minute)

• 300 (five minutes)

• 3600 (one hour)

• 86400 (twenty-four hours)

If you don't specify PeriodInSeconds, then Performance Insights will choose a value for you, with a goal of returning roughly 100-200 data points in the response.

pub fn max_results(self, input: i32) -> Self

The maximum number of items to return in the response. If more items exist than the specified MaxRecords value, a pagination token is included in the response so that the remaining results can be retrieved.

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of items to return in the response. If more items exist than the specified MaxRecords value, a pagination token is included in the response so that the remaining results can be retrieved.

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

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.

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

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.

Trait Implementations

impl Clone for GetResourceMetrics

fn clone(&self) -> GetResourceMetrics

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetResourceMetrics

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

Formats the value using the given formatter.