com.amazonaws.services.polly

Class AmazonPollyClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.polly.AmazonPollyClient

All Implemented Interfaces:

AmazonPolly

Direct Known Subclasses:

AmazonPollyAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
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

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

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AmazonPollyClient() Deprecated. use AmazonPollyClientBuilder.defaultClient()
AmazonPollyClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonPollyClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
AmazonPollyClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AmazonPollyClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AmazonPollyClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AmazonPollyClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
AmazonPollyClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
static AmazonPollyClientBuilder	builder()
DeleteLexiconResult	deleteLexicon(DeleteLexiconRequest request) Deletes the specified pronunciation lexicon stored in an AWS Region.
DescribeVoicesResult	describeVoices(DescribeVoicesRequest request) 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 request) Returns the content of the specified pronunciation lexicon stored in an AWS Region.
ListLexiconsResult	listLexicons(ListLexiconsRequest request) Returns a list of pronunciation lexicons stored in an AWS Region.
AmazonPollyPresigners	presigners() AmazonPollyPresigners contains extension methods for presigning certain requests.
PutLexiconResult	putLexicon(PutLexiconRequest request) Stores a pronunciation lexicon in an AWS Region.
SynthesizeSpeechResult	synthesizeSpeech(SynthesizeSpeechRequest request) Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, 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. use AmazonPollyClientBuilder.defaultClient()

Constructs a new client to invoke service methods on Amazon Polly. 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. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Amazon Polly. 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 Amazon Polly (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonPollyClient

@Deprecated
public AmazonPollyClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonPollyClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();

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

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

@Deprecated
public AmazonPollyClient(AWSCredentials awsCredentials,
                                     ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

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

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 Amazon Polly (ex: proxy settings, retry counts, etc.).

AmazonPollyClient

@Deprecated
public AmazonPollyClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

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

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

@Deprecated
public AmazonPollyClient(AWSCredentialsProvider awsCredentialsProvider,
                                     ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

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

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 Amazon Polly (ex: proxy settings, retry counts, etc.).

AmazonPollyClient

@Deprecated
public AmazonPollyClient(AWSCredentialsProvider awsCredentialsProvider,
                                     ClientConfiguration clientConfiguration,
                                     RequestMetricCollector requestMetricCollector)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)

Constructs a new client to invoke service methods on Amazon Polly 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 Amazon Polly (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

builder

public static AmazonPollyClientBuilder builder()

deleteLexicon

public DeleteLexiconResult deleteLexicon(DeleteLexiconRequest request)

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:

Result of the DeleteLexicon operation returned by the service.

Throws:

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:

AWS API Documentation

describeVoices

public DescribeVoicesResult describeVoices(DescribeVoicesRequest request)

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:

Result of the DescribeVoices operation returned by the service.

Throws:

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:

AWS API Documentation

getLexicon

public GetLexiconResult getLexicon(GetLexiconRequest request)

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:

Result of the GetLexicon operation returned by the service.

Throws:

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:

AWS API Documentation

listLexicons

public ListLexiconsResult listLexicons(ListLexiconsRequest request)

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:

Result of the ListLexicons operation returned by the service.

Throws:

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:

AWS API Documentation

putLexicon

public PutLexiconResult putLexicon(PutLexiconRequest request)

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:

Result of the PutLexicon operation returned by the service.

Throws:

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

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.

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.

See Also:

AWS API Documentation

synthesizeSpeech

public SynthesizeSpeechResult synthesizeSpeech(SynthesizeSpeechRequest request)

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:

Result of the SynthesizeSpeech operation returned by the service.

Throws:

TextLengthExceededException - The value of the "Text" parameter is longer than the accepted limits. The limit for input text is a maximum of 3000 characters total, of which no more than 1500 can be billed characters. SSML tags are not counted as billed characters.

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.

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.

MarksNotSupportedForFormatException - Speech marks are not supported for the OutputFormat selected. Speech marks are only available for content in json format.

SsmlMarksNotSupportedForTextTypeException - SSML speech marks are not supported for plain text-type input.

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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 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.

presigners

public AmazonPollyPresigners presigners()

Description copied from interface: AmazonPolly

AmazonPollyPresigners contains extension methods for presigning certain requests. The presigner will use the endpoint and credentials currently configured in the client.

Specified by:

presigners in interface AmazonPolly

Returns:

Presigners utility object.