aws_sdk_iot/client/get_statistics.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`GetStatistics`](crate::operation::get_statistics::builders::GetStatisticsFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`index_name(impl Into<String>)`](crate::operation::get_statistics::builders::GetStatisticsFluentBuilder::index_name) / [`set_index_name(Option<String>)`](crate::operation::get_statistics::builders::GetStatisticsFluentBuilder::set_index_name):<br>required: **false**<br><p>The name of the index to search. The default value is <code>AWS_Things</code>.</p><br>
7 /// - [`query_string(impl Into<String>)`](crate::operation::get_statistics::builders::GetStatisticsFluentBuilder::query_string) / [`set_query_string(Option<String>)`](crate::operation::get_statistics::builders::GetStatisticsFluentBuilder::set_query_string):<br>required: **true**<br><p>The query used to search. You can specify "*" for the query string to get the count of all indexed things in your Amazon Web Services account.</p><br>
8 /// - [`aggregation_field(impl Into<String>)`](crate::operation::get_statistics::builders::GetStatisticsFluentBuilder::aggregation_field) / [`set_aggregation_field(Option<String>)`](crate::operation::get_statistics::builders::GetStatisticsFluentBuilder::set_aggregation_field):<br>required: **false**<br><p>The aggregation field name.</p><br>
9 /// - [`query_version(impl Into<String>)`](crate::operation::get_statistics::builders::GetStatisticsFluentBuilder::query_version) / [`set_query_version(Option<String>)`](crate::operation::get_statistics::builders::GetStatisticsFluentBuilder::set_query_version):<br>required: **false**<br><p>The version of the query used to search.</p><br>
10 /// - On success, responds with [`GetStatisticsOutput`](crate::operation::get_statistics::GetStatisticsOutput) with field(s):
11 /// - [`statistics(Option<Statistics>)`](crate::operation::get_statistics::GetStatisticsOutput::statistics): <p>The statistics returned by the Fleet Indexing service based on the query and aggregation field.</p>
12 /// - On failure, responds with [`SdkError<GetStatisticsError>`](crate::operation::get_statistics::GetStatisticsError)
13 pub fn get_statistics(&self) -> crate::operation::get_statistics::builders::GetStatisticsFluentBuilder {
14 crate::operation::get_statistics::builders::GetStatisticsFluentBuilder::new(self.handle.clone())
15 }
16}