Interface PollyClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic PollyClientBuilder
builder()
Create a builder that can be used to configure and create aPollyClient
.static PollyClient
create()
Create aPollyClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default DeleteLexiconResponse
deleteLexicon
(Consumer<DeleteLexiconRequest.Builder> deleteLexiconRequest) Deletes the specified pronunciation lexicon stored in an Amazon Web Services Region.default DeleteLexiconResponse
deleteLexicon
(DeleteLexiconRequest deleteLexiconRequest) Deletes the specified pronunciation lexicon stored in an Amazon Web Services Region.default DescribeVoicesResponse
Returns the list of voices that are available for use when requesting speech synthesis.default DescribeVoicesResponse
describeVoices
(Consumer<DescribeVoicesRequest.Builder> describeVoicesRequest) Returns the list of voices that are available for use when requesting speech synthesis.default DescribeVoicesResponse
describeVoices
(DescribeVoicesRequest describeVoicesRequest) Returns the list of voices that are available for use when requesting speech synthesis.default GetLexiconResponse
getLexicon
(Consumer<GetLexiconRequest.Builder> getLexiconRequest) Returns the content of the specified pronunciation lexicon stored in an Amazon Web Services Region.default GetLexiconResponse
getLexicon
(GetLexiconRequest getLexiconRequest) Returns the content of the specified pronunciation lexicon stored in an Amazon Web Services Region.default GetSpeechSynthesisTaskResponse
getSpeechSynthesisTask
(Consumer<GetSpeechSynthesisTaskRequest.Builder> getSpeechSynthesisTaskRequest) Retrieves a specific SpeechSynthesisTask object based on its TaskID.default GetSpeechSynthesisTaskResponse
getSpeechSynthesisTask
(GetSpeechSynthesisTaskRequest getSpeechSynthesisTaskRequest) Retrieves a specific SpeechSynthesisTask object based on its TaskID.default ListLexiconsResponse
Returns a list of pronunciation lexicons stored in an Amazon Web Services Region.default ListLexiconsResponse
listLexicons
(Consumer<ListLexiconsRequest.Builder> listLexiconsRequest) Returns a list of pronunciation lexicons stored in an Amazon Web Services Region.default ListLexiconsResponse
listLexicons
(ListLexiconsRequest listLexiconsRequest) Returns a list of pronunciation lexicons stored in an Amazon Web Services Region.default ListSpeechSynthesisTasksResponse
Returns a list of SpeechSynthesisTask objects ordered by their creation date.default ListSpeechSynthesisTasksResponse
listSpeechSynthesisTasks
(Consumer<ListSpeechSynthesisTasksRequest.Builder> listSpeechSynthesisTasksRequest) Returns a list of SpeechSynthesisTask objects ordered by their creation date.default ListSpeechSynthesisTasksResponse
listSpeechSynthesisTasks
(ListSpeechSynthesisTasksRequest listSpeechSynthesisTasksRequest) Returns a list of SpeechSynthesisTask objects ordered by their creation date.default ListSpeechSynthesisTasksIterable
This is a variant oflistSpeechSynthesisTasks(software.amazon.awssdk.services.polly.model.ListSpeechSynthesisTasksRequest)
operation.default ListSpeechSynthesisTasksIterable
listSpeechSynthesisTasksPaginator
(Consumer<ListSpeechSynthesisTasksRequest.Builder> listSpeechSynthesisTasksRequest) This is a variant oflistSpeechSynthesisTasks(software.amazon.awssdk.services.polly.model.ListSpeechSynthesisTasksRequest)
operation.default ListSpeechSynthesisTasksIterable
listSpeechSynthesisTasksPaginator
(ListSpeechSynthesisTasksRequest listSpeechSynthesisTasksRequest) This is a variant oflistSpeechSynthesisTasks(software.amazon.awssdk.services.polly.model.ListSpeechSynthesisTasksRequest)
operation.default PutLexiconResponse
putLexicon
(Consumer<PutLexiconRequest.Builder> putLexiconRequest) Stores a pronunciation lexicon in an Amazon Web Services Region.default PutLexiconResponse
putLexicon
(PutLexiconRequest putLexiconRequest) Stores a pronunciation lexicon in an Amazon Web Services Region.default PollyServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default StartSpeechSynthesisTaskResponse
startSpeechSynthesisTask
(Consumer<StartSpeechSynthesisTaskRequest.Builder> startSpeechSynthesisTaskRequest) Allows the creation of an asynchronous synthesis task, by starting a newSpeechSynthesisTask
.default StartSpeechSynthesisTaskResponse
startSpeechSynthesisTask
(StartSpeechSynthesisTaskRequest startSpeechSynthesisTaskRequest) Allows the creation of an asynchronous synthesis task, by starting a newSpeechSynthesisTask
.synthesizeSpeech
(Consumer<SynthesizeSpeechRequest.Builder> synthesizeSpeechRequest) Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.default SynthesizeSpeechResponse
synthesizeSpeech
(Consumer<SynthesizeSpeechRequest.Builder> synthesizeSpeechRequest, Path destinationPath) Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.default <ReturnT> ReturnT
synthesizeSpeech
(Consumer<SynthesizeSpeechRequest.Builder> synthesizeSpeechRequest, ResponseTransformer<SynthesizeSpeechResponse, ReturnT> responseTransformer) Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.synthesizeSpeech
(SynthesizeSpeechRequest synthesizeSpeechRequest) Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.default SynthesizeSpeechResponse
synthesizeSpeech
(SynthesizeSpeechRequest synthesizeSpeechRequest, Path destinationPath) Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.default <ReturnT> ReturnT
synthesizeSpeech
(SynthesizeSpeechRequest synthesizeSpeechRequest, ResponseTransformer<SynthesizeSpeechResponse, ReturnT> responseTransformer) Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.default ResponseBytes
<SynthesizeSpeechResponse> synthesizeSpeechAsBytes
(Consumer<SynthesizeSpeechRequest.Builder> synthesizeSpeechRequest) Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.default ResponseBytes
<SynthesizeSpeechResponse> synthesizeSpeechAsBytes
(SynthesizeSpeechRequest synthesizeSpeechRequest) Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
deleteLexicon
default DeleteLexiconResponse deleteLexicon(DeleteLexiconRequest deleteLexiconRequest) throws LexiconNotFoundException, ServiceFailureException, AwsServiceException, SdkClientException, PollyException 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
orListLexicon
APIs.For more information, see Managing Lexicons.
- Parameters:
deleteLexiconRequest
-- Returns:
- Result of the DeleteLexicon operation returned by the service.
- See Also:
-
deleteLexicon
default DeleteLexiconResponse deleteLexicon(Consumer<DeleteLexiconRequest.Builder> deleteLexiconRequest) throws LexiconNotFoundException, ServiceFailureException, AwsServiceException, SdkClientException, PollyException 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
orListLexicon
APIs.For more information, see Managing Lexicons.
This is a convenience which creates an instance of the
DeleteLexiconRequest.Builder
avoiding the need to create one manually viaDeleteLexiconRequest.builder()
- Parameters:
deleteLexiconRequest
- AConsumer
that will call methods onDeleteLexiconRequest.Builder
to create a request.- Returns:
- Result of the DeleteLexicon operation returned by the service.
- See Also:
-
describeVoices
default DescribeVoicesResponse describeVoices(DescribeVoicesRequest describeVoicesRequest) throws InvalidNextTokenException, ServiceFailureException, AwsServiceException, SdkClientException, PollyException 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 byDescribeVoices
.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.
- See Also:
-
describeVoices
default DescribeVoicesResponse describeVoices(Consumer<DescribeVoicesRequest.Builder> describeVoicesRequest) throws InvalidNextTokenException, ServiceFailureException, AwsServiceException, SdkClientException, PollyException 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 byDescribeVoices
.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.
This is a convenience which creates an instance of the
DescribeVoicesRequest.Builder
avoiding the need to create one manually viaDescribeVoicesRequest.builder()
- Parameters:
describeVoicesRequest
- AConsumer
that will call methods onDescribeVoicesRequest.Builder
to create a request.- Returns:
- Result of the DescribeVoices operation returned by the service.
- See Also:
-
describeVoices
default DescribeVoicesResponse describeVoices() throws InvalidNextTokenException, ServiceFailureException, AwsServiceException, SdkClientException, PollyExceptionReturns 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 byDescribeVoices
.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.- Returns:
- Result of the DescribeVoices operation returned by the service.
- See Also:
-
getLexicon
default GetLexiconResponse getLexicon(GetLexiconRequest getLexiconRequest) throws LexiconNotFoundException, ServiceFailureException, AwsServiceException, SdkClientException, PollyException 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.
- See Also:
-
getLexicon
default GetLexiconResponse getLexicon(Consumer<GetLexiconRequest.Builder> getLexiconRequest) throws LexiconNotFoundException, ServiceFailureException, AwsServiceException, SdkClientException, PollyException Returns the content of the specified pronunciation lexicon stored in an Amazon Web Services Region. For more information, see Managing Lexicons.
This is a convenience which creates an instance of the
GetLexiconRequest.Builder
avoiding the need to create one manually viaGetLexiconRequest.builder()
- Parameters:
getLexiconRequest
- AConsumer
that will call methods onGetLexiconRequest.Builder
to create a request.- Returns:
- Result of the GetLexicon operation returned by the service.
- See Also:
-
getSpeechSynthesisTask
default GetSpeechSynthesisTaskResponse getSpeechSynthesisTask(GetSpeechSynthesisTaskRequest getSpeechSynthesisTaskRequest) throws InvalidTaskIdException, ServiceFailureException, SynthesisTaskNotFoundException, AwsServiceException, SdkClientException, PollyException 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.
- See Also:
-
getSpeechSynthesisTask
default GetSpeechSynthesisTaskResponse getSpeechSynthesisTask(Consumer<GetSpeechSynthesisTaskRequest.Builder> getSpeechSynthesisTaskRequest) throws InvalidTaskIdException, ServiceFailureException, SynthesisTaskNotFoundException, AwsServiceException, SdkClientException, PollyException 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.
This is a convenience which creates an instance of the
GetSpeechSynthesisTaskRequest.Builder
avoiding the need to create one manually viaGetSpeechSynthesisTaskRequest.builder()
- Parameters:
getSpeechSynthesisTaskRequest
- AConsumer
that will call methods onGetSpeechSynthesisTaskRequest.Builder
to create a request.- Returns:
- Result of the GetSpeechSynthesisTask operation returned by the service.
- See Also:
-
listLexicons
default ListLexiconsResponse listLexicons(ListLexiconsRequest listLexiconsRequest) throws InvalidNextTokenException, ServiceFailureException, AwsServiceException, SdkClientException, PollyException 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.
- See Also:
-
listLexicons
default ListLexiconsResponse listLexicons(Consumer<ListLexiconsRequest.Builder> listLexiconsRequest) throws InvalidNextTokenException, ServiceFailureException, AwsServiceException, SdkClientException, PollyException Returns a list of pronunciation lexicons stored in an Amazon Web Services Region. For more information, see Managing Lexicons.
This is a convenience which creates an instance of the
ListLexiconsRequest.Builder
avoiding the need to create one manually viaListLexiconsRequest.builder()
- Parameters:
listLexiconsRequest
- AConsumer
that will call methods onListLexiconsRequest.Builder
to create a request.- Returns:
- Result of the ListLexicons operation returned by the service.
- See Also:
-
listLexicons
default ListLexiconsResponse listLexicons() throws InvalidNextTokenException, ServiceFailureException, AwsServiceException, SdkClientException, PollyExceptionReturns a list of pronunciation lexicons stored in an Amazon Web Services Region. For more information, see Managing Lexicons.
- Returns:
- Result of the ListLexicons operation returned by the service.
- See Also:
-
listSpeechSynthesisTasks
default ListSpeechSynthesisTasksResponse listSpeechSynthesisTasks(ListSpeechSynthesisTasksRequest listSpeechSynthesisTasksRequest) throws InvalidNextTokenException, ServiceFailureException, AwsServiceException, SdkClientException, PollyException 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.
- See Also:
-
listSpeechSynthesisTasks
default ListSpeechSynthesisTasksResponse listSpeechSynthesisTasks(Consumer<ListSpeechSynthesisTasksRequest.Builder> listSpeechSynthesisTasksRequest) throws InvalidNextTokenException, ServiceFailureException, AwsServiceException, SdkClientException, PollyException 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.
This is a convenience which creates an instance of the
ListSpeechSynthesisTasksRequest.Builder
avoiding the need to create one manually viaListSpeechSynthesisTasksRequest.builder()
- Parameters:
listSpeechSynthesisTasksRequest
- AConsumer
that will call methods onListSpeechSynthesisTasksRequest.Builder
to create a request.- Returns:
- Result of the ListSpeechSynthesisTasks operation returned by the service.
- See Also:
-
listSpeechSynthesisTasks
default ListSpeechSynthesisTasksResponse listSpeechSynthesisTasks() throws InvalidNextTokenException, ServiceFailureException, AwsServiceException, SdkClientException, PollyExceptionReturns 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.
- Returns:
- Result of the ListSpeechSynthesisTasks operation returned by the service.
- See Also:
-
listSpeechSynthesisTasksPaginator
default ListSpeechSynthesisTasksIterable listSpeechSynthesisTasksPaginator() throws InvalidNextTokenException, ServiceFailureException, AwsServiceException, SdkClientException, PollyExceptionThis is a variant of
listSpeechSynthesisTasks(software.amazon.awssdk.services.polly.model.ListSpeechSynthesisTasksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.polly.paginators.ListSpeechSynthesisTasksIterable responses = client.listSpeechSynthesisTasksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.polly.paginators.ListSpeechSynthesisTasksIterable responses = client .listSpeechSynthesisTasksPaginator(request); for (software.amazon.awssdk.services.polly.model.ListSpeechSynthesisTasksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.polly.paginators.ListSpeechSynthesisTasksIterable responses = client.listSpeechSynthesisTasksPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSpeechSynthesisTasks(software.amazon.awssdk.services.polly.model.ListSpeechSynthesisTasksRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSpeechSynthesisTasksPaginator
default ListSpeechSynthesisTasksIterable listSpeechSynthesisTasksPaginator(ListSpeechSynthesisTasksRequest listSpeechSynthesisTasksRequest) throws InvalidNextTokenException, ServiceFailureException, AwsServiceException, SdkClientException, PollyException This is a variant of
listSpeechSynthesisTasks(software.amazon.awssdk.services.polly.model.ListSpeechSynthesisTasksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.polly.paginators.ListSpeechSynthesisTasksIterable responses = client.listSpeechSynthesisTasksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.polly.paginators.ListSpeechSynthesisTasksIterable responses = client .listSpeechSynthesisTasksPaginator(request); for (software.amazon.awssdk.services.polly.model.ListSpeechSynthesisTasksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.polly.paginators.ListSpeechSynthesisTasksIterable responses = client.listSpeechSynthesisTasksPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSpeechSynthesisTasks(software.amazon.awssdk.services.polly.model.ListSpeechSynthesisTasksRequest)
operation.- Parameters:
listSpeechSynthesisTasksRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSpeechSynthesisTasksPaginator
default ListSpeechSynthesisTasksIterable listSpeechSynthesisTasksPaginator(Consumer<ListSpeechSynthesisTasksRequest.Builder> listSpeechSynthesisTasksRequest) throws InvalidNextTokenException, ServiceFailureException, AwsServiceException, SdkClientException, PollyException This is a variant of
listSpeechSynthesisTasks(software.amazon.awssdk.services.polly.model.ListSpeechSynthesisTasksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.polly.paginators.ListSpeechSynthesisTasksIterable responses = client.listSpeechSynthesisTasksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.polly.paginators.ListSpeechSynthesisTasksIterable responses = client .listSpeechSynthesisTasksPaginator(request); for (software.amazon.awssdk.services.polly.model.ListSpeechSynthesisTasksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.polly.paginators.ListSpeechSynthesisTasksIterable responses = client.listSpeechSynthesisTasksPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSpeechSynthesisTasks(software.amazon.awssdk.services.polly.model.ListSpeechSynthesisTasksRequest)
operation.
This is a convenience which creates an instance of the
ListSpeechSynthesisTasksRequest.Builder
avoiding the need to create one manually viaListSpeechSynthesisTasksRequest.builder()
- Parameters:
listSpeechSynthesisTasksRequest
- AConsumer
that will call methods onListSpeechSynthesisTasksRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
putLexicon
default PutLexiconResponse putLexicon(PutLexiconRequest putLexiconRequest) throws InvalidLexiconException, UnsupportedPlsAlphabetException, UnsupportedPlsLanguageException, LexiconSizeExceededException, MaxLexemeLengthExceededException, MaxLexiconsNumberExceededException, ServiceFailureException, AwsServiceException, SdkClientException, PollyException 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.
- See Also:
-
putLexicon
default PutLexiconResponse putLexicon(Consumer<PutLexiconRequest.Builder> putLexiconRequest) throws InvalidLexiconException, UnsupportedPlsAlphabetException, UnsupportedPlsLanguageException, LexiconSizeExceededException, MaxLexemeLengthExceededException, MaxLexiconsNumberExceededException, ServiceFailureException, AwsServiceException, SdkClientException, PollyException 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.
This is a convenience which creates an instance of the
PutLexiconRequest.Builder
avoiding the need to create one manually viaPutLexiconRequest.builder()
- Parameters:
putLexiconRequest
- AConsumer
that will call methods onPutLexiconRequest.Builder
to create a request.- Returns:
- Result of the PutLexicon operation returned by the service.
- See Also:
-
startSpeechSynthesisTask
default StartSpeechSynthesisTaskResponse startSpeechSynthesisTask(StartSpeechSynthesisTaskRequest startSpeechSynthesisTaskRequest) throws TextLengthExceededException, InvalidS3BucketException, InvalidS3KeyException, InvalidSampleRateException, InvalidSnsTopicArnException, InvalidSsmlException, EngineNotSupportedException, LexiconNotFoundException, ServiceFailureException, MarksNotSupportedForFormatException, SsmlMarksNotSupportedForTextTypeException, LanguageNotSupportedException, AwsServiceException, SdkClientException, PollyException 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
andSnsTopicArn
). Once the synthesis task is created, this operation will return aSpeechSynthesisTask
object, which will include an identifier of this task as well as the current status. TheSpeechSynthesisTask
object is available for 72 hours after starting the asynchronous synthesis task.- Parameters:
startSpeechSynthesisTaskRequest
-- Returns:
- Result of the StartSpeechSynthesisTask operation returned by the service.
- See Also:
-
startSpeechSynthesisTask
default StartSpeechSynthesisTaskResponse startSpeechSynthesisTask(Consumer<StartSpeechSynthesisTaskRequest.Builder> startSpeechSynthesisTaskRequest) throws TextLengthExceededException, InvalidS3BucketException, InvalidS3KeyException, InvalidSampleRateException, InvalidSnsTopicArnException, InvalidSsmlException, EngineNotSupportedException, LexiconNotFoundException, ServiceFailureException, MarksNotSupportedForFormatException, SsmlMarksNotSupportedForTextTypeException, LanguageNotSupportedException, AwsServiceException, SdkClientException, PollyException 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
andSnsTopicArn
). Once the synthesis task is created, this operation will return aSpeechSynthesisTask
object, which will include an identifier of this task as well as the current status. TheSpeechSynthesisTask
object is available for 72 hours after starting the asynchronous synthesis task.
This is a convenience which creates an instance of the
StartSpeechSynthesisTaskRequest.Builder
avoiding the need to create one manually viaStartSpeechSynthesisTaskRequest.builder()
- Parameters:
startSpeechSynthesisTaskRequest
- AConsumer
that will call methods onStartSpeechSynthesisTaskRequest.Builder
to create a request.- Returns:
- Result of the StartSpeechSynthesisTask operation returned by the service.
- See Also:
-
synthesizeSpeech
default <ReturnT> ReturnT synthesizeSpeech(SynthesizeSpeechRequest synthesizeSpeechRequest, ResponseTransformer<SynthesizeSpeechResponse, ReturnT> responseTransformer) throws TextLengthExceededException, InvalidSampleRateException, InvalidSsmlException, LexiconNotFoundException, ServiceFailureException, MarksNotSupportedForFormatException, SsmlMarksNotSupportedForTextTypeException, LanguageNotSupportedException, EngineNotSupportedException, AwsServiceException, SdkClientException, PollyExceptionSynthesizes 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
-responseTransformer
- Functional interface for processing the streamed response content. The unmarshalled SynthesizeSpeechResponse and an InputStream to the response content are provided as parameters to the callback. The callback may return a transformed type which will be the return value of this method. SeeResponseTransformer
for details on implementing this interface and for links to pre-canned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows 'Stream containing the synthesized speech.
'.- Returns:
- The transformed result of the ResponseTransformer.
- See Also:
-
synthesizeSpeech
default <ReturnT> ReturnT synthesizeSpeech(Consumer<SynthesizeSpeechRequest.Builder> synthesizeSpeechRequest, ResponseTransformer<SynthesizeSpeechResponse, ReturnT> responseTransformer) throws TextLengthExceededException, InvalidSampleRateException, InvalidSsmlException, LexiconNotFoundException, ServiceFailureException, MarksNotSupportedForFormatException, SsmlMarksNotSupportedForTextTypeException, LanguageNotSupportedException, EngineNotSupportedException, AwsServiceException, SdkClientException, PollyExceptionSynthesizes 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.
This is a convenience which creates an instance of the
SynthesizeSpeechRequest.Builder
avoiding the need to create one manually viaSynthesizeSpeechRequest.builder()
- Parameters:
synthesizeSpeechRequest
- AConsumer
that will call methods onSynthesizeSpeechRequest.Builder
to create a request.responseTransformer
- Functional interface for processing the streamed response content. The unmarshalled SynthesizeSpeechResponse and an InputStream to the response content are provided as parameters to the callback. The callback may return a transformed type which will be the return value of this method. SeeResponseTransformer
for details on implementing this interface and for links to pre-canned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows 'Stream containing the synthesized speech.
'.- Returns:
- The transformed result of the ResponseTransformer.
- See Also:
-
synthesizeSpeech
default SynthesizeSpeechResponse synthesizeSpeech(SynthesizeSpeechRequest synthesizeSpeechRequest, Path destinationPath) throws TextLengthExceededException, InvalidSampleRateException, InvalidSsmlException, LexiconNotFoundException, ServiceFailureException, MarksNotSupportedForFormatException, SsmlMarksNotSupportedForTextTypeException, LanguageNotSupportedException, EngineNotSupportedException, AwsServiceException, SdkClientException, PollyException 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
-destinationPath
-Path
to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows 'Stream containing the synthesized speech.
'.- Returns:
- The transformed result of the ResponseTransformer.
- See Also:
-
synthesizeSpeech
default SynthesizeSpeechResponse synthesizeSpeech(Consumer<SynthesizeSpeechRequest.Builder> synthesizeSpeechRequest, Path destinationPath) throws TextLengthExceededException, InvalidSampleRateException, InvalidSsmlException, LexiconNotFoundException, ServiceFailureException, MarksNotSupportedForFormatException, SsmlMarksNotSupportedForTextTypeException, LanguageNotSupportedException, EngineNotSupportedException, AwsServiceException, SdkClientException, PollyException 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.
This is a convenience which creates an instance of the
SynthesizeSpeechRequest.Builder
avoiding the need to create one manually viaSynthesizeSpeechRequest.builder()
- Parameters:
synthesizeSpeechRequest
- AConsumer
that will call methods onSynthesizeSpeechRequest.Builder
to create a request.destinationPath
-Path
to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows 'Stream containing the synthesized speech.
'.- Returns:
- The transformed result of the ResponseTransformer.
- See Also:
-
synthesizeSpeech
default ResponseInputStream<SynthesizeSpeechResponse> synthesizeSpeech(SynthesizeSpeechRequest synthesizeSpeechRequest) throws TextLengthExceededException, InvalidSampleRateException, InvalidSsmlException, LexiconNotFoundException, ServiceFailureException, MarksNotSupportedForFormatException, SsmlMarksNotSupportedForTextTypeException, LanguageNotSupportedException, EngineNotSupportedException, AwsServiceException, SdkClientException, PollyException 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:
- A
ResponseInputStream
containing data streamed from service. Note that this is an unmanaged reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior and exhausting connections in the connection pool. The unmarshalled response object can be obtained viaResponseInputStream.response()
. The service documentation for the response content is as follows 'Stream containing the synthesized speech.
'. - See Also:
-
synthesizeSpeech
default ResponseInputStream<SynthesizeSpeechResponse> synthesizeSpeech(Consumer<SynthesizeSpeechRequest.Builder> synthesizeSpeechRequest) throws TextLengthExceededException, InvalidSampleRateException, InvalidSsmlException, LexiconNotFoundException, ServiceFailureException, MarksNotSupportedForFormatException, SsmlMarksNotSupportedForTextTypeException, LanguageNotSupportedException, EngineNotSupportedException, AwsServiceException, SdkClientException, PollyException 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.
This is a convenience which creates an instance of the
SynthesizeSpeechRequest.Builder
avoiding the need to create one manually viaSynthesizeSpeechRequest.builder()
- Parameters:
synthesizeSpeechRequest
- AConsumer
that will call methods onSynthesizeSpeechRequest.Builder
to create a request.- Returns:
- A
ResponseInputStream
containing data streamed from service. Note that this is an unmanaged reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior and exhausting connections in the connection pool. The unmarshalled response object can be obtained viaResponseInputStream.response()
. The service documentation for the response content is as follows 'Stream containing the synthesized speech.
'. - See Also:
-
synthesizeSpeechAsBytes
default ResponseBytes<SynthesizeSpeechResponse> synthesizeSpeechAsBytes(SynthesizeSpeechRequest synthesizeSpeechRequest) throws TextLengthExceededException, InvalidSampleRateException, InvalidSsmlException, LexiconNotFoundException, ServiceFailureException, MarksNotSupportedForFormatException, SsmlMarksNotSupportedForTextTypeException, LanguageNotSupportedException, EngineNotSupportedException, AwsServiceException, SdkClientException, PollyException 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:
- A
ResponseBytes
that loads the data streamed from the service into memory and exposes it in convenient in-memory representations like a byte buffer or string. The unmarshalled response object can be obtained viaResponseBytes.response()
. The service documentation for the response content is as follows 'Stream containing the synthesized speech.
'. - See Also:
-
synthesizeSpeechAsBytes
default ResponseBytes<SynthesizeSpeechResponse> synthesizeSpeechAsBytes(Consumer<SynthesizeSpeechRequest.Builder> synthesizeSpeechRequest) throws TextLengthExceededException, InvalidSampleRateException, InvalidSsmlException, LexiconNotFoundException, ServiceFailureException, MarksNotSupportedForFormatException, SsmlMarksNotSupportedForTextTypeException, LanguageNotSupportedException, EngineNotSupportedException, AwsServiceException, SdkClientException, PollyException 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.
This is a convenience which creates an instance of the
SynthesizeSpeechRequest.Builder
avoiding the need to create one manually viaSynthesizeSpeechRequest.builder()
- Parameters:
synthesizeSpeechRequest
- AConsumer
that will call methods onSynthesizeSpeechRequest.Builder
to create a request.- Returns:
- A
ResponseBytes
that loads the data streamed from the service into memory and exposes it in convenient in-memory representations like a byte buffer or string. The unmarshalled response object can be obtained viaResponseBytes.response()
. The service documentation for the response content is as follows 'Stream containing the synthesized speech.
'. - See Also:
-
create
Create aPollyClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aPollyClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-