aws_sdk_lexmodelsv2/operation/list_utterance_metrics/

builders.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::list_utterance_metrics::_list_utterance_metrics_output::ListUtteranceMetricsOutputBuilder;

pub use crate::operation::list_utterance_metrics::_list_utterance_metrics_input::ListUtteranceMetricsInputBuilder;

impl crate::operation::list_utterance_metrics::builders::ListUtteranceMetricsInputBuilder {
    /// Sends a request with this input using the given client.
    pub async fn send_with(
        self,
        client: &crate::Client,
    ) -> ::std::result::Result<
        crate::operation::list_utterance_metrics::ListUtteranceMetricsOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::list_utterance_metrics::ListUtteranceMetricsError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.list_utterance_metrics();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `ListUtteranceMetrics`.
///
/// <note>
/// <p>To use this API operation, your IAM role must have permissions to perform the <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListAggregatedUtterances.html">ListAggregatedUtterances</a> operation, which provides access to utterance-related analytics. See <a href="https://docs.aws.amazon.com/lexv2/latest/dg/monitoring-utterances.html">Viewing utterance statistics</a> for the IAM policy to apply to the IAM role.</p>
/// </note>
/// <p>Retrieves summary metrics for the utterances in your bot. The following fields are required:</p>
/// <ul>
/// <li>
/// <p><code>metrics</code> – A list of <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsUtteranceMetric.html">AnalyticsUtteranceMetric</a> objects. In each object, use the <code>name</code> field to specify the metric to calculate, the <code>statistic</code> field to specify whether to calculate the <code>Sum</code>, <code>Average</code>, or <code>Max</code> number, and the <code>order</code> field to specify whether to sort the results in <code>Ascending</code> or <code>Descending</code> order.</p></li>
/// <li>
/// <p><code>startDateTime</code> and <code>endDateTime</code> – Define a time range for which you want to retrieve results.</p></li>
/// </ul>
/// <p>Of the optional fields, you can organize the results in the following ways:</p>
/// <ul>
/// <li>
/// <p>Use the <code>filters</code> field to filter the results, the <code>groupBy</code> field to specify categories by which to group the results, and the <code>binBy</code> field to specify time intervals by which to group the results.</p></li>
/// <li>
/// <p>Use the <code>maxResults</code> field to limit the number of results to return in a single response and the <code>nextToken</code> field to return the next batch of results if the response does not return the full set of results.</p></li>
/// </ul>
/// <p>Note that an <code>order</code> field exists in both <code>binBy</code> and <code>metrics</code>. Currently, you can specify it in either field, but not in both.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct ListUtteranceMetricsFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::list_utterance_metrics::builders::ListUtteranceMetricsInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::list_utterance_metrics::ListUtteranceMetricsOutput,
        crate::operation::list_utterance_metrics::ListUtteranceMetricsError,
    > for ListUtteranceMetricsFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::list_utterance_metrics::ListUtteranceMetricsOutput,
            crate::operation::list_utterance_metrics::ListUtteranceMetricsError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl ListUtteranceMetricsFluentBuilder {
    /// Creates a new `ListUtteranceMetricsFluentBuilder`.
    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
        Self {
            handle,
            inner: ::std::default::Default::default(),
            config_override: ::std::option::Option::None,
        }
    }
    /// Access the ListUtteranceMetrics as a reference.
    pub fn as_input(&self) -> &crate::operation::list_utterance_metrics::builders::ListUtteranceMetricsInputBuilder {
        &self.inner
    }
    /// Sends the request and returns the response.
    ///
    /// If an error occurs, an `SdkError` will be returned with additional details that
    /// can be matched against.
    ///
    /// By default, any retryable failures will be retried twice. Retry behavior
    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
    /// set when configuring the client.
    pub async fn send(
        self,
    ) -> ::std::result::Result<
        crate::operation::list_utterance_metrics::ListUtteranceMetricsOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::list_utterance_metrics::ListUtteranceMetricsError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let input = self
            .inner
            .build()
            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
        let runtime_plugins = crate::operation::list_utterance_metrics::ListUtteranceMetrics::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::list_utterance_metrics::ListUtteranceMetrics::orchestrate(&runtime_plugins, input).await
    }

    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
    pub fn customize(
        self,
    ) -> crate::client::customize::CustomizableOperation<
        crate::operation::list_utterance_metrics::ListUtteranceMetricsOutput,
        crate::operation::list_utterance_metrics::ListUtteranceMetricsError,
        Self,
    > {
        crate::client::customize::CustomizableOperation::new(self)
    }
    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
        self.set_config_override(::std::option::Option::Some(config_override.into()));
        self
    }

    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
        self.config_override = config_override;
        self
    }
    /// Create a paginator for this request
    ///
    /// Paginators are used by calling [`send().await`](crate::operation::list_utterance_metrics::paginator::ListUtteranceMetricsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
    pub fn into_paginator(self) -> crate::operation::list_utterance_metrics::paginator::ListUtteranceMetricsPaginator {
        crate::operation::list_utterance_metrics::paginator::ListUtteranceMetricsPaginator::new(self.handle, self.inner)
    }
    /// <p>The identifier for the bot for which you want to retrieve utterance metrics.</p>
    pub fn bot_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.bot_id(input.into());
        self
    }
    /// <p>The identifier for the bot for which you want to retrieve utterance metrics.</p>
    pub fn set_bot_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_bot_id(input);
        self
    }
    /// <p>The identifier for the bot for which you want to retrieve utterance metrics.</p>
    pub fn get_bot_id(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_bot_id()
    }
    /// <p>The date and time that marks the beginning of the range of time for which you want to see utterance metrics.</p>
    pub fn start_date_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.inner = self.inner.start_date_time(input);
        self
    }
    /// <p>The date and time that marks the beginning of the range of time for which you want to see utterance metrics.</p>
    pub fn set_start_date_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.inner = self.inner.set_start_date_time(input);
        self
    }
    /// <p>The date and time that marks the beginning of the range of time for which you want to see utterance metrics.</p>
    pub fn get_start_date_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        self.inner.get_start_date_time()
    }
    /// <p>The date and time that marks the end of the range of time for which you want to see utterance metrics.</p>
    pub fn end_date_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.inner = self.inner.end_date_time(input);
        self
    }
    /// <p>The date and time that marks the end of the range of time for which you want to see utterance metrics.</p>
    pub fn set_end_date_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.inner = self.inner.set_end_date_time(input);
        self
    }
    /// <p>The date and time that marks the end of the range of time for which you want to see utterance metrics.</p>
    pub fn get_end_date_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        self.inner.get_end_date_time()
    }
    ///
    /// Appends an item to `metrics`.
    ///
    /// To override the contents of this collection use [`set_metrics`](Self::set_metrics).
    ///
    /// <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>
    pub fn metrics(mut self, input: crate::types::AnalyticsUtteranceMetric) -> Self {
        self.inner = self.inner.metrics(input);
        self
    }
    /// <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>
    pub fn set_metrics(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::AnalyticsUtteranceMetric>>) -> Self {
        self.inner = self.inner.set_metrics(input);
        self
    }
    /// <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>
    pub fn get_metrics(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::AnalyticsUtteranceMetric>> {
        self.inner.get_metrics()
    }
    ///
    /// Appends an item to `binBy`.
    ///
    /// To override the contents of this collection use [`set_bin_by`](Self::set_bin_by).
    ///
    /// <p>A list of objects, each of which contains specifications for organizing the results by time.</p>
    pub fn bin_by(mut self, input: crate::types::AnalyticsBinBySpecification) -> Self {
        self.inner = self.inner.bin_by(input);
        self
    }
    /// <p>A list of objects, each of which contains specifications for organizing the results by time.</p>
    pub fn set_bin_by(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::AnalyticsBinBySpecification>>) -> Self {
        self.inner = self.inner.set_bin_by(input);
        self
    }
    /// <p>A list of objects, each of which contains specifications for organizing the results by time.</p>
    pub fn get_bin_by(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::AnalyticsBinBySpecification>> {
        self.inner.get_bin_by()
    }
    ///
    /// Appends an item to `groupBy`.
    ///
    /// To override the contents of this collection use [`set_group_by`](Self::set_group_by).
    ///
    /// <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>
    pub fn group_by(mut self, input: crate::types::AnalyticsUtteranceGroupBySpecification) -> Self {
        self.inner = self.inner.group_by(input);
        self
    }
    /// <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>
    pub fn set_group_by(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::AnalyticsUtteranceGroupBySpecification>>) -> Self {
        self.inner = self.inner.set_group_by(input);
        self
    }
    /// <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>
    pub fn get_group_by(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::AnalyticsUtteranceGroupBySpecification>> {
        self.inner.get_group_by()
    }
    ///
    /// Appends an item to `attributes`.
    ///
    /// To override the contents of this collection use [`set_attributes`](Self::set_attributes).
    ///
    /// <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>
    pub fn attributes(mut self, input: crate::types::AnalyticsUtteranceAttribute) -> Self {
        self.inner = self.inner.attributes(input);
        self
    }
    /// <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>
    pub fn set_attributes(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::AnalyticsUtteranceAttribute>>) -> Self {
        self.inner = self.inner.set_attributes(input);
        self
    }
    /// <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>
    pub fn get_attributes(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::AnalyticsUtteranceAttribute>> {
        self.inner.get_attributes()
    }
    ///
    /// Appends an item to `filters`.
    ///
    /// To override the contents of this collection use [`set_filters`](Self::set_filters).
    ///
    /// <p>A list of objects, each of which describes a condition by which you want to filter the results.</p>
    pub fn filters(mut self, input: crate::types::AnalyticsUtteranceFilter) -> Self {
        self.inner = self.inner.filters(input);
        self
    }
    /// <p>A list of objects, each of which describes a condition by which you want to filter the results.</p>
    pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::AnalyticsUtteranceFilter>>) -> Self {
        self.inner = self.inner.set_filters(input);
        self
    }
    /// <p>A list of objects, each of which describes a condition by which you want to filter the results.</p>
    pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::AnalyticsUtteranceFilter>> {
        self.inner.get_filters()
    }
    /// <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>
    pub fn max_results(mut self, input: i32) -> Self {
        self.inner = self.inner.max_results(input);
        self
    }
    /// <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>
    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
        self.inner = self.inner.set_max_results(input);
        self
    }
    /// <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>
    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
        self.inner.get_max_results()
    }
    /// <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>
    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.next_token(input.into());
        self
    }
    /// <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>
    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_next_token(input);
        self
    }
    /// <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>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_next_token()
    }
}