Struct aws_sdk_iot::client::fluent_builders::GetPercentiles

pub struct GetPercentiles { /* private fields */ }

Fluent builder constructing a request to GetPercentiles.

Groups the aggregated values that match the query into percentile groupings. The default percentile groupings are: 1,5,25,50,75,95,99, although you can specify your own when you call GetPercentiles. This function returns a value for each percentile group specified (or the default percentile groupings). The percentile group "1" contains the aggregated field value that occurs in approximately one percent of the values that match the query. The percentile group "5" contains the aggregated field value that occurs in approximately five percent of the values that match the query, and so on. The result is an approximation, the more values that match the query, the more accurate the percentile values.

Requires permission to access the GetPercentiles action.

Implementations

impl GetPercentiles

pub async fn customize(
    self
) -> Result<CustomizableOperation<GetPercentiles, AwsResponseRetryClassifier>, SdkError<GetPercentilesError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<GetPercentilesOutput, SdkError<GetPercentilesError>>

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

The name of the index to search.

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

The name of the index to search.

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

The search query string.

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

The search query string.

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

The field to aggregate.

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

The field to aggregate.

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

The query version.

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

The query version.

pub fn percents(self, input: f64) -> Self

Appends an item to percents.

To override the contents of this collection use set_percents.

The percentile groups returned.

pub fn set_percents(self, input: Option<Vec<f64>>) -> Self

The percentile groups returned.

Trait Implementations

impl Clone for GetPercentiles

fn clone(&self) -> GetPercentiles

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetPercentiles

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

Formats the value using the given formatter.