realtime_contact_analysis_segments_v2s
Creates, updates, deletes, gets or lists a realtime_contact_analysis_segments_v2s resource.
Overview
| Name | realtime_contact_analysis_segments_v2s |
| Type | Resource |
| Id | aws.connect.realtime_contact_analysis_segments_v2s |
Fields
The following fields are returned by SELECT queries:
- list_realtime_contact_analysis_segments_v2
| Name | Datatype | Description |
|---|---|---|
channel | string | The channel of the contact. Only CHAT is supported. This API does not support VOICE. If you attempt to use it for the VOICE channel, an InvalidRequestException error occurs. (VOICE, CHAT) |
next_token | string | If there are additional results, this is the token for the next set of results. |
segments | array | An analyzed transcript or category. |
status | string | Status of real-time contact analysis. (IN_PROGRESS, FAILED, COMPLETED) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_realtime_contact_analysis_segments_v2 | select | instance_id, contact_id, region | Provides a list of analysis segments for a real-time chat analysis session. This API supports CHAT channels only. This API does not support VOICE. If you attempt to use it for VOICE, an InvalidRequestException occurs. |
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 |
|---|---|---|
contact_id | string | The identifier of the contact in this instance of Connect Customer. |
instance_id | string | The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- list_realtime_contact_analysis_segments_v2
Provides a list of analysis segments for a real-time chat analysis session. This API supports CHAT channels only. This API does not support VOICE. If you attempt to use it for VOICE, an InvalidRequestException occurs.
SELECT
channel,
next_token,
segments,
status
FROM aws.connect.realtime_contact_analysis_segments_v2s
WHERE instance_id = '{{ instance_id }}' -- required
AND contact_id = '{{ contact_id }}' -- required
AND region = '{{ region }}' -- required
;