@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonPollyAsyncClient extends AmazonPollyClient implements AmazonPollyAsync
AsyncHandler can be used to receive
notification when an asynchronous operation 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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AmazonPollyAsyncClient()
Deprecated.
|
AmazonPollyAsyncClient(AWSCredentials awsCredentials)
Deprecated.
|
AmazonPollyAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AmazonPollyAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
|
AmazonPollyAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonPollyAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonPollyAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AmazonPollyAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
|
AmazonPollyAsyncClient(ClientConfiguration clientConfiguration)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static AmazonPollyAsyncClientBuilder |
asyncBuilder() |
Future<DeleteLexiconResult> |
deleteLexiconAsync(DeleteLexiconRequest request)
Deletes the specified pronunciation lexicon stored in an AWS Region.
|
Future<DeleteLexiconResult> |
deleteLexiconAsync(DeleteLexiconRequest request,
AsyncHandler<DeleteLexiconRequest,DeleteLexiconResult> asyncHandler)
Deletes the specified pronunciation lexicon stored in an AWS Region.
|
Future<DescribeVoicesResult> |
describeVoicesAsync(DescribeVoicesRequest request)
Returns the list of voices that are available for use when requesting speech synthesis.
|
Future<DescribeVoicesResult> |
describeVoicesAsync(DescribeVoicesRequest request,
AsyncHandler<DescribeVoicesRequest,DescribeVoicesResult> asyncHandler)
Returns the list of voices that are available for use when requesting speech synthesis.
|
ExecutorService |
getExecutorService()
Returns the executor service used by this client to execute async requests.
|
Future<GetLexiconResult> |
getLexiconAsync(GetLexiconRequest request)
Returns the content of the specified pronunciation lexicon stored in an AWS Region.
|
Future<GetLexiconResult> |
getLexiconAsync(GetLexiconRequest request,
AsyncHandler<GetLexiconRequest,GetLexiconResult> asyncHandler)
Returns the content of the specified pronunciation lexicon stored in an AWS Region.
|
Future<GetSpeechSynthesisTaskResult> |
getSpeechSynthesisTaskAsync(GetSpeechSynthesisTaskRequest request)
Retrieves a specific SpeechSynthesisTask object based on its TaskID.
|
Future<GetSpeechSynthesisTaskResult> |
getSpeechSynthesisTaskAsync(GetSpeechSynthesisTaskRequest request,
AsyncHandler<GetSpeechSynthesisTaskRequest,GetSpeechSynthesisTaskResult> asyncHandler)
Retrieves a specific SpeechSynthesisTask object based on its TaskID.
|
Future<ListLexiconsResult> |
listLexiconsAsync(ListLexiconsRequest request)
Returns a list of pronunciation lexicons stored in an AWS Region.
|
Future<ListLexiconsResult> |
listLexiconsAsync(ListLexiconsRequest request,
AsyncHandler<ListLexiconsRequest,ListLexiconsResult> asyncHandler)
Returns a list of pronunciation lexicons stored in an AWS Region.
|
Future<ListSpeechSynthesisTasksResult> |
listSpeechSynthesisTasksAsync(ListSpeechSynthesisTasksRequest request)
Returns a list of SpeechSynthesisTask objects ordered by their creation date.
|
Future<ListSpeechSynthesisTasksResult> |
listSpeechSynthesisTasksAsync(ListSpeechSynthesisTasksRequest request,
AsyncHandler<ListSpeechSynthesisTasksRequest,ListSpeechSynthesisTasksResult> asyncHandler)
Returns a list of SpeechSynthesisTask objects ordered by their creation date.
|
Future<PutLexiconResult> |
putLexiconAsync(PutLexiconRequest request)
Stores a pronunciation lexicon in an AWS Region.
|
Future<PutLexiconResult> |
putLexiconAsync(PutLexiconRequest request,
AsyncHandler<PutLexiconRequest,PutLexiconResult> asyncHandler)
Stores a pronunciation lexicon in an AWS Region.
|
void |
shutdown()
Shuts down the client, releasing all managed resources.
|
Future<StartSpeechSynthesisTaskResult> |
startSpeechSynthesisTaskAsync(StartSpeechSynthesisTaskRequest request)
Allows the creation of an asynchronous synthesis task, by starting a new
SpeechSynthesisTask. |
Future<StartSpeechSynthesisTaskResult> |
startSpeechSynthesisTaskAsync(StartSpeechSynthesisTaskRequest request,
AsyncHandler<StartSpeechSynthesisTaskRequest,StartSpeechSynthesisTaskResult> asyncHandler)
Allows the creation of an asynchronous synthesis task, by starting a new
SpeechSynthesisTask. |
Future<SynthesizeSpeechResult> |
synthesizeSpeechAsync(SynthesizeSpeechRequest request)
Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.
|
Future<SynthesizeSpeechResult> |
synthesizeSpeechAsync(SynthesizeSpeechRequest request,
AsyncHandler<SynthesizeSpeechRequest,SynthesizeSpeechResult> asyncHandler)
Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.
|
builder, deleteLexicon, describeVoices, getCachedResponseMetadata, getLexicon, getSpeechSynthesisTask, listLexicons, listSpeechSynthesisTasks, presigners, putLexicon, startSpeechSynthesisTask, synthesizeSpeechaddRequestHandler, 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, waitdeleteLexicon, describeVoices, getCachedResponseMetadata, getLexicon, getSpeechSynthesisTask, listLexicons, listSpeechSynthesisTasks, presigners, putLexicon, setEndpoint, setRegion, startSpeechSynthesisTask, synthesizeSpeech@Deprecated public AmazonPollyAsyncClient()
AmazonPollyAsyncClientBuilder.defaultClient()Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
@Deprecated public AmazonPollyAsyncClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
clientConfiguration - The client configuration options controlling how this client connects to Amazon Polly (ex: proxy settings,
retry counts, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)@Deprecated public AmazonPollyAsyncClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.Executors.newFixedThreadPool(int)@Deprecated public AmazonPollyAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.executorService - The executor service by which all asynchronous requests will be executed.@Deprecated public AmazonPollyAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).executorService - The executor service by which all asynchronous requests will be executed.@Deprecated public AmazonPollyAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.Executors.newFixedThreadPool(int)@Deprecated public AmazonPollyAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)@Deprecated public AmazonPollyAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.executorService - The executor service by which all asynchronous requests will be executed.@Deprecated public AmazonPollyAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).executorService - The executor service by which all asynchronous requests will be executed.public static AmazonPollyAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<DeleteLexiconResult> deleteLexiconAsync(DeleteLexiconRequest request)
AmazonPollyAsync
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.
deleteLexiconAsync in interface AmazonPollyAsyncpublic Future<DeleteLexiconResult> deleteLexiconAsync(DeleteLexiconRequest request, AsyncHandler<DeleteLexiconRequest,DeleteLexiconResult> asyncHandler)
AmazonPollyAsync
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.
deleteLexiconAsync in interface AmazonPollyAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeVoicesResult> describeVoicesAsync(DescribeVoicesRequest request)
AmazonPollyAsyncReturns 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.
describeVoicesAsync in interface AmazonPollyAsyncpublic Future<DescribeVoicesResult> describeVoicesAsync(DescribeVoicesRequest request, AsyncHandler<DescribeVoicesRequest,DescribeVoicesResult> asyncHandler)
AmazonPollyAsyncReturns 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.
describeVoicesAsync in interface AmazonPollyAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetLexiconResult> getLexiconAsync(GetLexiconRequest request)
AmazonPollyAsyncReturns the content of the specified pronunciation lexicon stored in an AWS Region. For more information, see Managing Lexicons.
getLexiconAsync in interface AmazonPollyAsyncpublic Future<GetLexiconResult> getLexiconAsync(GetLexiconRequest request, AsyncHandler<GetLexiconRequest,GetLexiconResult> asyncHandler)
AmazonPollyAsyncReturns the content of the specified pronunciation lexicon stored in an AWS Region. For more information, see Managing Lexicons.
getLexiconAsync in interface AmazonPollyAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetSpeechSynthesisTaskResult> getSpeechSynthesisTaskAsync(GetSpeechSynthesisTaskRequest request)
AmazonPollyAsyncRetrieves 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.
getSpeechSynthesisTaskAsync in interface AmazonPollyAsyncpublic Future<GetSpeechSynthesisTaskResult> getSpeechSynthesisTaskAsync(GetSpeechSynthesisTaskRequest request, AsyncHandler<GetSpeechSynthesisTaskRequest,GetSpeechSynthesisTaskResult> asyncHandler)
AmazonPollyAsyncRetrieves 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.
getSpeechSynthesisTaskAsync in interface AmazonPollyAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListLexiconsResult> listLexiconsAsync(ListLexiconsRequest request)
AmazonPollyAsyncReturns a list of pronunciation lexicons stored in an AWS Region. For more information, see Managing Lexicons.
listLexiconsAsync in interface AmazonPollyAsyncpublic Future<ListLexiconsResult> listLexiconsAsync(ListLexiconsRequest request, AsyncHandler<ListLexiconsRequest,ListLexiconsResult> asyncHandler)
AmazonPollyAsyncReturns a list of pronunciation lexicons stored in an AWS Region. For more information, see Managing Lexicons.
listLexiconsAsync in interface AmazonPollyAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListSpeechSynthesisTasksResult> listSpeechSynthesisTasksAsync(ListSpeechSynthesisTasksRequest request)
AmazonPollyAsyncReturns 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.
listSpeechSynthesisTasksAsync in interface AmazonPollyAsyncpublic Future<ListSpeechSynthesisTasksResult> listSpeechSynthesisTasksAsync(ListSpeechSynthesisTasksRequest request, AsyncHandler<ListSpeechSynthesisTasksRequest,ListSpeechSynthesisTasksResult> asyncHandler)
AmazonPollyAsyncReturns 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.
listSpeechSynthesisTasksAsync in interface AmazonPollyAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutLexiconResult> putLexiconAsync(PutLexiconRequest request)
AmazonPollyAsyncStores 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.
putLexiconAsync in interface AmazonPollyAsyncpublic Future<PutLexiconResult> putLexiconAsync(PutLexiconRequest request, AsyncHandler<PutLexiconRequest,PutLexiconResult> asyncHandler)
AmazonPollyAsyncStores 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.
putLexiconAsync in interface AmazonPollyAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartSpeechSynthesisTaskResult> startSpeechSynthesisTaskAsync(StartSpeechSynthesisTaskRequest request)
AmazonPollyAsync
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.
startSpeechSynthesisTaskAsync in interface AmazonPollyAsyncpublic Future<StartSpeechSynthesisTaskResult> startSpeechSynthesisTaskAsync(StartSpeechSynthesisTaskRequest request, AsyncHandler<StartSpeechSynthesisTaskRequest,StartSpeechSynthesisTaskResult> asyncHandler)
AmazonPollyAsync
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.
startSpeechSynthesisTaskAsync in interface AmazonPollyAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SynthesizeSpeechResult> synthesizeSpeechAsync(SynthesizeSpeechRequest request)
AmazonPollyAsyncSynthesizes 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.
synthesizeSpeechAsync in interface AmazonPollyAsyncpublic Future<SynthesizeSpeechResult> synthesizeSpeechAsync(SynthesizeSpeechRequest request, AsyncHandler<SynthesizeSpeechRequest,SynthesizeSpeechResult> asyncHandler)
AmazonPollyAsyncSynthesizes 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.
synthesizeSpeechAsync in interface AmazonPollyAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonPollyshutdown in class AmazonPollyClient