speech_synthesis_tasks

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

Overview

Name	speech_synthesis_tasks
Type	Resource
Id	aws.polly.speech_synthesis_tasks

Fields

The following fields are returned by SELECT queries:

get_speech_synthesis_task

Name	Datatype	Description
creation_time	string (date-time)	Timestamp for the time the synthesis task was started.
engine	string	Specifies the engine (standard, neural, long-form or generative) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error. (standard, neural, long-form, generative)
language_code	string	Optional language code for a synthesis task. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN). If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi. (arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR, en-NZ, en-ZA, ca-ES, de-AT, yue-CN, ar-AE, fi-FI, en-IE, nl-BE, fr-BE, cs-CZ, de-CH, en-SG)
lexicon_names	array	List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice.
output_format	string	The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, ogg_opus, mu-law, a-law, or pcm. For speech marks, this will be json. (json, mp3, ogg_opus, ogg_vorbis, pcm, mulaw, alaw)
output_uri	string	Pathway for the output speech file.
request_characters	integer	Number of billable characters synthesized.
sample_rate	string	The audio frequency specified in Hz. The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000". The default value for long-form voices is "24000". The default value for generative voices is "24000". Valid values for pcm are "8000" and "16000" The default value is "16000". Valid value for ogg_opus is "48000". Valid value for mu-law and a-law is "8000".
sns_topic_arn	string	ARN for the SNS topic optionally used for providing status notification for a speech synthesis task. (pattern: <code>^arn:aws(-(cn|iso(-b)?|us-gov))?:sns:[a-z0-9_-]{1,50}:\d{12}:[a-zA-Z0-9_-]{1,251}([a-zA-Z0-9_-]{0,5}|.fifo)$</code>)
speech_mark_types	array	The type of speech marks returned for the input text.
task_id	string	The Amazon Polly generated identifier for a speech synthesis task. (pattern: <code>^[a-zA-Z0-9_-]{1,100}$</code>)
task_status	string	Current status of the individual speech synthesis task. (scheduled, inProgress, completed, failed)
task_status_reason	string	Reason for the current status of a specific speech synthesis task, including errors if the task has failed.
text_type	string	Specifies whether the input text is plain text or SSML. The default value is plain text. (ssml, text)
voice_id	string	Voice ID to use for the synthesis. (Aditi, Amy, Astrid, Bianca, Brian, Camila, Carla, Carmen, Celine, Chantal, Conchita, Cristiano, Dora, Emma, Enrique, Ewa, Filiz, Gabrielle, Geraint, Giorgio, Gwyneth, Hans, Ines, Ivy, Jacek, Jan, Joanna, Joey, Justin, Karl, Kendra, Kevin, Kimberly, Lea, Liv, Lotte, Lucia, Lupe, Mads, Maja, Marlene, Mathieu, Matthew, Maxim, Mia, Miguel, Mizuki, Naja, Nicole, Olivia, Penelope, Raveena, Ricardo, Ruben, Russell, Salli, Seoyeon, Takumi, Tatyana, Vicki, Vitoria, Zeina, Zhiyu, Aria, Ayanda, Arlet, Hannah, Arthur, Daniel, Liam, Pedro, Kajal, Hiujin, Laura, Elin, Ida, Suvi, Ola, Hala, Andres, Sergio, Remi, Adriano, Thiago, Ruth, Stephen, Kazuha, Tomoko, Niamh, Sofie, Lisa, Isabelle, Zayd, Danielle, Gregory, Burcu, Jitka, Sabrina, Jasmine, Jihye, Ambre, Beatrice, Florian, Lennart, Lorenzo, Tiffany)

list_speech_synthesis_tasks

Name	Datatype	Description
creation_time	string (date-time)	Timestamp for the time the synthesis task was started.
engine	string	Specifies the engine (standard, neural, long-form or generative) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error. (standard, neural, long-form, generative)
language_code	string	Optional language code for a synthesis task. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN). If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi. (arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR, en-NZ, en-ZA, ca-ES, de-AT, yue-CN, ar-AE, fi-FI, en-IE, nl-BE, fr-BE, cs-CZ, de-CH, en-SG)
lexicon_names	array	List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice.
output_format	string	The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, ogg_opus, mu-law, a-law, or pcm. For speech marks, this will be json. (json, mp3, ogg_opus, ogg_vorbis, pcm, mulaw, alaw)
output_uri	string	Pathway for the output speech file.
request_characters	integer	Number of billable characters synthesized.
sample_rate	string	The audio frequency specified in Hz. The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000". The default value for long-form voices is "24000". The default value for generative voices is "24000". Valid values for pcm are "8000" and "16000" The default value is "16000". Valid value for ogg_opus is "48000". Valid value for mu-law and a-law is "8000".
sns_topic_arn	string	ARN for the SNS topic optionally used for providing status notification for a speech synthesis task. (pattern: <code>^arn:aws(-(cn|iso(-b)?|us-gov))?:sns:[a-z0-9_-]{1,50}:\d{12}:[a-zA-Z0-9_-]{1,251}([a-zA-Z0-9_-]{0,5}|.fifo)$</code>)
speech_mark_types	array	The type of speech marks returned for the input text.
task_id	string	The Amazon Polly generated identifier for a speech synthesis task. (pattern: <code>^[a-zA-Z0-9_-]{1,100}$</code>)
task_status	string	Current status of the individual speech synthesis task. (scheduled, inProgress, completed, failed)
task_status_reason	string	Reason for the current status of a specific speech synthesis task, including errors if the task has failed.
text_type	string	Specifies whether the input text is plain text or SSML. The default value is plain text. (ssml, text)
voice_id	string	Voice ID to use for the synthesis. (Aditi, Amy, Astrid, Bianca, Brian, Camila, Carla, Carmen, Celine, Chantal, Conchita, Cristiano, Dora, Emma, Enrique, Ewa, Filiz, Gabrielle, Geraint, Giorgio, Gwyneth, Hans, Ines, Ivy, Jacek, Jan, Joanna, Joey, Justin, Karl, Kendra, Kevin, Kimberly, Lea, Liv, Lotte, Lucia, Lupe, Mads, Maja, Marlene, Mathieu, Matthew, Maxim, Mia, Miguel, Mizuki, Naja, Nicole, Olivia, Penelope, Raveena, Ricardo, Ruben, Russell, Salli, Seoyeon, Takumi, Tatyana, Vicki, Vitoria, Zeina, Zhiyu, Aria, Ayanda, Arlet, Hannah, Arthur, Daniel, Liam, Pedro, Kajal, Hiujin, Laura, Elin, Ida, Suvi, Ola, Hala, Andres, Sergio, Remi, Adriano, Thiago, Ruth, Stephen, Kazuha, Tomoko, Niamh, Sofie, Lisa, Isabelle, Zayd, Danielle, Gregory, Burcu, Jitka, Sabrina, Jasmine, Jihye, Ambre, Beatrice, Florian, Lennart, Lorenzo, Tiffany)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_speech_synthesis_task	select	task_id, region		Retrieves a specific SpeechSynthesisTask object based on its TaskID. This object contains information about the given speech synthesis task, including the status of the task, and a link to the S3 bucket containing the output of the task.
list_speech_synthesis_tasks	select	region	MaxResults, NextToken, Status	Returns a list of SpeechSynthesisTask objects ordered by their creation date. This operation can filter the tasks by their status, for example, allowing users to list only tasks that are completed.

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)
task_id	string	The Amazon Polly generated identifier for a speech synthesis task.
MaxResults	integer	Maximum number of speech synthesis tasks returned in a List operation.
NextToken	string	The pagination token to use in the next request to continue the listing of speech synthesis tasks.
Status	string	Status of the speech synthesis tasks returned in a List operation

SELECT examples

get_speech_synthesis_task

Retrieves a specific SpeechSynthesisTask object based on its TaskID. This object contains information about the given speech synthesis task, including the status of the task, and a link to the S3 bucket containing the output of the task.

SELECT
creation_time,
engine,
language_code,
lexicon_names,
output_format,
output_uri,
request_characters,
sample_rate,
sns_topic_arn,
speech_mark_types,
task_id,
task_status,
task_status_reason,
text_type,
voice_id
FROM aws.polly.speech_synthesis_tasks
WHERE task_id = '{{ task_id }}' -- required
AND region = '{{ region }}' -- required
;

list_speech_synthesis_tasks

Returns a list of SpeechSynthesisTask objects ordered by their creation date. This operation can filter the tasks by their status, for example, allowing users to list only tasks that are completed.

SELECT
creation_time,
engine,
language_code,
lexicon_names,
output_format,
output_uri,
request_characters,
sample_rate,
sns_topic_arn,
speech_mark_types,
task_id,
task_status,
task_status_reason,
text_type,
voice_id
FROM aws.polly.speech_synthesis_tasks
WHERE region = '{{ region }}' -- required
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND Status = '{{ Status }}'
;