1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListUtteranceMetrics`](crate::operation::list_utterance_metrics::builders::ListUtteranceMetricsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_utterance_metrics::builders::ListUtteranceMetricsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`bot_id(impl Into<String>)`](crate::operation::list_utterance_metrics::builders::ListUtteranceMetricsFluentBuilder::bot_id) / [`set_bot_id(Option<String>)`](crate::operation::list_utterance_metrics::builders::ListUtteranceMetricsFluentBuilder::set_bot_id):<br>required: **true**<br><p>The identifier for the bot for which you want to retrieve utterance metrics.</p><br>
    ///   - [`start_date_time(DateTime)`](crate::operation::list_utterance_metrics::builders::ListUtteranceMetricsFluentBuilder::start_date_time) / [`set_start_date_time(Option<DateTime>)`](crate::operation::list_utterance_metrics::builders::ListUtteranceMetricsFluentBuilder::set_start_date_time):<br>required: **true**<br><p>The date and time that marks the beginning of the range of time for which you want to see utterance metrics.</p><br>
    ///   - [`end_date_time(DateTime)`](crate::operation::list_utterance_metrics::builders::ListUtteranceMetricsFluentBuilder::end_date_time) / [`set_end_date_time(Option<DateTime>)`](crate::operation::list_utterance_metrics::builders::ListUtteranceMetricsFluentBuilder::set_end_date_time):<br>required: **true**<br><p>The date and time that marks the end of the range of time for which you want to see utterance metrics.</p><br>
    ///   - [`metrics(AnalyticsUtteranceMetric)`](crate::operation::list_utterance_metrics::builders::ListUtteranceMetricsFluentBuilder::metrics) / [`set_metrics(Option<Vec::<AnalyticsUtteranceMetric>>)`](crate::operation::list_utterance_metrics::builders::ListUtteranceMetricsFluentBuilder::set_metrics):<br>required: **true**<br><p>A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.</p><br>
    ///   - [`bin_by(AnalyticsBinBySpecification)`](crate::operation::list_utterance_metrics::builders::ListUtteranceMetricsFluentBuilder::bin_by) / [`set_bin_by(Option<Vec::<AnalyticsBinBySpecification>>)`](crate::operation::list_utterance_metrics::builders::ListUtteranceMetricsFluentBuilder::set_bin_by):<br>required: **false**<br><p>A list of objects, each of which contains specifications for organizing the results by time.</p><br>
    ///   - [`group_by(AnalyticsUtteranceGroupBySpecification)`](crate::operation::list_utterance_metrics::builders::ListUtteranceMetricsFluentBuilder::group_by) / [`set_group_by(Option<Vec::<AnalyticsUtteranceGroupBySpecification>>)`](crate::operation::list_utterance_metrics::builders::ListUtteranceMetricsFluentBuilder::set_group_by):<br>required: **false**<br><p>A list of objects, each of which specifies how to group the results. You can group by the following criteria:</p> <ul>  <li>   <p><code>UtteranceText</code> – The transcription of the utterance.</p></li>  <li>   <p><code>UtteranceState</code> – The state of the utterance. The possible states are detailed in <a href="https://docs.aws.amazon.com/analytics-key-definitions-utterances">Key definitions</a> in the user guide.</p></li> </ul><br>
    ///   - [`attributes(AnalyticsUtteranceAttribute)`](crate::operation::list_utterance_metrics::builders::ListUtteranceMetricsFluentBuilder::attributes) / [`set_attributes(Option<Vec::<AnalyticsUtteranceAttribute>>)`](crate::operation::list_utterance_metrics::builders::ListUtteranceMetricsFluentBuilder::set_attributes):<br>required: **false**<br><p>A list containing attributes related to the utterance that you want the response to return. The following attributes are possible:</p> <ul>  <li>   <p><code>LastUsedIntent</code> – The last used intent at the time of the utterance.</p></li> </ul><br>
    ///   - [`filters(AnalyticsUtteranceFilter)`](crate::operation::list_utterance_metrics::builders::ListUtteranceMetricsFluentBuilder::filters) / [`set_filters(Option<Vec::<AnalyticsUtteranceFilter>>)`](crate::operation::list_utterance_metrics::builders::ListUtteranceMetricsFluentBuilder::set_filters):<br>required: **false**<br><p>A list of objects, each of which describes a condition by which you want to filter the results.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_utterance_metrics::builders::ListUtteranceMetricsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_utterance_metrics::builders::ListUtteranceMetricsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_utterance_metrics::builders::ListUtteranceMetricsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_utterance_metrics::builders::ListUtteranceMetricsFluentBuilder::set_next_token):<br>required: **false**<br><p>If the response from the ListUtteranceMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.</p> <p>Use the returned token in the nextToken parameter of a ListUtteranceMetrics request to return the next page of results. For a complete set of results, call the ListUtteranceMetrics operation until the nextToken returned in the response is null.</p><br>
    /// - On success, responds with [`ListUtteranceMetricsOutput`](crate::operation::list_utterance_metrics::ListUtteranceMetricsOutput) with field(s):
    ///   - [`bot_id(Option<String>)`](crate::operation::list_utterance_metrics::ListUtteranceMetricsOutput::bot_id): <p>The identifier for the bot for which you retrieved utterance metrics.</p>
    ///   - [`results(Option<Vec::<AnalyticsUtteranceResult>>)`](crate::operation::list_utterance_metrics::ListUtteranceMetricsOutput::results): <p>The results for the utterance metrics.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_utterance_metrics::ListUtteranceMetricsOutput::next_token): <p>If the response from the ListUtteranceMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.</p> <p>Use the returned token in the nextToken parameter of a ListUtteranceMetrics request to return the next page of results. For a complete set of results, call the ListUtteranceMetrics operation until the nextToken returned in the response is null.</p>
    /// - On failure, responds with [`SdkError<ListUtteranceMetricsError>`](crate::operation::list_utterance_metrics::ListUtteranceMetricsError)
    pub fn list_utterance_metrics(&self) -> crate::operation::list_utterance_metrics::builders::ListUtteranceMetricsFluentBuilder {
        crate::operation::list_utterance_metrics::builders::ListUtteranceMetricsFluentBuilder::new(self.handle.clone())
    }
}