Table of Contents

Interface IAmazonPolly

Namespace
Amazon.Polly
Assembly
AWSSDK.Polly.dll

Interface for accessing Polly

Amazon Polly is a web service that makes it easy to synthesize speech from text.

The Amazon Polly service provides API operations for synthesizing high-quality speech from plain text and Speech Synthesis Markup Language (SSML), along with managing pronunciations lexicons that enable you to get the best results for your application domain. 

public interface IAmazonPolly : IAmazonService, IDisposable
Inherited Members

Methods

BeginDeleteLexicon(DeleteLexiconRequest, AsyncCallback, object)

Initiates the asynchronous execution of the DeleteLexicon operation.

IAsyncResult BeginDeleteLexicon(DeleteLexiconRequest request, AsyncCallback callback, object state)

Parameters

request DeleteLexiconRequest

Container for the necessary parameters to execute the DeleteLexicon operation on AmazonPollyClient.

callback AsyncCallback

An AsyncCallback delegate that is invoked when the operation completes.

state object

A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.

Returns

IAsyncResult

An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteLexicon operation.

See Also

BeginDescribeVoices(DescribeVoicesRequest, AsyncCallback, object)

Initiates the asynchronous execution of the DescribeVoices operation.

IAsyncResult BeginDescribeVoices(DescribeVoicesRequest request, AsyncCallback callback, object state)

Parameters

request DescribeVoicesRequest

Container for the necessary parameters to execute the DescribeVoices operation on AmazonPollyClient.

callback AsyncCallback

An AsyncCallback delegate that is invoked when the operation completes.

state object

A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.

Returns

IAsyncResult

An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeVoices operation.

See Also

BeginGetLexicon(GetLexiconRequest, AsyncCallback, object)

Initiates the asynchronous execution of the GetLexicon operation.

IAsyncResult BeginGetLexicon(GetLexiconRequest request, AsyncCallback callback, object state)

Parameters

request GetLexiconRequest

Container for the necessary parameters to execute the GetLexicon operation on AmazonPollyClient.

callback AsyncCallback

An AsyncCallback delegate that is invoked when the operation completes.

state object

A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.

Returns

IAsyncResult

An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetLexicon operation.

See Also

BeginGetSpeechSynthesisTask(GetSpeechSynthesisTaskRequest, AsyncCallback, object)

Initiates the asynchronous execution of the GetSpeechSynthesisTask operation.

IAsyncResult BeginGetSpeechSynthesisTask(GetSpeechSynthesisTaskRequest request, AsyncCallback callback, object state)

Parameters

request GetSpeechSynthesisTaskRequest

Container for the necessary parameters to execute the GetSpeechSynthesisTask operation on AmazonPollyClient.

callback AsyncCallback

An AsyncCallback delegate that is invoked when the operation completes.

state object

A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.

Returns

IAsyncResult

An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetSpeechSynthesisTask operation.

See Also

BeginListLexicons(ListLexiconsRequest, AsyncCallback, object)

Initiates the asynchronous execution of the ListLexicons operation.

IAsyncResult BeginListLexicons(ListLexiconsRequest request, AsyncCallback callback, object state)

Parameters

request ListLexiconsRequest

Container for the necessary parameters to execute the ListLexicons operation on AmazonPollyClient.

callback AsyncCallback

An AsyncCallback delegate that is invoked when the operation completes.

state object

A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.

Returns

IAsyncResult

An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListLexicons operation.

See Also

BeginListSpeechSynthesisTasks(ListSpeechSynthesisTasksRequest, AsyncCallback, object)

Initiates the asynchronous execution of the ListSpeechSynthesisTasks operation.

IAsyncResult BeginListSpeechSynthesisTasks(ListSpeechSynthesisTasksRequest request, AsyncCallback callback, object state)

Parameters

request ListSpeechSynthesisTasksRequest

Container for the necessary parameters to execute the ListSpeechSynthesisTasks operation on AmazonPollyClient.

callback AsyncCallback

An AsyncCallback delegate that is invoked when the operation completes.

state object

A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.

Returns

IAsyncResult

An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListSpeechSynthesisTasks operation.

See Also

BeginPutLexicon(PutLexiconRequest, AsyncCallback, object)

Initiates the asynchronous execution of the PutLexicon operation.

IAsyncResult BeginPutLexicon(PutLexiconRequest request, AsyncCallback callback, object state)

Parameters

request PutLexiconRequest

Container for the necessary parameters to execute the PutLexicon operation on AmazonPollyClient.

callback AsyncCallback

An AsyncCallback delegate that is invoked when the operation completes.

state object

A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.

Returns

IAsyncResult

An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutLexicon operation.

See Also

BeginStartSpeechSynthesisTask(StartSpeechSynthesisTaskRequest, AsyncCallback, object)

Initiates the asynchronous execution of the StartSpeechSynthesisTask operation.

IAsyncResult BeginStartSpeechSynthesisTask(StartSpeechSynthesisTaskRequest request, AsyncCallback callback, object state)

Parameters

request StartSpeechSynthesisTaskRequest

Container for the necessary parameters to execute the StartSpeechSynthesisTask operation on AmazonPollyClient.

callback AsyncCallback

An AsyncCallback delegate that is invoked when the operation completes.

state object

A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.

Returns

IAsyncResult

An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartSpeechSynthesisTask operation.

See Also

BeginSynthesizeSpeech(SynthesizeSpeechRequest, AsyncCallback, object)

Initiates the asynchronous execution of the SynthesizeSpeech operation.

IAsyncResult BeginSynthesizeSpeech(SynthesizeSpeechRequest request, AsyncCallback callback, object state)

Parameters

request SynthesizeSpeechRequest

Container for the necessary parameters to execute the SynthesizeSpeech operation on AmazonPollyClient.

callback AsyncCallback

An AsyncCallback delegate that is invoked when the operation completes.

state object

A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.

Returns

IAsyncResult

An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSynthesizeSpeech operation.

See Also

DeleteLexicon(DeleteLexiconRequest)

Deletes the specified pronunciation lexicon stored in an AWS Region. A lexicon which has been deleted is not available for speech synthesis, nor is it possible to retrieve it using either the 

GetLexicon
or 
ListLexicon
APIs.

For more information, see Managing Lexicons. 

DeleteLexiconResponse DeleteLexicon(DeleteLexiconRequest request)

Parameters

request DeleteLexiconRequest

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

Returns

DeleteLexiconResponse

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

Exceptions

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.

ServiceFailureException

An unknown condition has caused a service failure.

See Also

DescribeVoices(DescribeVoicesRequest)

Returns the list of voices that are available for use when requesting speech synthesis. Each voice speaks a specified language, is either male or female, and is identified by an ID, which is the ASCII version of the voice name.

When synthesizing speech ( 

SynthesizeSpeech
), you provide the voice ID for the voice you want from the list of voices returned by 
DescribeVoices
.

For example, you want your news reader application to read news in a specific language, but giving a user the option to choose the voice. Using the 

DescribeVoices
operation you can provide the user with a list of available voices to select from.

You can optionally specify a language code to filter the available voices. For example, if you specify 

en-US
, the operation returns a list of all available US English voices.

This operation requires permissions to perform the 

polly:DescribeVoices
action. 
DescribeVoicesResponse DescribeVoices(DescribeVoicesRequest request)

Parameters

request DescribeVoicesRequest

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

Returns

DescribeVoicesResponse

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

Exceptions

InvalidNextTokenException

The NextToken is invalid. Verify that it's spelled correctly, and then try again.

ServiceFailureException

An unknown condition has caused a service failure.

See Also

EndDeleteLexicon(IAsyncResult)

Finishes the asynchronous execution of the DeleteLexicon operation.

DeleteLexiconResponse EndDeleteLexicon(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult

The IAsyncResult returned by the call to BeginDeleteLexicon.

Returns

DeleteLexiconResponse

Returns a DeleteLexiconResult from Polly.

See Also

EndDescribeVoices(IAsyncResult)

Finishes the asynchronous execution of the DescribeVoices operation.

DescribeVoicesResponse EndDescribeVoices(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult

The IAsyncResult returned by the call to BeginDescribeVoices.

Returns

DescribeVoicesResponse

Returns a DescribeVoicesResult from Polly.

See Also

EndGetLexicon(IAsyncResult)

Finishes the asynchronous execution of the GetLexicon operation.

GetLexiconResponse EndGetLexicon(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult

The IAsyncResult returned by the call to BeginGetLexicon.

Returns

GetLexiconResponse

Returns a GetLexiconResult from Polly.

See Also

EndGetSpeechSynthesisTask(IAsyncResult)

Finishes the asynchronous execution of the GetSpeechSynthesisTask operation.

GetSpeechSynthesisTaskResponse EndGetSpeechSynthesisTask(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult

The IAsyncResult returned by the call to BeginGetSpeechSynthesisTask.

Returns

GetSpeechSynthesisTaskResponse

Returns a GetSpeechSynthesisTaskResult from Polly.

See Also

EndListLexicons(IAsyncResult)

Finishes the asynchronous execution of the ListLexicons operation.

ListLexiconsResponse EndListLexicons(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult

The IAsyncResult returned by the call to BeginListLexicons.

Returns

ListLexiconsResponse

Returns a ListLexiconsResult from Polly.

See Also

EndListSpeechSynthesisTasks(IAsyncResult)

Finishes the asynchronous execution of the ListSpeechSynthesisTasks operation.

ListSpeechSynthesisTasksResponse EndListSpeechSynthesisTasks(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult

The IAsyncResult returned by the call to BeginListSpeechSynthesisTasks.

Returns

ListSpeechSynthesisTasksResponse

Returns a ListSpeechSynthesisTasksResult from Polly.

See Also

EndPutLexicon(IAsyncResult)

Finishes the asynchronous execution of the PutLexicon operation.

PutLexiconResponse EndPutLexicon(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult

The IAsyncResult returned by the call to BeginPutLexicon.

Returns

PutLexiconResponse

Returns a PutLexiconResult from Polly.

See Also

EndStartSpeechSynthesisTask(IAsyncResult)

Finishes the asynchronous execution of the StartSpeechSynthesisTask operation.

StartSpeechSynthesisTaskResponse EndStartSpeechSynthesisTask(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult

The IAsyncResult returned by the call to BeginStartSpeechSynthesisTask.

Returns

StartSpeechSynthesisTaskResponse

Returns a StartSpeechSynthesisTaskResult from Polly.

See Also

EndSynthesizeSpeech(IAsyncResult)

Finishes the asynchronous execution of the SynthesizeSpeech operation.

SynthesizeSpeechResponse EndSynthesizeSpeech(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult

The IAsyncResult returned by the call to BeginSynthesizeSpeech.

Returns

SynthesizeSpeechResponse

Returns a SynthesizeSpeechResult from Polly.

See Also

GetLexicon(GetLexiconRequest)

Returns the content of the specified pronunciation lexicon stored in an AWS Region. For more information, see Managing Lexicons.

GetLexiconResponse GetLexicon(GetLexiconRequest request)

Parameters

request GetLexiconRequest

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

Returns

GetLexiconResponse

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

Exceptions

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.

ServiceFailureException

An unknown condition has caused a service failure.

See Also

GetSpeechSynthesisTask(GetSpeechSynthesisTaskRequest)

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.

GetSpeechSynthesisTaskResponse GetSpeechSynthesisTask(GetSpeechSynthesisTaskRequest request)

Parameters

request GetSpeechSynthesisTaskRequest

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

Returns

GetSpeechSynthesisTaskResponse

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

Exceptions

InvalidTaskIdException

The provided Task ID is not valid. Please provide a valid Task ID and try again.

ServiceFailureException

An unknown condition has caused a service failure.

SynthesisTaskNotFoundException

The Speech Synthesis task with requested Task ID cannot be found.

See Also

ListLexicons(ListLexiconsRequest)

Returns a list of pronunciation lexicons stored in an AWS Region. For more information, see Managing Lexicons.

ListLexiconsResponse ListLexicons(ListLexiconsRequest request)

Parameters

request ListLexiconsRequest

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

Returns

ListLexiconsResponse

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

Exceptions

InvalidNextTokenException

The NextToken is invalid. Verify that it's spelled correctly, and then try again.

ServiceFailureException

An unknown condition has caused a service failure.

See Also

ListSpeechSynthesisTasks(ListSpeechSynthesisTasksRequest)

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.

ListSpeechSynthesisTasksResponse ListSpeechSynthesisTasks(ListSpeechSynthesisTasksRequest request)

Parameters

request ListSpeechSynthesisTasksRequest

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

Returns

ListSpeechSynthesisTasksResponse

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

Exceptions

InvalidNextTokenException

The NextToken is invalid. Verify that it's spelled correctly, and then try again.

ServiceFailureException

An unknown condition has caused a service failure.

See Also

PutLexicon(PutLexiconRequest)

Stores a pronunciation lexicon in an AWS Region. If a lexicon with the same name already exists in the region, it is overwritten by the new lexicon. Lexicon operations have eventual consistency, therefore, it might take some time before the lexicon is available to the SynthesizeSpeech operation.

For more information, see Managing Lexicons. 

PutLexiconResponse PutLexicon(PutLexiconRequest request)

Parameters

request PutLexiconRequest

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

Returns

PutLexiconResponse

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

Exceptions

InvalidLexiconException

Amazon Polly can't find the specified lexicon. Verify that the lexicon's name is spelled correctly, and then try again.

LexiconSizeExceededException

The maximum size of the specified lexicon would be exceeded by this operation.

MaxLexemeLengthExceededException

The maximum size of the lexeme would be exceeded by this operation.

MaxLexiconsNumberExceededException

The maximum number of lexicons would be exceeded by this operation.

ServiceFailureException

An unknown condition has caused a service failure.

UnsupportedPlsAlphabetException

The alphabet specified by the lexicon is not a supported alphabet. Valid values are

x-sampa
and 
ipa
.
UnsupportedPlsLanguageException

The language specified in the lexicon is unsupported. For a list of supported languages, see Lexicon Attributes.

See Also

StartSpeechSynthesisTask(StartSpeechSynthesisTaskRequest)

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. 
StartSpeechSynthesisTaskResponse StartSpeechSynthesisTask(StartSpeechSynthesisTaskRequest request)

Parameters

request StartSpeechSynthesisTaskRequest

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

Returns

StartSpeechSynthesisTaskResponse

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

Exceptions

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.
See Also

SynthesizeSpeech(SynthesizeSpeechRequest)

Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes. SSML input must be valid, well-formed SSML. Some alphabets might not be available with all the voices (for example, Cyrillic might not be read at all by English voices) unless phoneme mapping is used. For more information, see How it Works.

SynthesizeSpeechResponse SynthesizeSpeech(SynthesizeSpeechRequest request)

Parameters

request SynthesizeSpeechRequest

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

Returns

SynthesizeSpeechResponse

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

Exceptions

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.

InvalidSampleRateException

The specified sample rate is not valid.

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.
See Also