com.amazonaws.services.polly

Interface AmazonPolly

All Known Implementing Classes:

AmazonPollyClient, AmazonPollyPresigningClient

public interface AmazonPolly

Interface for accessing Amazon 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.

Method Summary

Modifier and Type	Method and Description
DeleteLexiconResult	deleteLexicon(DeleteLexiconRequest deleteLexiconRequest) Deletes the specified pronunciation lexicon stored in an AWS Region.
DescribeVoicesResult	describeVoices(DescribeVoicesRequest describeVoicesRequest) Returns the list of voices that are available for use when requesting speech synthesis.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetLexiconResult	getLexicon(GetLexiconRequest getLexiconRequest) Returns the content of the specified pronunciation lexicon stored in an AWS Region.
GetSpeechSynthesisTaskResult	getSpeechSynthesisTask(GetSpeechSynthesisTaskRequest getSpeechSynthesisTaskRequest) Retrieves a specific SpeechSynthesisTask object based on its TaskID.
ListLexiconsResult	listLexicons(ListLexiconsRequest listLexiconsRequest) Returns a list of pronunciation lexicons stored in an AWS Region.
ListSpeechSynthesisTasksResult	listSpeechSynthesisTasks(ListSpeechSynthesisTasksRequest listSpeechSynthesisTasksRequest) Returns a list of SpeechSynthesisTask objects ordered by their creation date.
PutLexiconResult	putLexicon(PutLexiconRequest putLexiconRequest) Stores a pronunciation lexicon in an AWS Region.
void	setEndpoint(java.lang.String endpoint) Overrides the default endpoint for this client ("https://https://polly.us-east-1.amazonaws.com").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartSpeechSynthesisTaskResult	startSpeechSynthesisTask(StartSpeechSynthesisTaskRequest startSpeechSynthesisTaskRequest) Allows the creation of an asynchronous synthesis task, by starting a new SpeechSynthesisTask.
SynthesizeSpeechResult	synthesizeSpeech(SynthesizeSpeechRequest synthesizeSpeechRequest) Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.

Method Detail

setEndpoint

void setEndpoint(java.lang.String endpoint)
          throws java.lang.IllegalArgumentException

Overrides the default endpoint for this client ("https://https://polly.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "https://polly.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://https://polly.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "https://polly.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://https://polly.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

Throws:

java.lang.IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
        throws java.lang.IllegalArgumentException

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

java.lang.IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

deleteLexicon

DeleteLexiconResult deleteLexicon(DeleteLexiconRequest deleteLexiconRequest)
                           throws AmazonClientException,
                                  AmazonServiceException

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.

Parameters:

deleteLexiconRequest -

Returns:

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

Throws:

LexiconNotFoundException

ServiceFailureException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Polly indicating either a problem with the data in the request, or a server side issue.

describeVoices

DescribeVoicesResult describeVoices(DescribeVoicesRequest describeVoicesRequest)
                             throws AmazonClientException,
                                    AmazonServiceException

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.

Parameters:

describeVoicesRequest -

Returns:

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

Throws:

InvalidNextTokenException

ServiceFailureException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Polly indicating either a problem with the data in the request, or a server side issue.

getLexicon

GetLexiconResult getLexicon(GetLexiconRequest getLexiconRequest)
                     throws AmazonClientException,
                            AmazonServiceException

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

Parameters:

getLexiconRequest -

Returns:

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

Throws:

LexiconNotFoundException

ServiceFailureException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Polly indicating either a problem with the data in the request, or a server side issue.

getSpeechSynthesisTask

GetSpeechSynthesisTaskResult getSpeechSynthesisTask(GetSpeechSynthesisTaskRequest getSpeechSynthesisTaskRequest)
                                             throws AmazonClientException,
                                                    AmazonServiceException

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.

Parameters:

getSpeechSynthesisTaskRequest -

Returns:

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

Throws:

InvalidTaskIdException

ServiceFailureException

SynthesisTaskNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Polly indicating either a problem with the data in the request, or a server side issue.

listLexicons

ListLexiconsResult listLexicons(ListLexiconsRequest listLexiconsRequest)
                         throws AmazonClientException,
                                AmazonServiceException

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

Parameters:

listLexiconsRequest -

Returns:

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

Throws:

InvalidNextTokenException

ServiceFailureException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Polly indicating either a problem with the data in the request, or a server side issue.

listSpeechSynthesisTasks

ListSpeechSynthesisTasksResult listSpeechSynthesisTasks(ListSpeechSynthesisTasksRequest listSpeechSynthesisTasksRequest)
                                                 throws AmazonClientException,
                                                        AmazonServiceException

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:

listSpeechSynthesisTasksRequest -

Returns:

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

Throws:

InvalidNextTokenException

ServiceFailureException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Polly indicating either a problem with the data in the request, or a server side issue.

putLexicon

PutLexiconResult putLexicon(PutLexiconRequest putLexiconRequest)
                     throws AmazonClientException,
                            AmazonServiceException

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.

Parameters:

putLexiconRequest -

Returns:

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

Throws:

InvalidLexiconException

UnsupportedPlsAlphabetException

UnsupportedPlsLanguageException

LexiconSizeExceededException

MaxLexemeLengthExceededException

MaxLexiconsNumberExceededException

ServiceFailureException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Polly indicating either a problem with the data in the request, or a server side issue.

startSpeechSynthesisTask

StartSpeechSynthesisTaskResult startSpeechSynthesisTask(StartSpeechSynthesisTaskRequest startSpeechSynthesisTaskRequest)
                                                 throws AmazonClientException,
                                                        AmazonServiceException

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.

Parameters:

startSpeechSynthesisTaskRequest -

Returns:

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

Throws:

TextLengthExceededException

InvalidS3BucketException

InvalidS3KeyException

InvalidSampleRateException

InvalidSnsTopicArnException

InvalidSsmlException

EngineNotSupportedException

LexiconNotFoundException

ServiceFailureException

MarksNotSupportedForFormatException

SsmlMarksNotSupportedForTextTypeException

LanguageNotSupportedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Polly indicating either a problem with the data in the request, or a server side issue.

synthesizeSpeech

SynthesizeSpeechResult synthesizeSpeech(SynthesizeSpeechRequest synthesizeSpeechRequest)
                                 throws AmazonClientException,
                                        AmazonServiceException

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.

Parameters:

synthesizeSpeechRequest -

Returns:

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

Throws:

TextLengthExceededException

InvalidSampleRateException

InvalidSsmlException

LexiconNotFoundException

ServiceFailureException

MarksNotSupportedForFormatException

SsmlMarksNotSupportedForTextTypeException

LanguageNotSupportedException

EngineNotSupportedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Polly indicating either a problem with the data in the request, or a server side issue.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.