Namespace Amazon.Polly.Model

Classes

Container for the parameters to the DeleteLexicon operation. 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

ListLexicon

APIs.

For more information, see Managing Lexicons.

DeleteLexiconResponse: This is the response object from the DeleteLexicon operation.

DescribeVoicesRequest

Container for the parameters to the DescribeVoices operation. 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: This is the response object from the DescribeVoices operation.

GetLexiconRequest: Container for the parameters to the GetLexicon operation. Returns the content of the specified pronunciation lexicon stored in an AWS Region. For more information, see Managing Lexicons.

GetLexiconResponse: This is the response object from the GetLexicon operation.

GetSpeechSynthesisTaskRequest: Container for the parameters to the GetSpeechSynthesisTask operation. 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: This is the response object from the GetSpeechSynthesisTask operation.

InvalidLexiconException: Polly exception

InvalidNextTokenException: Polly exception

InvalidS3BucketException: Polly exception

InvalidS3KeyException: Polly exception

InvalidSampleRateException: Polly exception

InvalidSnsTopicArnException: Polly exception

InvalidSsmlException: Polly exception

InvalidTaskIdException: Polly exception

LanguageNotSupportedException: Polly exception

Lexicon: Provides lexicon name and lexicon content in string format. For more information, see Pronunciation Lexicon Specification (PLS) Version 1.0.

LexiconAttributes: Contains metadata describing the lexicon such as the number of lexemes, language code, and so on. For more information, see Managing Lexicons.

LexiconDescription: Describes the content of the lexicon.

LexiconNotFoundException: Polly exception

LexiconSizeExceededException: Polly exception

ListLexiconsRequest: Container for the parameters to the ListLexicons operation. Returns a list of pronunciation lexicons stored in an AWS Region. For more information, see Managing Lexicons.

ListLexiconsResponse: This is the response object from the ListLexicons operation.

ListSpeechSynthesisTasksRequest: Container for the parameters to the ListSpeechSynthesisTasks operation. 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: This is the response object from the ListSpeechSynthesisTasks operation.

MarksNotSupportedForFormatException: Polly exception

MaxLexemeLengthExceededException: Polly exception

MaxLexiconsNumberExceededException: Polly exception

PutLexiconRequest

Container for the parameters to the PutLexicon operation. 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: This is the response object from the PutLexicon operation.

ServiceFailureException: Polly exception

SsmlMarksNotSupportedForTextTypeException: Polly exception

StartSpeechSynthesisTaskRequest

Container for the parameters to the StartSpeechSynthesisTask operation. 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: This is the response object from the StartSpeechSynthesisTask operation.

SynthesisTask: SynthesisTask object that provides information about a speech synthesis task.

SynthesisTaskNotFoundException: Polly exception

SynthesizeSpeechRequest: Container for the parameters to the SynthesizeSpeech operation. 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: This is the response object from the SynthesizeSpeech operation.

TextLengthExceededException: Polly exception

UnsupportedPlsAlphabetException: Polly exception

UnsupportedPlsLanguageException: Polly exception

Voice: Description of the voice.

Table of Contents

Namespace Amazon.Polly.Model

Classes