Struct GetResourceMetricsInput

#[non_exhaustive]
pub struct GetResourceMetricsInput {
    pub service_type: Option<ServiceType>,
    pub identifier: Option<String>,
    pub metric_queries: Option<Vec<MetricQuery>>,
    pub start_time: Option<DateTime>,
    pub end_time: Option<DateTime>,
    pub period_in_seconds: Option<i32>,
    pub max_results: Option<i32>,
    pub next_token: Option<String>,
    pub period_alignment: Option<PeriodAlignment>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

service_type: Option<ServiceType>

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

• RDS

• DOCDB

identifier: Option<String>

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.

metric_queries: Option<Vec<MetricQuery>>

An array of one or more queries to perform. Each query must specify a Performance Insights metric and specify an aggregate function, and you can provide filtering criteria. You must append the aggregate function to the metric. For example, to find the average for the metric db.load you must use db.load.avg. Valid values for aggregate functions include .avg, .min, .max, and .sum.

start_time: Option<DateTime>

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.

end_time: Option<DateTime>

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.

period_in_seconds: Option<i32>

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.

max_results: Option<i32>

The maximum number of items to return in the response.

next_token: Option<String>

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.

period_alignment: Option<PeriodAlignment>

The returned timestamp which is the start or end time of the time periods. The default value is END_TIME.

Implementations

impl GetResourceMetricsInput

pub fn service_type(&self) -> Option<&ServiceType>

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

• RDS

• DOCDB

pub fn identifier(&self) -> Option<&str>

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) -> &[MetricQuery]

An array of one or more queries to perform. Each query must specify a Performance Insights metric and specify an aggregate function, and you can provide filtering criteria. You must append the aggregate function to the metric. For example, to find the average for the metric db.load you must use db.load.avg. Valid values for aggregate functions include .avg, .min, .max, and .sum.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .metric_queries.is_none().

pub fn start_time(&self) -> Option<&DateTime>

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) -> Option<&DateTime>

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) -> Option<i32>

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) -> Option<i32>

The maximum number of items to return in the response.

pub fn next_token(&self) -> Option<&str>

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 period_alignment(&self) -> Option<&PeriodAlignment>

The returned timestamp which is the start or end time of the time periods. The default value is END_TIME.

impl GetResourceMetricsInput

pub fn builder() -> GetResourceMetricsInputBuilder

Creates a new builder-style object to manufacture GetResourceMetricsInput.

Trait Implementations

impl Clone for GetResourceMetricsInput

fn clone(&self) -> GetResourceMetricsInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetResourceMetricsInput

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

Formats the value using the given formatter.

impl PartialEq for GetResourceMetricsInput

fn eq(&self, other: &GetResourceMetricsInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetResourceMetricsInput