@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonPollyClient extends AmazonWebServiceClient implements AmazonPolly
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AmazonPollyClient()
Deprecated.
|
AmazonPollyClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonPollyClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AmazonPollyClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AmazonPollyClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonPollyClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonPollyClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AmazonPollyClient(ClientConfiguration clientConfiguration)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static AmazonPollyClientBuilder |
builder() |
DeleteLexiconResult |
deleteLexicon(DeleteLexiconRequest request)
Deletes the specified pronunciation lexicon stored in an Amazon Web Services 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 Amazon Web Services Region.
|
GetSpeechSynthesisTaskResult |
getSpeechSynthesisTask(GetSpeechSynthesisTaskRequest request)
Retrieves a specific SpeechSynthesisTask object based on its TaskID.
|
ListLexiconsResult |
listLexicons(ListLexiconsRequest request)
Returns a list of pronunciation lexicons stored in an Amazon Web Services Region.
|
ListSpeechSynthesisTasksResult |
listSpeechSynthesisTasks(ListSpeechSynthesisTasksRequest request)
Returns a list of SpeechSynthesisTask objects ordered by their creation date.
|
AmazonPollyPresigners |
presigners()
AmazonPollyPresigners contains extension methods for presigning
certain requests. |
PutLexiconResult |
putLexicon(PutLexiconRequest request)
Stores a pronunciation lexicon in an Amazon Web Services Region.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartSpeechSynthesisTaskResult |
startSpeechSynthesisTask(StartSpeechSynthesisTaskRequest request)
Allows the creation of an asynchronous synthesis task, by starting a new
SpeechSynthesisTask. |
SynthesizeSpeechResult |
synthesizeSpeech(SynthesizeSpeechRequest request)
Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion@Deprecated public AmazonPollyClient()
AmazonPollyClientBuilder.defaultClient()All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AmazonPollyClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client connects to Amazon Polly (ex: proxy settings,
retry counts, etc.).DefaultAWSCredentialsProviderChain@Deprecated public AmazonPollyClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonPollyClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AmazonPollyClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
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.).@Deprecated public AmazonPollyClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AmazonPollyClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
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.).@Deprecated public AmazonPollyClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)All service calls made using this new client object are blocking, and will not return until the service call completes.
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 collectorpublic static AmazonPollyClientBuilder builder()
public DeleteLexiconResult deleteLexicon(DeleteLexiconRequest request)
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.
deleteLexicon in interface AmazonPollydeleteLexiconRequest - 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);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.
describeVoices in interface AmazonPollydescribeVoicesRequest - 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);public GetLexiconResult getLexicon(GetLexiconRequest request)
Returns the content of the specified pronunciation lexicon stored in an Amazon Web Services Region. For more information, see Managing Lexicons.
getLexicon in interface AmazonPollygetLexiconRequest - 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);public GetSpeechSynthesisTaskResult getSpeechSynthesisTask(GetSpeechSynthesisTaskRequest request)
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.
getSpeechSynthesisTask in interface AmazonPollygetSpeechSynthesisTaskRequest - 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.public ListLexiconsResult listLexicons(ListLexiconsRequest request)
Returns a list of pronunciation lexicons stored in an Amazon Web Services Region. For more information, see Managing Lexicons.
listLexicons in interface AmazonPollylistLexiconsRequest - 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);
public ListSpeechSynthesisTasksResult listSpeechSynthesisTasks(ListSpeechSynthesisTasksRequest request)
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.
listSpeechSynthesisTasks in interface AmazonPollylistSpeechSynthesisTasksRequest - InvalidNextTokenException - The NextToken is invalid. Verify that it's spelled correctly, and then try again.ServiceFailureException - An unknown condition has caused a service failure.public PutLexiconResult putLexicon(PutLexiconRequest request)
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.
putLexicon in interface AmazonPollyputLexiconRequest - 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);public StartSpeechSynthesisTaskResult startSpeechSynthesisTask(StartSpeechSynthesisTaskRequest request)
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.
startSpeechSynthesisTask in interface AmazonPollystartSpeechSynthesisTaskRequest - 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.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.
synthesizeSpeech in interface AmazonPollysynthesizeSpeechRequest - 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);public 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 the request.
getCachedResponseMetadata in interface AmazonPollyrequest - The originally executed requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AmazonPollyshutdown in class AmazonWebServiceClientpublic AmazonPollyPresigners presigners()
AmazonPollyAmazonPollyPresigners contains extension methods for presigning
certain requests. The presigner will use the endpoint and credentials currently configured in the client.presigners in interface AmazonPolly