speaker_search_tasks
Creates, updates, deletes, gets or lists a speaker_search_tasks resource.
Overview
| Name | speaker_search_tasks |
| Type | Resource |
| Id | aws.chime_sdk_voice.speaker_search_tasks |
Fields
The following fields are returned by SELECT queries:
- get_speaker_search_task
| Name | Datatype | Description |
|---|---|---|
call_details | object | The call details of a speaker search task. |
created_timestamp | string (date-time) | The time at which a speaker search task was created. |
speaker_search_details | object | The details of a speaker search task. |
speaker_search_task_id | string | The speaker search task ID. (pattern: <code>.\S.</code>) |
speaker_search_task_status | string | The status of the speaker search task, IN_QUEUE, IN_PROGRESS, PARTIAL_SUCCESS, SUCCEEDED, FAILED, or STOPPED. (pattern: <code>.\S.</code>) |
started_timestamp | string (date-time) | The time at which the speaker search task began. |
status_message | string | A detailed message about the status of a speaker search. |
updated_timestamp | string (date-time) | The time at which a speaker search task was updated. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_speaker_search_task | select | voice_connector_id, speaker_search_task_id, region | Retrieves the details of the specified speaker search task. |
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 |
|---|---|---|
region | string | AWS region (default: us-east-1) |
speaker_search_task_id | string | The ID of the speaker search task. |
voice_connector_id | string | The Voice Connector ID. |
SELECT examples
- get_speaker_search_task
Retrieves the details of the specified speaker search task.
SELECT
call_details,
created_timestamp,
speaker_search_details,
speaker_search_task_id,
speaker_search_task_status,
started_timestamp,
status_message,
updated_timestamp
FROM aws.chime_sdk_voice.speaker_search_tasks
WHERE voice_connector_id = '{{ voice_connector_id }}' -- required
AND speaker_search_task_id = '{{ speaker_search_task_id }}' -- required
AND region = '{{ region }}' -- required
;