com.amazonaws.services.polly

Interface AmazonPolly

All Known Subinterfaces:

AmazonPollyAsync

All Known Implementing Classes:

AbstractAmazonPolly, AbstractAmazonPollyAsync, AmazonPollyAsyncClient, AmazonPollyClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonPolly

Interface for accessing Amazon Polly.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonPolly instead.

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

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
DeleteLexiconResult	deleteLexicon(DeleteLexiconRequest deleteLexiconRequest) Deletes the specified pronunciation lexicon stored in an Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services Region.
ListSpeechSynthesisTasksResult	listSpeechSynthesisTasks(ListSpeechSynthesisTasksRequest listSpeechSynthesisTasksRequest) Returns a list of SpeechSynthesisTask objects ordered by their creation date.
AmazonPollyPresigners	presigners() AmazonPollyPresigners contains extension methods for presigning certain requests.
PutLexiconResult	putLexicon(PutLexiconRequest putLexiconRequest) Stores a pronunciation lexicon in an Amazon Web Services Region.
void	setEndpoint(String endpoint) Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
void	setRegion(Region region) Deprecated. use AwsClientBuilder#setRegion(String)
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.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

setEndpoint

@Deprecated
void setEndpoint(String endpoint)

Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));

Overrides the default endpoint for this client ("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: "polly.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "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: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint

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: "polly.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "polly.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setRegion

@Deprecated
void setRegion(Region region)

Deprecated. use AwsClientBuilder#setRegion(String)

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. Must not be null and must be a region where the service is available.

See Also:

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

deleteLexicon

DeleteLexiconResult deleteLexicon(DeleteLexiconRequest deleteLexiconRequest)

Deletes the specified pronunciation lexicon stored in an Amazon Web Services 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:

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

Samples:

• To delete a lexicon

  Deletes a specified pronunciation lexicon stored in an AWS Region.
  

  AmazonPolly client = AmazonPollyClientBuilder.standard().build();
  DeleteLexiconRequest request = new DeleteLexiconRequest().withName("example");
  DeleteLexiconResult response = client.deleteLexicon(request);

describeVoices

DescribeVoicesResult describeVoices(DescribeVoicesRequest 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.

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

Samples:

• To describe available voices

  Returns the list of voices that are available for use when requesting speech synthesis. Displayed languages are those within the specified language code. If no language code is specified, voices for all available languages are displayed.
  

  AmazonPolly client = AmazonPollyClientBuilder.standard().build();
  DescribeVoicesRequest request = new DescribeVoicesRequest().withLanguageCode("en-GB");
  DescribeVoicesResult response = client.describeVoices(request);

getLexicon

GetLexiconResult getLexicon(GetLexiconRequest getLexiconRequest)

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

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

Samples:

• To retrieve a lexicon

  Returns the content of the specified pronunciation lexicon stored in an AWS Region.
  

  AmazonPolly client = AmazonPollyClientBuilder.standard().build();
  GetLexiconRequest request = new GetLexiconRequest().withName("");
  GetLexiconResult response = client.getLexicon(request);

getSpeechSynthesisTask

GetSpeechSynthesisTaskResult getSpeechSynthesisTask(GetSpeechSynthesisTaskRequest 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.

Parameters:

getSpeechSynthesisTaskRequest -

Returns:

Result of the GetSpeechSynthesisTask operation returned by the service.

Throws:

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:

AWS API Documentation

listLexicons

ListLexiconsResult listLexicons(ListLexiconsRequest listLexiconsRequest)

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

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

Samples:

• To list all lexicons in a region

  Returns a list of pronunciation lexicons stored in an AWS Region.
  

  AmazonPolly client = AmazonPollyClientBuilder.standard().build();
  ListLexiconsRequest request = new ListLexiconsRequest();
  ListLexiconsResult response = client.listLexicons(request);

listSpeechSynthesisTasks

ListSpeechSynthesisTasksResult listSpeechSynthesisTasks(ListSpeechSynthesisTasksRequest 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.

Parameters:

listSpeechSynthesisTasksRequest -

Returns:

Result of the ListSpeechSynthesisTasks 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

PutLexiconResult putLexicon(PutLexiconRequest putLexiconRequest)

Stores a pronunciation lexicon in an Amazon Web Services 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:

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

Samples:

• To save a lexicon

  Stores a pronunciation lexicon in an AWS Region.
  

  AmazonPolly client = AmazonPollyClientBuilder.standard().build();
  PutLexiconRequest request = new PutLexiconRequest().withName("W3C").withContent("file://example.pls");
  PutLexiconResult response = client.putLexicon(request);

startSpeechSynthesisTask

StartSpeechSynthesisTaskResult startSpeechSynthesisTask(StartSpeechSynthesisTaskRequest 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. The SpeechSynthesisTask object is available for 72 hours after starting the asynchronous synthesis task.

Parameters:

startSpeechSynthesisTaskRequest -

Returns:

Result of the StartSpeechSynthesisTask operation returned by the service.

Throws:

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.

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.

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.

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.

LanguageNotSupportedException - The language specified is not currently supported by Amazon Polly in this capacity.

See Also:

AWS API Documentation

synthesizeSpeech

SynthesizeSpeechResult synthesizeSpeech(SynthesizeSpeechRequest 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.

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

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.

LanguageNotSupportedException - The language specified is not currently supported by Amazon Polly in this capacity.

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.

See Also:

AWS API Documentation

Samples:

• To synthesize speech

  Synthesizes plain text or SSML into a file of human-like speech.
  

  AmazonPolly client = AmazonPollyClientBuilder.standard().build();
  SynthesizeSpeechRequest request = new SynthesizeSpeechRequest().withLexiconNames("example").withOutputFormat("mp3").withSampleRate("8000")
          .withText("All Gaul is divided into three parts").withTextType("text").withVoiceId("Joanna");
  SynthesizeSpeechResult response = client.synthesizeSpeech(request);

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.

presigners

AmazonPollyPresigners presigners()

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

Returns:

Presigners utility object.