utterance_analytics_datas
Creates, updates, deletes, gets or lists a utterance_analytics_datas resource.
Overview
| Name | utterance_analytics_datas |
| Type | Resource |
| Id | aws.lexv2_models.utterance_analytics_datas |
Fields
The following fields are returned by SELECT queries:
- list_utterance_analytics_data
| Name | Datatype | Description |
|---|---|---|
bot_id | string | The unique identifier of the bot that the utterances belong to. (pattern: <code>^[0-9a-zA-Z]+$</code>) |
next_token | string | If the response from the ListUtteranceAnalyticsData 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 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. |
utterances | array | A list of objects, each of which contains information about an utterance in a user session with your bot. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_utterance_analytics_data | select | bot_id, 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 a list of metadata for individual user utterances to your bot. The following fields are required: 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 and the sortBy field to specify the values by which to sort 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. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
bot_id | string | The identifier for the bot for which you want to retrieve utterance analytics. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- list_utterance_analytics_data
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 a list of metadata for individual user utterances to your bot. The following fields are required: 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 and the sortBy field to specify the values by which to sort 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.
SELECT
bot_id,
next_token,
utterances
FROM aws.lexv2_models.utterance_analytics_datas
WHERE bot_id = '{{ bot_id }}' -- required
AND region = '{{ region }}' -- required
;