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
26
27
28
29
30
31
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListAggregatedUtterances`](crate::operation::list_aggregated_utterances::builders::ListAggregatedUtterancesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_aggregated_utterances::builders::ListAggregatedUtterancesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`bot_id(impl Into<String>)`](crate::operation::list_aggregated_utterances::builders::ListAggregatedUtterancesFluentBuilder::bot_id) / [`set_bot_id(Option<String>)`](crate::operation::list_aggregated_utterances::builders::ListAggregatedUtterancesFluentBuilder::set_bot_id):<br>required: **true**<br><p>The unique identifier of the bot associated with this request.</p><br>
    ///   - [`bot_alias_id(impl Into<String>)`](crate::operation::list_aggregated_utterances::builders::ListAggregatedUtterancesFluentBuilder::bot_alias_id) / [`set_bot_alias_id(Option<String>)`](crate::operation::list_aggregated_utterances::builders::ListAggregatedUtterancesFluentBuilder::set_bot_alias_id):<br>required: **false**<br><p>The identifier of the bot alias associated with this request. If you specify the bot alias, you can't specify the bot version.</p><br>
    ///   - [`bot_version(impl Into<String>)`](crate::operation::list_aggregated_utterances::builders::ListAggregatedUtterancesFluentBuilder::bot_version) / [`set_bot_version(Option<String>)`](crate::operation::list_aggregated_utterances::builders::ListAggregatedUtterancesFluentBuilder::set_bot_version):<br>required: **false**<br><p>The identifier of the bot version associated with this request. If you specify the bot version, you can't specify the bot alias.</p><br>
    ///   - [`locale_id(impl Into<String>)`](crate::operation::list_aggregated_utterances::builders::ListAggregatedUtterancesFluentBuilder::locale_id) / [`set_locale_id(Option<String>)`](crate::operation::list_aggregated_utterances::builders::ListAggregatedUtterancesFluentBuilder::set_locale_id):<br>required: **true**<br><p>The identifier of the language and locale where the utterances were collected. For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.</p><br>
    ///   - [`aggregation_duration(UtteranceAggregationDuration)`](crate::operation::list_aggregated_utterances::builders::ListAggregatedUtterancesFluentBuilder::aggregation_duration) / [`set_aggregation_duration(Option<UtteranceAggregationDuration>)`](crate::operation::list_aggregated_utterances::builders::ListAggregatedUtterancesFluentBuilder::set_aggregation_duration):<br>required: **true**<br><p>The time window for aggregating the utterance information. You can specify a time between one hour and two weeks.</p><br>
    ///   - [`sort_by(AggregatedUtterancesSortBy)`](crate::operation::list_aggregated_utterances::builders::ListAggregatedUtterancesFluentBuilder::sort_by) / [`set_sort_by(Option<AggregatedUtterancesSortBy>)`](crate::operation::list_aggregated_utterances::builders::ListAggregatedUtterancesFluentBuilder::set_sort_by):<br>required: **false**<br><p>Specifies sorting parameters for the list of utterances. You can sort by the hit count, the missed count, or the number of distinct sessions the utterance appeared in.</p><br>
    ///   - [`filters(AggregatedUtterancesFilter)`](crate::operation::list_aggregated_utterances::builders::ListAggregatedUtterancesFluentBuilder::filters) / [`set_filters(Option<Vec::<AggregatedUtterancesFilter>>)`](crate::operation::list_aggregated_utterances::builders::ListAggregatedUtterancesFluentBuilder::set_filters):<br>required: **false**<br><p>Provides the specification of a filter used to limit the utterances in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_aggregated_utterances::builders::ListAggregatedUtterancesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_aggregated_utterances::builders::ListAggregatedUtterancesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of utterances 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. If you don't specify the <code>maxResults</code> parameter, 1,000 results are returned.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_aggregated_utterances::builders::ListAggregatedUtterancesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_aggregated_utterances::builders::ListAggregatedUtterancesFluentBuilder::set_next_token):<br>required: **false**<br><p>If the response from the <code>ListAggregatedUtterances</code> operation contains more results that specified in the <code>maxResults</code> parameter, a token is returned in the response. Use that token in the <code>nextToken</code> parameter to return the next page of results.</p><br>
    /// - On success, responds with [`ListAggregatedUtterancesOutput`](crate::operation::list_aggregated_utterances::ListAggregatedUtterancesOutput) with field(s):
    ///   - [`bot_id(Option<String>)`](crate::operation::list_aggregated_utterances::ListAggregatedUtterancesOutput::bot_id): <p>The identifier of the bot that contains the utterances.</p>
    ///   - [`bot_alias_id(Option<String>)`](crate::operation::list_aggregated_utterances::ListAggregatedUtterancesOutput::bot_alias_id): <p>The identifier of the bot alias that contains the utterances. If you specified the bot version, the bot alias ID isn't returned.</p>
    ///   - [`bot_version(Option<String>)`](crate::operation::list_aggregated_utterances::ListAggregatedUtterancesOutput::bot_version): <p>The identifier of the bot version that contains the utterances. If you specified the bot alias, the bot version isn't returned.</p>
    ///   - [`locale_id(Option<String>)`](crate::operation::list_aggregated_utterances::ListAggregatedUtterancesOutput::locale_id): <p>The identifier of the language and locale that the utterances are in.</p>
    ///   - [`aggregation_duration(Option<UtteranceAggregationDuration>)`](crate::operation::list_aggregated_utterances::ListAggregatedUtterancesOutput::aggregation_duration): <p>The time period used to aggregate the utterance data.</p>
    ///   - [`aggregation_window_start_time(Option<DateTime>)`](crate::operation::list_aggregated_utterances::ListAggregatedUtterancesOutput::aggregation_window_start_time): <p>The date and time that the aggregation window begins. Only data collected after this time is returned in the results.</p>
    ///   - [`aggregation_window_end_time(Option<DateTime>)`](crate::operation::list_aggregated_utterances::ListAggregatedUtterancesOutput::aggregation_window_end_time): <p>The date and time that the aggregation window ends. Only data collected between the start time and the end time are returned in the results.</p>
    ///   - [`aggregation_last_refreshed_date_time(Option<DateTime>)`](crate::operation::list_aggregated_utterances::ListAggregatedUtterancesOutput::aggregation_last_refreshed_date_time): <p>The last date and time that the aggregated data was collected. The time period depends on the length of the aggregation window.</p> <ul>  <li>   <p><b>Hours</b> - for 1 hour time window, every half hour; otherwise every hour.</p></li>  <li>   <p><b>Days</b> - every 6 hours</p></li>  <li>   <p><b>Weeks</b> - for a one week time window, every 12 hours; otherwise, every day</p></li> </ul>
    ///   - [`aggregated_utterances_summaries(Option<Vec::<AggregatedUtterancesSummary>>)`](crate::operation::list_aggregated_utterances::ListAggregatedUtterancesOutput::aggregated_utterances_summaries): <p>Summaries of the aggregated utterance data. Each response contains information about the number of times that the utterance was seen during the time period, whether it was detected or missed, and when it was seen during the time period.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_aggregated_utterances::ListAggregatedUtterancesOutput::next_token): <p>A token that indicates whether there are more results to return in a response to the <code>ListAggregatedUtterances</code> operation. If the <code>nextToken</code> field is present, you send the contents as the <code>nextToken</code> parameter of a <code>ListAggregatedUtterances</code> operation request to get the next page of results.</p>
    /// - On failure, responds with [`SdkError<ListAggregatedUtterancesError>`](crate::operation::list_aggregated_utterances::ListAggregatedUtterancesError)
    pub fn list_aggregated_utterances(&self) -> crate::operation::list_aggregated_utterances::builders::ListAggregatedUtterancesFluentBuilder {
        crate::operation::list_aggregated_utterances::builders::ListAggregatedUtterancesFluentBuilder::new(self.handle.clone())
    }
}