Skip to main content

speaker_search_tasks

Creates, updates, deletes, gets or lists a speaker_search_tasks resource.

Overview

Namespeaker_search_tasks
TypeResource
Idaws.chime_sdk_voice.speaker_search_tasks

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
call_detailsobjectThe call details of a speaker search task.
created_timestampstring (date-time)The time at which a speaker search task was created.
speaker_search_detailsobjectThe details of a speaker search task.
speaker_search_task_idstringThe speaker search task ID. (pattern: <code>.\S.</code>)
speaker_search_task_statusstringThe status of the speaker search task, IN_QUEUE, IN_PROGRESS, PARTIAL_SUCCESS, SUCCEEDED, FAILED, or STOPPED. (pattern: <code>.\S.</code>)
started_timestampstring (date-time)The time at which the speaker search task began.
status_messagestringA detailed message about the status of a speaker search.
updated_timestampstring (date-time)The time at which a speaker search task was updated.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_speaker_search_taskselectvoice_connector_id, speaker_search_task_id, regionRetrieves 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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)
speaker_search_task_idstringThe ID of the speaker search task.
voice_connector_idstringThe Voice Connector ID.

SELECT examples

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
;