voice_tone_analysis_tasks

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

Overview

Name	voice_tone_analysis_tasks
Type	Resource
Id	aws.chime_sdk_voice.voice_tone_analysis_tasks

Fields

The following fields are returned by SELECT queries:

get_voice_tone_analysis_task

Name	Datatype	Description
call_details	object	The call details of a voice tone analysis task.
created_timestamp	string (date-time)	The time at which a voice tone analysis task was created.
started_timestamp	string (date-time)	The time at which a voice tone analysis task started.
status_message	string	The status of a voice tone analysis task.
updated_timestamp	string (date-time)	The time at which a voice tone analysis task was updated.
voice_tone_analysis_task_id	string	The ID of the voice tone analysis task. (pattern: <code>.\S.</code>)
voice_tone_analysis_task_status	string	The status of a voice tone analysis task, IN_QUEUE, IN_PROGRESS, PARTIAL_SUCCESS, SUCCEEDED, FAILED, or STOPPED. (pattern: <code>.\S.</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_voice_tone_analysis_task	select	voice_connector_id, voice_tone_analysis_task_id, isCaller, region		Retrieves the details of a voice tone analysis 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
isCaller	boolean	Specifies whether the voice being analyzed is the caller (originator) or the callee (responder).
region	string	AWS region (default: us-east-1)
voice_connector_id	string	The Voice Connector ID.
voice_tone_analysis_task_id	string	The ID of the voice tone analysis task.

SELECT examples

get_voice_tone_analysis_task

Retrieves the details of a voice tone analysis task.

SELECT
call_details,
created_timestamp,
started_timestamp,
status_message,
updated_timestamp,
voice_tone_analysis_task_id,
voice_tone_analysis_task_status
FROM aws.chime_sdk_voice.voice_tone_analysis_tasks
WHERE voice_connector_id = '{{ voice_connector_id }}' -- required
AND voice_tone_analysis_task_id = '{{ voice_tone_analysis_task_id }}' -- required
AND isCaller = '{{ isCaller }}' -- required
AND region = '{{ region }}' -- required
;