@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonPolly
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| 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.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
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.
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.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)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.
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.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String) 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.
deleteLexiconRequest - 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.AmazonPolly client = AmazonPollyClientBuilder.standard().build();
DeleteLexiconRequest request = new DeleteLexiconRequest().withName("example");
DeleteLexiconResult response = client.deleteLexicon(request);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.
describeVoicesRequest - InvalidNextTokenException - The NextToken is invalid. Verify that it's spelled correctly, and then try again.ServiceFailureException - An unknown condition has caused a service failure.AmazonPolly client = AmazonPollyClientBuilder.standard().build();
DescribeVoicesRequest request = new DescribeVoicesRequest().withLanguageCode("en-GB");
DescribeVoicesResult response = client.describeVoices(request);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.
getLexiconRequest - 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.AmazonPolly client = AmazonPollyClientBuilder.standard().build();
GetLexiconRequest request = new GetLexiconRequest().withName("");
GetLexiconResult response = client.getLexicon(request);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.
getSpeechSynthesisTaskRequest - 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.ListLexiconsResult listLexicons(ListLexiconsRequest listLexiconsRequest)
Returns a list of pronunciation lexicons stored in an Amazon Web Services Region. For more information, see Managing Lexicons.
listLexiconsRequest - InvalidNextTokenException - The NextToken is invalid. Verify that it's spelled correctly, and then try again.ServiceFailureException - An unknown condition has caused a service failure.AmazonPolly client = AmazonPollyClientBuilder.standard().build(); ListLexiconsRequest request = new ListLexiconsRequest(); ListLexiconsResult response = client.listLexicons(request);
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.
listSpeechSynthesisTasksRequest - InvalidNextTokenException - The NextToken is invalid. Verify that it's spelled correctly, and then try again.ServiceFailureException - An unknown condition has caused a service failure.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.
putLexiconRequest - 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.AmazonPolly client = AmazonPollyClientBuilder.standard().build();
PutLexiconRequest request = new PutLexiconRequest().withName("W3C").withContent("file://example.pls");
PutLexiconResult response = client.putLexicon(request);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.
startSpeechSynthesisTaskRequest - 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.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.
synthesizeSpeechRequest - 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.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);void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request - The originally executed request.AmazonPollyPresigners presigners()
AmazonPollyPresigners contains extension methods for presigning
certain requests. The presigner will use the endpoint and credentials currently configured in the client.