Interface PollyClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface PollyClient extends AwsClient
Service client for accessing Amazon Polly. This can be created using the staticbuilder()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
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static PollyClientBuilderbuilder()Create a builder that can be used to configure and create aPollyClient.static PollyClientcreate()Create aPollyClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default DeleteLexiconResponsedeleteLexicon(Consumer<DeleteLexiconRequest.Builder> deleteLexiconRequest)Deletes the specified pronunciation lexicon stored in an Amazon Web Services Region.default DeleteLexiconResponsedeleteLexicon(DeleteLexiconRequest deleteLexiconRequest)Deletes the specified pronunciation lexicon stored in an Amazon Web Services Region.default DescribeVoicesResponsedescribeVoices()Returns the list of voices that are available for use when requesting speech synthesis.default DescribeVoicesResponsedescribeVoices(Consumer<DescribeVoicesRequest.Builder> describeVoicesRequest)Returns the list of voices that are available for use when requesting speech synthesis.default DescribeVoicesResponsedescribeVoices(DescribeVoicesRequest describeVoicesRequest)Returns the list of voices that are available for use when requesting speech synthesis.default GetLexiconResponsegetLexicon(Consumer<GetLexiconRequest.Builder> getLexiconRequest)Returns the content of the specified pronunciation lexicon stored in an Amazon Web Services Region.default GetLexiconResponsegetLexicon(GetLexiconRequest getLexiconRequest)Returns the content of the specified pronunciation lexicon stored in an Amazon Web Services Region.default GetSpeechSynthesisTaskResponsegetSpeechSynthesisTask(Consumer<GetSpeechSynthesisTaskRequest.Builder> getSpeechSynthesisTaskRequest)Retrieves a specific SpeechSynthesisTask object based on its TaskID.default GetSpeechSynthesisTaskResponsegetSpeechSynthesisTask(GetSpeechSynthesisTaskRequest getSpeechSynthesisTaskRequest)Retrieves a specific SpeechSynthesisTask object based on its TaskID.default ListLexiconsResponselistLexicons()Returns a list of pronunciation lexicons stored in an Amazon Web Services Region.default ListLexiconsResponselistLexicons(Consumer<ListLexiconsRequest.Builder> listLexiconsRequest)Returns a list of pronunciation lexicons stored in an Amazon Web Services Region.default ListLexiconsResponselistLexicons(ListLexiconsRequest listLexiconsRequest)Returns a list of pronunciation lexicons stored in an Amazon Web Services Region.default ListSpeechSynthesisTasksResponselistSpeechSynthesisTasks()Returns a list of SpeechSynthesisTask objects ordered by their creation date.default ListSpeechSynthesisTasksResponselistSpeechSynthesisTasks(Consumer<ListSpeechSynthesisTasksRequest.Builder> listSpeechSynthesisTasksRequest)Returns a list of SpeechSynthesisTask objects ordered by their creation date.default ListSpeechSynthesisTasksResponselistSpeechSynthesisTasks(ListSpeechSynthesisTasksRequest listSpeechSynthesisTasksRequest)Returns a list of SpeechSynthesisTask objects ordered by their creation date.default ListSpeechSynthesisTasksIterablelistSpeechSynthesisTasksPaginator()This is a variant oflistSpeechSynthesisTasks(software.amazon.awssdk.services.polly.model.ListSpeechSynthesisTasksRequest)operation.default ListSpeechSynthesisTasksIterablelistSpeechSynthesisTasksPaginator(Consumer<ListSpeechSynthesisTasksRequest.Builder> listSpeechSynthesisTasksRequest)This is a variant oflistSpeechSynthesisTasks(software.amazon.awssdk.services.polly.model.ListSpeechSynthesisTasksRequest)operation.default ListSpeechSynthesisTasksIterablelistSpeechSynthesisTasksPaginator(ListSpeechSynthesisTasksRequest listSpeechSynthesisTasksRequest)This is a variant oflistSpeechSynthesisTasks(software.amazon.awssdk.services.polly.model.ListSpeechSynthesisTasksRequest)operation.default PutLexiconResponseputLexicon(Consumer<PutLexiconRequest.Builder> putLexiconRequest)Stores a pronunciation lexicon in an Amazon Web Services Region.default PutLexiconResponseputLexicon(PutLexiconRequest putLexiconRequest)Stores a pronunciation lexicon in an Amazon Web Services Region.default PollyServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default StartSpeechSynthesisTaskResponsestartSpeechSynthesisTask(Consumer<StartSpeechSynthesisTaskRequest.Builder> startSpeechSynthesisTaskRequest)Allows the creation of an asynchronous synthesis task, by starting a newSpeechSynthesisTask.default StartSpeechSynthesisTaskResponsestartSpeechSynthesisTask(StartSpeechSynthesisTaskRequest startSpeechSynthesisTaskRequest)Allows the creation of an asynchronous synthesis task, by starting a newSpeechSynthesisTask.default ResponseInputStream<SynthesizeSpeechResponse>synthesizeSpeech(Consumer<SynthesizeSpeechRequest.Builder> synthesizeSpeechRequest)Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.default SynthesizeSpeechResponsesynthesizeSpeech(Consumer<SynthesizeSpeechRequest.Builder> synthesizeSpeechRequest, Path destinationPath)Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.default <ReturnT> ReturnTsynthesizeSpeech(Consumer<SynthesizeSpeechRequest.Builder> synthesizeSpeechRequest, ResponseTransformer<SynthesizeSpeechResponse,ReturnT> responseTransformer)Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.default ResponseInputStream<SynthesizeSpeechResponse>synthesizeSpeech(SynthesizeSpeechRequest synthesizeSpeechRequest)Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.default SynthesizeSpeechResponsesynthesizeSpeech(SynthesizeSpeechRequest synthesizeSpeechRequest, Path destinationPath)Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.default <ReturnT> ReturnTsynthesizeSpeech(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 Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
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
GetLexiconorListLexiconAPIs.For more information, see Managing Lexicons.
- Parameters:
deleteLexiconRequest-- Returns:
- Result of the DeleteLexicon operation returned by the service.
- Throws:
LexiconNotFoundException- Amazon Polly can't find the specified lexicon. This could be caused by a lexicon that is missing, its name is misspelled or specifying a lexicon that is in a different region.Verify that the lexicon exists, is in the region (see ListLexicons) and that you spelled its name is spelled correctly. Then try again.
ServiceFailureException- An unknown condition has caused a service failure.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PollyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
GetLexiconorListLexiconAPIs.For more information, see Managing Lexicons.
This is a convenience which creates an instance of the
DeleteLexiconRequest.Builderavoiding the need to create one manually viaDeleteLexiconRequest.builder()- Parameters:
deleteLexiconRequest- AConsumerthat will call methods onDeleteLexiconRequest.Builderto create a request.- Returns:
- Result of the DeleteLexicon operation returned by the service.
- Throws:
LexiconNotFoundException- Amazon Polly can't find the specified lexicon. This could be caused by a lexicon that is missing, its name is misspelled or specifying a lexicon that is in a different region.Verify that the lexicon exists, is in the region (see ListLexicons) and that you spelled its name is spelled correctly. Then try again.
ServiceFailureException- An unknown condition has caused a service failure.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PollyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
DescribeVoicesoperation 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:DescribeVoicesaction.- Parameters:
describeVoicesRequest-- Returns:
- Result of the DescribeVoices operation returned by the service.
- Throws:
InvalidNextTokenException- The NextToken is invalid. Verify that it's spelled correctly, and then try again.ServiceFailureException- An unknown condition has caused a service failure.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PollyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
DescribeVoicesoperation 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:DescribeVoicesaction.
This is a convenience which creates an instance of the
DescribeVoicesRequest.Builderavoiding the need to create one manually viaDescribeVoicesRequest.builder()- Parameters:
describeVoicesRequest- AConsumerthat will call methods onDescribeVoicesRequest.Builderto create a request.- Returns:
- Result of the DescribeVoices operation returned by the service.
- Throws:
InvalidNextTokenException- The NextToken is invalid. Verify that it's spelled correctly, and then try again.ServiceFailureException- An unknown condition has caused a service failure.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PollyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeVoices
default DescribeVoicesResponse describeVoices() 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
DescribeVoicesoperation 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:DescribeVoicesaction.- Returns:
- Result of the DescribeVoices operation returned by the service.
- Throws:
InvalidNextTokenException- The NextToken is invalid. Verify that it's spelled correctly, and then try again.ServiceFailureException- An unknown condition has caused a service failure.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PollyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeVoices(DescribeVoicesRequest), AWS API Documentation
-
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.
- Throws:
LexiconNotFoundException- Amazon Polly can't find the specified lexicon. This could be caused by a lexicon that is missing, its name is misspelled or specifying a lexicon that is in a different region.Verify that the lexicon exists, is in the region (see ListLexicons) and that you spelled its name is spelled correctly. Then try again.
ServiceFailureException- An unknown condition has caused a service failure.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PollyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetLexiconRequest.builder()- Parameters:
getLexiconRequest- AConsumerthat will call methods onGetLexiconRequest.Builderto create a request.- Returns:
- Result of the GetLexicon operation returned by the service.
- Throws:
LexiconNotFoundException- Amazon Polly can't find the specified lexicon. This could be caused by a lexicon that is missing, its name is misspelled or specifying a lexicon that is in a different region.Verify that the lexicon exists, is in the region (see ListLexicons) and that you spelled its name is spelled correctly. Then try again.
ServiceFailureException- An unknown condition has caused a service failure.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PollyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidTaskIdException- The provided Task ID is not valid. Please provide a valid Task ID and try again.ServiceFailureException- An unknown condition has caused a service failure.SynthesisTaskNotFoundException- The Speech Synthesis task with requested Task ID cannot be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PollyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetSpeechSynthesisTaskRequest.builder()- Parameters:
getSpeechSynthesisTaskRequest- AConsumerthat will call methods onGetSpeechSynthesisTaskRequest.Builderto create a request.- Returns:
- Result of the GetSpeechSynthesisTask operation returned by the service.
- Throws:
InvalidTaskIdException- The provided Task ID is not valid. Please provide a valid Task ID and try again.ServiceFailureException- An unknown condition has caused a service failure.SynthesisTaskNotFoundException- The Speech Synthesis task with requested Task ID cannot be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PollyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidNextTokenException- The NextToken is invalid. Verify that it's spelled correctly, and then try again.ServiceFailureException- An unknown condition has caused a service failure.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PollyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListLexiconsRequest.builder()- Parameters:
listLexiconsRequest- AConsumerthat will call methods onListLexiconsRequest.Builderto create a request.- Returns:
- Result of the ListLexicons operation returned by the service.
- Throws:
InvalidNextTokenException- The NextToken is invalid. Verify that it's spelled correctly, and then try again.ServiceFailureException- An unknown condition has caused a service failure.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PollyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listLexicons
default ListLexiconsResponse listLexicons() 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.
- Returns:
- Result of the ListLexicons operation returned by the service.
- Throws:
InvalidNextTokenException- The NextToken is invalid. Verify that it's spelled correctly, and then try again.ServiceFailureException- An unknown condition has caused a service failure.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PollyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
listLexicons(ListLexiconsRequest), AWS API Documentation
-
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.
- Throws:
InvalidNextTokenException- The NextToken is invalid. Verify that it's spelled correctly, and then try again.ServiceFailureException- An unknown condition has caused a service failure.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PollyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListSpeechSynthesisTasksRequest.builder()- Parameters:
listSpeechSynthesisTasksRequest- AConsumerthat will call methods onListSpeechSynthesisTasksRequest.Builderto create a request.- Returns:
- Result of the ListSpeechSynthesisTasks operation returned by the service.
- Throws:
InvalidNextTokenException- The NextToken is invalid. Verify that it's spelled correctly, and then try again.ServiceFailureException- An unknown condition has caused a service failure.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PollyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listSpeechSynthesisTasks
default ListSpeechSynthesisTasksResponse listSpeechSynthesisTasks() 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.
- Returns:
- Result of the ListSpeechSynthesisTasks operation returned by the service.
- Throws:
InvalidNextTokenException- The NextToken is invalid. Verify that it's spelled correctly, and then try again.ServiceFailureException- An unknown condition has caused a service failure.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PollyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
listSpeechSynthesisTasks(ListSpeechSynthesisTasksRequest), AWS API Documentation
-
listSpeechSynthesisTasksPaginator
default ListSpeechSynthesisTasksIterable listSpeechSynthesisTasksPaginator() 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 Stream
2) Using For loopsoftware.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.
- Throws:
InvalidNextTokenException- The NextToken is invalid. Verify that it's spelled correctly, and then try again.ServiceFailureException- An unknown condition has caused a service failure.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PollyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
listSpeechSynthesisTasksPaginator(ListSpeechSynthesisTasksRequest), AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
InvalidNextTokenException- The NextToken is invalid. Verify that it's spelled correctly, and then try again.ServiceFailureException- An unknown condition has caused a service failure.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PollyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaListSpeechSynthesisTasksRequest.builder()- Parameters:
listSpeechSynthesisTasksRequest- AConsumerthat will call methods onListSpeechSynthesisTasksRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- The NextToken is invalid. Verify that it's spelled correctly, and then try again.ServiceFailureException- An unknown condition has caused a service failure.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PollyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidLexiconException- Amazon Polly can't find the specified lexicon. Verify that the lexicon's name is spelled correctly, and then try again.UnsupportedPlsAlphabetException- The alphabet specified by the lexicon is not a supported alphabet. Valid values arex-sampaandipa.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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PollyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaPutLexiconRequest.builder()- Parameters:
putLexiconRequest- AConsumerthat will call methods onPutLexiconRequest.Builderto create a request.- Returns:
- Result of the PutLexicon operation returned by the service.
- Throws:
InvalidLexiconException- Amazon Polly can't find the specified lexicon. Verify that the lexicon's name is spelled correctly, and then try again.UnsupportedPlsAlphabetException- The alphabet specified by the lexicon is not a supported alphabet. Valid values arex-sampaandipa.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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PollyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 (OutputS3KeyPrefixandSnsTopicArn). Once the synthesis task is created, this operation will return aSpeechSynthesisTaskobject, which will include an identifier of this task as well as the current status. TheSpeechSynthesisTaskobject is available for 72 hours after starting the asynchronous synthesis task.- Parameters:
startSpeechSynthesisTaskRequest-- Returns:
- Result of the StartSpeechSynthesisTask operation returned by the service.
- Throws:
TextLengthExceededException- The value of the "Text" parameter is longer than the accepted limits. For theSynthesizeSpeechAPI, the limit for input text is a maximum of 6000 characters total, of which no more than 3000 can be billed characters. For theStartSpeechSynthesisTaskAPI, 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 theOutputFormatselected. Speech marks are only available for content injsonformat.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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PollyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 (OutputS3KeyPrefixandSnsTopicArn). Once the synthesis task is created, this operation will return aSpeechSynthesisTaskobject, which will include an identifier of this task as well as the current status. TheSpeechSynthesisTaskobject is available for 72 hours after starting the asynchronous synthesis task.
This is a convenience which creates an instance of the
StartSpeechSynthesisTaskRequest.Builderavoiding the need to create one manually viaStartSpeechSynthesisTaskRequest.builder()- Parameters:
startSpeechSynthesisTaskRequest- AConsumerthat will call methods onStartSpeechSynthesisTaskRequest.Builderto create a request.- Returns:
- Result of the StartSpeechSynthesisTask operation returned by the service.
- Throws:
TextLengthExceededException- The value of the "Text" parameter is longer than the accepted limits. For theSynthesizeSpeechAPI, the limit for input text is a maximum of 6000 characters total, of which no more than 3000 can be billed characters. For theStartSpeechSynthesisTaskAPI, 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 theOutputFormatselected. Speech marks are only available for content injsonformat.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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PollyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
synthesizeSpeech
default <ReturnT> ReturnT synthesizeSpeech(SynthesizeSpeechRequest synthesizeSpeechRequest, ResponseTransformer<SynthesizeSpeechResponse,ReturnT> responseTransformer) 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-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. SeeResponseTransformerfor 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.
- Throws:
TextLengthExceededException- The value of the "Text" parameter is longer than the accepted limits. For theSynthesizeSpeechAPI, the limit for input text is a maximum of 6000 characters total, of which no more than 3000 can be billed characters. For theStartSpeechSynthesisTaskAPI, 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 theOutputFormatselected. Speech marks are only available for content injsonformat.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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PollyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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, 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.Builderavoiding the need to create one manually viaSynthesizeSpeechRequest.builder()- Parameters:
synthesizeSpeechRequest- AConsumerthat will call methods onSynthesizeSpeechRequest.Builderto 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. SeeResponseTransformerfor 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.
- Throws:
TextLengthExceededException- The value of the "Text" parameter is longer than the accepted limits. For theSynthesizeSpeechAPI, the limit for input text is a maximum of 6000 characters total, of which no more than 3000 can be billed characters. For theStartSpeechSynthesisTaskAPI, 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 theOutputFormatselected. Speech marks are only available for content injsonformat.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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PollyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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-Pathto 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.
- Throws:
TextLengthExceededException- The value of the "Text" parameter is longer than the accepted limits. For theSynthesizeSpeechAPI, the limit for input text is a maximum of 6000 characters total, of which no more than 3000 can be billed characters. For theStartSpeechSynthesisTaskAPI, 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 theOutputFormatselected. Speech marks are only available for content injsonformat.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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PollyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
synthesizeSpeech(SynthesizeSpeechRequest, ResponseTransformer), AWS API Documentation
-
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.Builderavoiding the need to create one manually viaSynthesizeSpeechRequest.builder()- Parameters:
synthesizeSpeechRequest- AConsumerthat will call methods onSynthesizeSpeechRequest.Builderto create a request.destinationPath-Pathto 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.
- Throws:
TextLengthExceededException- The value of the "Text" parameter is longer than the accepted limits. For theSynthesizeSpeechAPI, the limit for input text is a maximum of 6000 characters total, of which no more than 3000 can be billed characters. For theStartSpeechSynthesisTaskAPI, 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 theOutputFormatselected. Speech marks are only available for content injsonformat.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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PollyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
synthesizeSpeech(SynthesizeSpeechRequest, ResponseTransformer), AWS API Documentation
-
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
ResponseInputStreamcontaining 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.
'. - Throws:
TextLengthExceededException- The value of the "Text" parameter is longer than the accepted limits. For theSynthesizeSpeechAPI, the limit for input text is a maximum of 6000 characters total, of which no more than 3000 can be billed characters. For theStartSpeechSynthesisTaskAPI, 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 theOutputFormatselected. Speech marks are only available for content injsonformat.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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PollyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
#getObject(synthesizeSpeech, ResponseTransformer), AWS API Documentation
-
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.Builderavoiding the need to create one manually viaSynthesizeSpeechRequest.builder()- Parameters:
synthesizeSpeechRequest- AConsumerthat will call methods onSynthesizeSpeechRequest.Builderto create a request.- Returns:
- A
ResponseInputStreamcontaining 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.
'. - Throws:
TextLengthExceededException- The value of the "Text" parameter is longer than the accepted limits. For theSynthesizeSpeechAPI, the limit for input text is a maximum of 6000 characters total, of which no more than 3000 can be billed characters. For theStartSpeechSynthesisTaskAPI, 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 theOutputFormatselected. Speech marks are only available for content injsonformat.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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PollyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
#getObject(synthesizeSpeech, ResponseTransformer), AWS API Documentation
-
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
ResponseBytesthat 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.
'. - Throws:
TextLengthExceededException- The value of the "Text" parameter is longer than the accepted limits. For theSynthesizeSpeechAPI, the limit for input text is a maximum of 6000 characters total, of which no more than 3000 can be billed characters. For theStartSpeechSynthesisTaskAPI, 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 theOutputFormatselected. Speech marks are only available for content injsonformat.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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PollyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
#getObject(synthesizeSpeech, ResponseTransformer), AWS API Documentation
-
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.Builderavoiding the need to create one manually viaSynthesizeSpeechRequest.builder()- Parameters:
synthesizeSpeechRequest- AConsumerthat will call methods onSynthesizeSpeechRequest.Builderto create a request.- Returns:
- A
ResponseBytesthat 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.
'. - Throws:
TextLengthExceededException- The value of the "Text" parameter is longer than the accepted limits. For theSynthesizeSpeechAPI, the limit for input text is a maximum of 6000 characters total, of which no more than 3000 can be billed characters. For theStartSpeechSynthesisTaskAPI, 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 theOutputFormatselected. Speech marks are only available for content injsonformat.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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PollyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
#getObject(synthesizeSpeech, ResponseTransformer), AWS API Documentation
-
create
static PollyClient create()
Create aPollyClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static PollyClientBuilder builder()
Create a builder that can be used to configure and create aPollyClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default PollyServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-