Struct aws_sdk_pi::client::fluent_builders::GetResourceMetrics

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

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<C, M, R> GetResourceMetrics<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<GetResourceMetricsOutput, SdkError<GetResourceMetricsError>> where
    R::Policy: SmithyRetryPolicy<GetResourceMetricsInputOperationOutputAlias, GetResourceMetricsOutput, GetResourceMetricsError, GetResourceMetricsInputOperationRetryAlias>, 

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 service_type(self, inp: ServiceType) -> Self

The AWS service for which Performance Insights returns metrics. The only valid value for ServiceType is RDS.

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

The AWS service for which Performance Insights returns metrics. The only valid value for ServiceType is RDS.

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

An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.

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

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

An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.

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

pub fn metric_queries(self, inp: impl Into<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, inp: Instant) -> Self

The date and time specifying the beginning of the requested time series data. You can't specify a StartTime that's earlier than 7 days ago. The value specified is inclusive - data points equal to or greater than StartTime will be returned.

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

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

The date and time specifying the beginning of the requested time series data. You can't specify a StartTime that's earlier than 7 days ago. The value specified is inclusive - data points equal to or greater than StartTime will be returned.

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

pub fn end_time(self, inp: Instant) -> Self

The date and time specifying the end of the requested time series data. The value specified is exclusive - data points less than (but not equal to) EndTime will be returned.

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

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

The date and time specifying the end of the requested time series data. The value specified is exclusive - data points less than (but not equal to) EndTime will be returned.

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

pub fn period_in_seconds(self, inp: 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, inp: 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, inp: 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<C: Debug, M: Debug, R: Debug> Debug for GetResourceMetrics<C, M, R>

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

Formats the value using the given formatter.