session_analytics_datas
Creates, updates, deletes, gets or lists a session_analytics_datas resource.
Overview
| Name | session_analytics_datas |
| Type | Resource |
| Id | aws.lexv2_models.session_analytics_datas |
Fields
The following fields are returned by SELECT queries:
- list_session_analytics_data
| Name | Datatype | Description |
|---|---|---|
bot_id | string | The unique identifier of the bot that the sessions belong to. (pattern: <code>^[0-9a-zA-Z]+$</code>) |
next_token | string | If the response from the ListSessionAnalyticsData 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 ListSessionAnalyticsData request to return the next page of results. For a complete set of results, call the ListSessionAnalyticsData operation until the nextToken returned in the response is null. |
sessions | array | A list of objects, each of which contains information about a session with the bot. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_session_analytics_data | select | bot_id, region | Retrieves a list of metadata for individual user sessions with your bot. The startDateTime and endDateTime fields are required. These fields 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 session analytics. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- list_session_analytics_data
Retrieves a list of metadata for individual user sessions with your bot. The startDateTime and endDateTime fields are required. These fields 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,
sessions
FROM aws.lexv2_models.session_analytics_datas
WHERE bot_id = '{{ bot_id }}' -- required
AND region = '{{ region }}' -- required
;