Struct aws_sdk_lexmodelsv2::operation::list_utterance_metrics::builders::ListUtteranceMetricsFluentBuilder

pub struct ListUtteranceMetricsFluentBuilder { /* private fields */ }

Fluent builder constructing a request to ListUtteranceMetrics.

To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics. See Viewing utterance statistics for the IAM policy to apply to the IAM role.

Retrieves summary metrics for the utterances in your bot. The following fields are required:

• metrics – A list of AnalyticsUtteranceMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order.

• startDateTime and endDateTime – Define a time range for which you want to retrieve results.

Of the optional fields, you can organize the results in the following ways:

• Use the filters field to filter the results, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group the results.

• Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results.

Note that an order field exists in both binBy and metrics. Currently, you can specify it in either field, but not in both.

Implementations

impl ListUtteranceMetricsFluentBuilder

pub fn as_input(&self) -> &ListUtteranceMetricsInputBuilder

Access the ListUtteranceMetrics as a reference.

pub async fn send( self ) -> Result<ListUtteranceMetricsOutput, SdkError<ListUtteranceMetricsError, HttpResponse>>

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, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<ListUtteranceMetricsOutput, ListUtteranceMetricsError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn into_paginator(self) -> ListUtteranceMetricsPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a PaginationStream.

pub fn bot_id(self, input: impl Into<String>) -> Self

The identifier for the bot for which you want to retrieve utterance metrics.

pub fn set_bot_id(self, input: Option<String>) -> Self

The identifier for the bot for which you want to retrieve utterance metrics.

pub fn get_bot_id(&self) -> &Option<String>

The identifier for the bot for which you want to retrieve utterance metrics.

pub fn start_date_time(self, input: DateTime) -> Self

The date and time that marks the beginning of the range of time for which you want to see utterance metrics.

pub fn set_start_date_time(self, input: Option<DateTime>) -> Self

The date and time that marks the beginning of the range of time for which you want to see utterance metrics.

pub fn get_start_date_time(&self) -> &Option<DateTime>

The date and time that marks the beginning of the range of time for which you want to see utterance metrics.

pub fn end_date_time(self, input: DateTime) -> Self

The date and time that marks the end of the range of time for which you want to see utterance metrics.

pub fn set_end_date_time(self, input: Option<DateTime>) -> Self

The date and time that marks the end of the range of time for which you want to see utterance metrics.

pub fn get_end_date_time(&self) -> &Option<DateTime>

The date and time that marks the end of the range of time for which you want to see utterance metrics.

pub fn metrics(self, input: AnalyticsUtteranceMetric) -> Self

Appends an item to metrics.

To override the contents of this collection use set_metrics.

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.

pub fn set_metrics(self, input: Option<Vec<AnalyticsUtteranceMetric>>) -> Self

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.

pub fn get_metrics(&self) -> &Option<Vec<AnalyticsUtteranceMetric>>

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.

pub fn bin_by(self, input: AnalyticsBinBySpecification) -> Self

Appends an item to binBy.

To override the contents of this collection use set_bin_by.

A list of objects, each of which contains specifications for organizing the results by time.

pub fn set_bin_by(self, input: Option<Vec<AnalyticsBinBySpecification>>) -> Self

A list of objects, each of which contains specifications for organizing the results by time.

pub fn get_bin_by(&self) -> &Option<Vec<AnalyticsBinBySpecification>>

A list of objects, each of which contains specifications for organizing the results by time.

pub fn group_by(self, input: AnalyticsUtteranceGroupBySpecification) -> Self

Appends an item to groupBy.

To override the contents of this collection use set_group_by.

A list of objects, each of which specifies how to group the results. You can group by the following criteria:

• UtteranceText – The transcription of the utterance.

• UtteranceState – The state of the utterance. The possible states are detailed in Key definitions in the user guide.

pub fn set_group_by( self, input: Option<Vec<AnalyticsUtteranceGroupBySpecification>> ) -> Self

A list of objects, each of which specifies how to group the results. You can group by the following criteria:

• UtteranceText – The transcription of the utterance.

• UtteranceState – The state of the utterance. The possible states are detailed in Key definitions in the user guide.

pub fn get_group_by( &self ) -> &Option<Vec<AnalyticsUtteranceGroupBySpecification>>

A list of objects, each of which specifies how to group the results. You can group by the following criteria:

• UtteranceText – The transcription of the utterance.

• UtteranceState – The state of the utterance. The possible states are detailed in Key definitions in the user guide.

pub fn attributes(self, input: AnalyticsUtteranceAttribute) -> Self

Appends an item to attributes.

To override the contents of this collection use set_attributes.

A list containing attributes related to the utterance that you want the response to return. The following attributes are possible:

• LastUsedIntent – The last used intent at the time of the utterance.

pub fn set_attributes( self, input: Option<Vec<AnalyticsUtteranceAttribute>> ) -> Self

A list containing attributes related to the utterance that you want the response to return. The following attributes are possible:

• LastUsedIntent – The last used intent at the time of the utterance.

pub fn get_attributes(&self) -> &Option<Vec<AnalyticsUtteranceAttribute>>

A list containing attributes related to the utterance that you want the response to return. The following attributes are possible:

• LastUsedIntent – The last used intent at the time of the utterance.

pub fn filters(self, input: AnalyticsUtteranceFilter) -> Self

Appends an item to filters.

To override the contents of this collection use set_filters.

A list of objects, each of which describes a condition by which you want to filter the results.

pub fn set_filters(self, input: Option<Vec<AnalyticsUtteranceFilter>>) -> Self

A list of objects, each of which describes a condition by which you want to filter the results.

pub fn get_filters(&self) -> &Option<Vec<AnalyticsUtteranceFilter>>

A list of objects, each of which describes a condition by which you want to filter the results.

pub fn max_results(self, input: i32) -> Self

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.

pub fn set_max_results(self, input: Option<i32>) -> Self

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.

pub fn get_max_results(&self) -> &Option<i32>

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.

pub fn next_token(self, input: impl Into<String>) -> Self

If the response from the ListUtteranceMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.

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.

pub fn set_next_token(self, input: Option<String>) -> Self

If the response from the ListUtteranceMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.

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.

pub fn get_next_token(&self) -> &Option<String>

If the response from the ListUtteranceMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.

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.

Trait Implementations

impl Clone for ListUtteranceMetricsFluentBuilder

fn clone(&self) -> ListUtteranceMetricsFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListUtteranceMetricsFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.