AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Allows the creation of an asynchronous synthesis task, by starting a new SpeechSynthesisTask. This operation requires all the standard information needed for speech synthesis, plus the name of an Amazon S3 bucket for the service to store the output of the synthesis task and two optional parameters (OutputS3KeyPrefix and SnsTopicArn). Once the synthesis task is created, this operation will return a SpeechSynthesisTask object, which will include an identifier of this task as well as the current status. The SpeechSynthesisTask object is available for 72 hours after starting the asynchronous synthesis task.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to StartSpeechSynthesisTaskAsync.

Namespace: Amazon.Polly
Assembly: AWSSDK.Polly.dll
Version: 3.x.y.z

Syntax

C#
public virtual StartSpeechSynthesisTaskResponse StartSpeechSynthesisTask(
         StartSpeechSynthesisTaskRequest request
)

Parameters

request
Type: Amazon.Polly.Model.StartSpeechSynthesisTaskRequest

Container for the necessary parameters to execute the StartSpeechSynthesisTask service method.

Return Value


The response from the StartSpeechSynthesisTask service method, as returned by Polly.

Exceptions

ExceptionCondition
EngineNotSupportedException This engine is not compatible with the voice that you have designated. Choose a new voice that is compatible with the engine or change the engine and restart the operation.
InvalidS3BucketException The provided Amazon S3 bucket name is invalid. Please check your input with S3 bucket naming requirements and try again.
InvalidS3KeyException The provided Amazon S3 key prefix is invalid. Please provide a valid S3 object key name.
InvalidSampleRateException The specified sample rate is not valid.
InvalidSnsTopicArnException The provided SNS topic ARN is invalid. Please provide a valid SNS topic ARN and try again.
InvalidSsmlException The SSML you provided is invalid. Verify the SSML syntax, spelling of tags and values, and then try again.
LanguageNotSupportedException The language specified is not currently supported by Amazon Polly in this capacity.
LexiconNotFoundException Amazon Polly can't find the specified lexicon. This could be caused by a lexicon that is missing, its name is misspelled or specifying a lexicon that is in a different region. Verify that the lexicon exists, is in the region (see ListLexicons) and that you spelled its name is spelled correctly. Then try again.
MarksNotSupportedForFormatException Speech marks are not supported for the OutputFormat selected. Speech marks are only available for content in json format.
ServiceFailureException An unknown condition has caused a service failure.
SsmlMarksNotSupportedForTextTypeException SSML speech marks are not supported for plain text-type input.
TextLengthExceededException The value of the "Text" parameter is longer than the accepted limits. For the SynthesizeSpeech API, the limit for input text is a maximum of 6000 characters total, of which no more than 3000 can be billed characters. For the StartSpeechSynthesisTask API, the maximum is 200,000 characters, of which no more than 100,000 can be billed characters. SSML tags are not counted as billed characters.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

See Also