AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginListUtteranceMetrics and EndListUtteranceMetrics.
Namespace: Amazon.LexModelsV2
Assembly: AWSSDK.LexModelsV2.dll
Version: 3.x.y.z
public abstract Task<ListUtteranceMetricsResponse> ListUtteranceMetricsAsync( ListUtteranceMetricsRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the ListUtteranceMetrics service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| InternalServerException | The service encountered an unexpected condition. Try your request again. |
| PreconditionFailedException | Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again. |
| ServiceQuotaExceededException | You have reached a quota for your bot. |
| ThrottlingException | Your request rate is too high. Reduce the frequency of requests. |
| ValidationException | One of the input parameters in your request isn't valid. Check the parameters and try your request again. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer