Struct aws_sdk_pi::operation::describe_dimension_keys::DescribeDimensionKeysInput

#[non_exhaustive]
pub struct DescribeDimensionKeysInput {
    pub service_type: Option<ServiceType>,
    pub identifier: Option<String>,
    pub start_time: Option<DateTime>,
    pub end_time: Option<DateTime>,
    pub metric: Option<String>,
    pub period_in_seconds: Option<i32>,
    pub group_by: Option<DimensionGroup>,
    pub additional_metrics: Option<Vec<String>>,
    pub partition_by: Option<DimensionGroup>,
    pub filter: Option<HashMap<String, String>>,
    pub max_results: Option<i32>,
    pub next_token: Option<String>,
}

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 will return metrics. Valid values are as follows:

• RDS

• DOCDB

identifier: Option<String>

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

To use an Amazon RDS instance as a data source, you specify its DbiResourceId value. For example, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A.

start_time: Option<DateTime>

The date and time specifying the beginning of the requested time series data. You must specify a StartTime within the past 7 days. The value specified is inclusive, which means that data points equal to or greater than StartTime are returned.

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 data. The value specified is exclusive, which means that data points less than (but not equal to) EndTime are returned.

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

metric: Option<String>

The name of a Performance Insights metric to be measured.

Valid values for Metric are:

• db.load.avg - A scaled representation of the number of active sessions for the database engine.

• db.sampledload.avg - The raw number of active sessions for the database engine.

If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

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 chooses a value for you, with a goal of returning roughly 100-200 data points in the response.

group_by: Option<DimensionGroup>

A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights returns all dimensions within this group, unless you provide the names of specific dimensions within this group. You can also request that Performance Insights return a limited number of values for a dimension.

additional_metrics: Option<Vec<String>>

Additional metrics for the top N dimension keys. If the specified dimension group in the GroupBy parameter is db.sql_tokenized, you can specify per-SQL metrics to get the values for the top N SQL digests. The response syntax is as follows: "AdditionalMetrics" : { "string" : "string" }.

partition_by: Option<DimensionGroup>

For each dimension specified in GroupBy, specify a secondary dimension to further subdivide the partition keys in the response.

filter: Option<HashMap<String, String>>

One or more filters to apply in the request. Restrictions:

• Any number of filters by the same dimension, as specified in the GroupBy or Partition parameters.

• A single filter for any other dimension in this dimension group.

max_results: Option<i32>

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.

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.

Implementations

impl DescribeDimensionKeysInput

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

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

• RDS

• DOCDB

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

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

To use an Amazon RDS instance as a data source, you specify its DbiResourceId value. For example, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A.

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

The date and time specifying the beginning of the requested time series data. You must specify a StartTime within the past 7 days. The value specified is inclusive, which means that data points equal to or greater than StartTime are returned.

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 data. The value specified is exclusive, which means that data points less than (but not equal to) EndTime are returned.

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

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

The name of a Performance Insights metric to be measured.

Valid values for Metric are:

• db.load.avg - A scaled representation of the number of active sessions for the database engine.

• db.sampledload.avg - The raw number of active sessions for the database engine.

If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

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 chooses a value for you, with a goal of returning roughly 100-200 data points in the response.

pub fn group_by(&self) -> Option<&DimensionGroup>

A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights returns all dimensions within this group, unless you provide the names of specific dimensions within this group. You can also request that Performance Insights return a limited number of values for a dimension.

pub fn additional_metrics(&self) -> &[String]

Additional metrics for the top N dimension keys. If the specified dimension group in the GroupBy parameter is db.sql_tokenized, you can specify per-SQL metrics to get the values for the top N SQL digests. The response syntax is as follows: "AdditionalMetrics" : { "string" : "string" }.

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

pub fn partition_by(&self) -> Option<&DimensionGroup>

For each dimension specified in GroupBy, specify a secondary dimension to further subdivide the partition keys in the response.

pub fn filter(&self) -> Option<&HashMap<String, String>>

One or more filters to apply in the request. Restrictions:

• Any number of filters by the same dimension, as specified in the GroupBy or Partition parameters.

• A single filter for any other dimension in this dimension group.

pub fn max_results(&self) -> Option<i32>

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) -> 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.

impl DescribeDimensionKeysInput

pub fn builder() -> DescribeDimensionKeysInputBuilder

Creates a new builder-style object to manufacture DescribeDimensionKeysInput.

Trait Implementations

impl Clone for DescribeDimensionKeysInput

fn clone(&self) -> DescribeDimensionKeysInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeDimensionKeysInput

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

Formats the value using the given formatter.

impl PartialEq for DescribeDimensionKeysInput

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for DescribeDimensionKeysInput