1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListUtteranceAnalyticsData`](crate::operation::list_utterance_analytics_data::builders::ListUtteranceAnalyticsDataFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_utterance_analytics_data::builders::ListUtteranceAnalyticsDataFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`bot_id(impl Into<String>)`](crate::operation::list_utterance_analytics_data::builders::ListUtteranceAnalyticsDataFluentBuilder::bot_id) / [`set_bot_id(Option<String>)`](crate::operation::list_utterance_analytics_data::builders::ListUtteranceAnalyticsDataFluentBuilder::set_bot_id):<br>required: **true**<br><p>The identifier for the bot for which you want to retrieve utterance analytics.</p><br>
    ///   - [`start_date_time(DateTime)`](crate::operation::list_utterance_analytics_data::builders::ListUtteranceAnalyticsDataFluentBuilder::start_date_time) / [`set_start_date_time(Option<DateTime>)`](crate::operation::list_utterance_analytics_data::builders::ListUtteranceAnalyticsDataFluentBuilder::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 analytics.</p><br>
    ///   - [`end_date_time(DateTime)`](crate::operation::list_utterance_analytics_data::builders::ListUtteranceAnalyticsDataFluentBuilder::end_date_time) / [`set_end_date_time(Option<DateTime>)`](crate::operation::list_utterance_analytics_data::builders::ListUtteranceAnalyticsDataFluentBuilder::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 analytics.</p><br>
    ///   - [`sort_by(UtteranceDataSortBy)`](crate::operation::list_utterance_analytics_data::builders::ListUtteranceAnalyticsDataFluentBuilder::sort_by) / [`set_sort_by(Option<UtteranceDataSortBy>)`](crate::operation::list_utterance_analytics_data::builders::ListUtteranceAnalyticsDataFluentBuilder::set_sort_by):<br>required: **false**<br><p>An object specifying the measure and method by which to sort the utterance analytics data.</p><br>
    ///   - [`filters(AnalyticsUtteranceFilter)`](crate::operation::list_utterance_analytics_data::builders::ListUtteranceAnalyticsDataFluentBuilder::filters) / [`set_filters(Option<Vec::<AnalyticsUtteranceFilter>>)`](crate::operation::list_utterance_analytics_data::builders::ListUtteranceAnalyticsDataFluentBuilder::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_analytics_data::builders::ListUtteranceAnalyticsDataFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_utterance_analytics_data::builders::ListUtteranceAnalyticsDataFluentBuilder::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_analytics_data::builders::ListUtteranceAnalyticsDataFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_utterance_analytics_data::builders::ListUtteranceAnalyticsDataFluentBuilder::set_next_token):<br>required: **false**<br><p>If the response from the ListUtteranceAnalyticsData 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 ListUtteranceAnalyticsData request to return the next page of results. For a complete set of results, call the ListUtteranceAnalyticsData operation until the nextToken returned in the response is null.</p><br>
    /// - On success, responds with [`ListUtteranceAnalyticsDataOutput`](crate::operation::list_utterance_analytics_data::ListUtteranceAnalyticsDataOutput) with field(s):
    ///   - [`bot_id(Option<String>)`](crate::operation::list_utterance_analytics_data::ListUtteranceAnalyticsDataOutput::bot_id): <p>The unique identifier of the bot that the utterances belong to.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_utterance_analytics_data::ListUtteranceAnalyticsDataOutput::next_token): <p>If the response from the ListUtteranceAnalyticsData 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 ListUtteranceAnalyticsData request to return the next page of results. For a complete set of results, call the ListUtteranceAnalyticsData operation until the nextToken returned in the response is null.</p>
    ///   - [`utterances(Option<Vec::<UtteranceSpecification>>)`](crate::operation::list_utterance_analytics_data::ListUtteranceAnalyticsDataOutput::utterances): <p>A list of objects, each of which contains information about an utterance in a user session with your bot.</p>
    /// - On failure, responds with [`SdkError<ListUtteranceAnalyticsDataError>`](crate::operation::list_utterance_analytics_data::ListUtteranceAnalyticsDataError)
    pub fn list_utterance_analytics_data(
        &self,
    ) -> crate::operation::list_utterance_analytics_data::builders::ListUtteranceAnalyticsDataFluentBuilder {
        crate::operation::list_utterance_analytics_data::builders::ListUtteranceAnalyticsDataFluentBuilder::new(self.handle.clone())
    }
}