com.amazonaws.services.polly

Class AmazonPollyClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.polly.AmazonPollyClient

All Implemented Interfaces:

AmazonPolly

Direct Known Subclasses:

AmazonPollyPresigningClient

public class AmazonPollyClient
extends AmazonWebServiceClient
implements AmazonPolly

Client for accessing Amazon Polly. All service calls made using this client are blocking, and will not return until the service call completes.

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.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Constructor Summary

Constructors

Constructor and Description
AmazonPollyClient() Deprecated.
AmazonPollyClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AmazonPolly using the specified AWS account credentials.
AmazonPollyClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonPolly using the specified AWS account credentials and client configuration options.
AmazonPollyClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AmazonPolly using the specified AWS account credentials provider.
AmazonPollyClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonPolly using the specified AWS account credentials provider and client configuration options.
AmazonPollyClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, HttpClient httpClient) Constructs a new client to invoke service methods on AmazonPolly using the specified AWS account credentials provider, client configuration options and request metric collector.
AmazonPollyClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, com.amazonaws.metrics.RequestMetricCollector requestMetricCollector) Deprecated.
AmazonPollyClient(ClientConfiguration clientConfiguration) Deprecated.

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) Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.
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.
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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, getEndpoint, getEndpointPrefix, getRegions, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.polly.AmazonPolly

setEndpoint, setRegion, shutdown

Constructor Detail

AmazonPollyClient

@Deprecated
public AmazonPollyClient()

Deprecated.

Constructs a new client to invoke service methods on AmazonPolly. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AmazonPollyClient

@Deprecated
public AmazonPollyClient(ClientConfiguration clientConfiguration)

Deprecated.

Constructs a new client to invoke service methods on AmazonPolly. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AmazonPolly (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonPollyClient

public AmazonPollyClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AmazonPolly using the specified AWS account credentials.

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonPollyClient client = new AmazonPollyClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonPollyClient

public AmazonPollyClient(AWSCredentials awsCredentials,
                         ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonPolly using the specified AWS account credentials and client configuration options.

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonPollyClient client = new AmazonPollyClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonPolly (ex: proxy settings, retry counts, etc.).

AmazonPollyClient

public AmazonPollyClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AmazonPolly using the specified AWS account credentials provider.

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonPollyClient client = new AmazonPollyClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonPollyClient

public AmazonPollyClient(AWSCredentialsProvider awsCredentialsProvider,
                         ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonPolly using the specified AWS account credentials provider and client configuration options.

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonPollyClient client = new AmazonPollyClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonPolly (ex: proxy settings, retry counts, etc.).

AmazonPollyClient

@Deprecated
public AmazonPollyClient(AWSCredentialsProvider awsCredentialsProvider,
                                     ClientConfiguration clientConfiguration,
                                     com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)

Deprecated.

Constructs a new client to invoke service methods on AmazonPolly using the specified AWS account credentials provider, client configuration options and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonPolly (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

AmazonPollyClient

public AmazonPollyClient(AWSCredentialsProvider awsCredentialsProvider,
                         ClientConfiguration clientConfiguration,
                         HttpClient httpClient)

Constructs a new client to invoke service methods on AmazonPolly using the specified AWS account credentials provider, client configuration options and request metric collector.

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonPollyClient client = new AmazonPollyClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonPolly (ex: proxy settings, retry counts, etc.).

httpClient - A http client

Method Detail

deleteLexicon

public DeleteLexiconResult deleteLexicon(DeleteLexiconRequest deleteLexiconRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

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.

Specified by:

deleteLexicon in interface AmazonPolly

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

public DescribeVoicesResult describeVoices(DescribeVoicesRequest describeVoicesRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

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.

Specified by:

describeVoices in interface AmazonPolly

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

public GetLexiconResult getLexicon(GetLexiconRequest getLexiconRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

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

Specified by:

getLexicon in interface AmazonPolly

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

public GetSpeechSynthesisTaskResult getSpeechSynthesisTask(GetSpeechSynthesisTaskRequest getSpeechSynthesisTaskRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

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.

Specified by:

getSpeechSynthesisTask in interface AmazonPolly

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

public ListLexiconsResult listLexicons(ListLexiconsRequest listLexiconsRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

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

Specified by:

listLexicons in interface AmazonPolly

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

public ListSpeechSynthesisTasksResult listSpeechSynthesisTasks(ListSpeechSynthesisTasksRequest listSpeechSynthesisTasksRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

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.

Specified by:

listSpeechSynthesisTasks in interface AmazonPolly

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

public PutLexiconResult putLexicon(PutLexiconRequest putLexiconRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

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.

Specified by:

putLexicon in interface AmazonPolly

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

public StartSpeechSynthesisTaskResult startSpeechSynthesisTask(StartSpeechSynthesisTaskRequest startSpeechSynthesisTaskRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

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.

Specified by:

startSpeechSynthesisTask in interface AmazonPolly

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

public SynthesizeSpeechResult synthesizeSpeech(SynthesizeSpeechRequest synthesizeSpeechRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

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.

Specified by:

synthesizeSpeech in interface AmazonPolly

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.

getCachedResponseMetadata

@Deprecated
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.

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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonPolly

Parameters:

request - The originally executed request

Returns:

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