aws_sdk_connect/client/
search_metrics.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 [`SearchMetrics`](crate::operation::search_metrics::builders::SearchMetricsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::search_metrics::builders::SearchMetricsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`instance_id(impl Into<String>)`](crate::operation::search_metrics::builders::SearchMetricsFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::search_metrics::builders::SearchMetricsFluentBuilder::set_instance_id):<br>required: **true**<br><p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::search_metrics::builders::SearchMetricsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::search_metrics::builders::SearchMetricsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::search_metrics::builders::SearchMetricsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::search_metrics::builders::SearchMetricsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per page.</p><br>
10    ///   - [`search_filter(MetricSearchFilter)`](crate::operation::search_metrics::builders::SearchMetricsFluentBuilder::search_filter) / [`set_search_filter(Option<MetricSearchFilter>)`](crate::operation::search_metrics::builders::SearchMetricsFluentBuilder::set_search_filter):<br>required: **false**<br><p>Filters to be applied to search results.</p><br>
11    ///   - [`search_criteria(MetricSearchCriteria)`](crate::operation::search_metrics::builders::SearchMetricsFluentBuilder::search_criteria) / [`set_search_criteria(Option<MetricSearchCriteria>)`](crate::operation::search_metrics::builders::SearchMetricsFluentBuilder::set_search_criteria):<br>required: **false**<br><p>The search criteria to filter the metrics.</p><br>
12    /// - On success, responds with [`SearchMetricsOutput`](crate::operation::search_metrics::SearchMetricsOutput) with field(s):
13    ///   - [`metrics(Option<Vec::<MetricDefinition>>)`](crate::operation::search_metrics::SearchMetricsOutput::metrics): <p>The metrics that matched the search criteria.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::search_metrics::SearchMetricsOutput::next_token): <p>If there are additional results, this is the token for the next set of results.</p>
15    ///   - [`approximate_total_count(Option<i64>)`](crate::operation::search_metrics::SearchMetricsOutput::approximate_total_count): <p>The approximate total number of metrics that matched your search criteria.</p>
16    /// - On failure, responds with [`SdkError<SearchMetricsError>`](crate::operation::search_metrics::SearchMetricsError)
17    pub fn search_metrics(&self) -> crate::operation::search_metrics::builders::SearchMetricsFluentBuilder {
18        crate::operation::search_metrics::builders::SearchMetricsFluentBuilder::new(self.handle.clone())
19    }
20}
aws_sdk_connect/client/search_metrics.rs

aws_sdk_connect/client/
search_metrics.rs
