Struct aws_sdk_pi::client::fluent_builders::DescribeDimensionKeys

pub struct DescribeDimensionKeys { /* private fields */ }

Fluent builder constructing a request to DescribeDimensionKeys.

For a specific time period, retrieve the top N dimension keys for a metric.

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 DescribeDimensionKeys

pub async fn send(
    self
) -> Result<DescribeDimensionKeysOutput, SdkError<DescribeDimensionKeysError>>

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

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

• RDS

• DOCDB

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

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 set_identifier(self, input: Option<String>) -> Self

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, input: DateTime) -> Self

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 set_start_time(self, input: Option<DateTime>) -> Self

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, input: DateTime) -> Self

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 set_end_time(self, input: Option<DateTime>) -> Self

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, input: impl Into<String>) -> Self

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 set_metric(self, input: Option<String>) -> Self

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

pub fn group_by(self, input: DimensionGroup) -> Self

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 set_group_by(self, input: Option<DimensionGroup>) -> Self

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, input: impl Into<String>) -> Self

Appends an item to AdditionalMetrics.

To override the contents of this collection use set_additional_metrics.

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" }.

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

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" }.

pub fn partition_by(self, input: DimensionGroup) -> Self

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

pub fn set_partition_by(self, input: Option<DimensionGroup>) -> Self

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

pub fn filter(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to Filter.

To override the contents of this collection use set_filter.

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 set_filter(self, input: Option<HashMap<String, String>>) -> Self

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, 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 DescribeDimensionKeys

fn clone(&self) -> DescribeDimensionKeys

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeDimensionKeys

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

Formats the value using the given formatter.