@Generated(value="software.amazon.awssdk:codegen") public interface PollyClient extends 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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static PollyClientBuilder |
builder()
Create a builder that can be used to configure and create a
PollyClient. |
static PollyClient |
create()
Create a
PollyClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default DeleteLexiconResponse |
deleteLexicon(Consumer<DeleteLexiconRequest.Builder> deleteLexiconRequest)
Deletes the specified pronunciation lexicon stored in an AWS Region.
|
default DeleteLexiconResponse |
deleteLexicon(DeleteLexiconRequest deleteLexiconRequest)
Deletes the specified pronunciation lexicon stored in an AWS Region.
|
default DescribeVoicesResponse |
describeVoices()
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 AWS Region.
|
default GetLexiconResponse |
getLexicon(GetLexiconRequest getLexiconRequest)
Returns the content of the specified pronunciation lexicon stored in an AWS 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 |
listLexicons()
Returns a list of pronunciation lexicons stored in an AWS Region.
|
default ListLexiconsResponse |
listLexicons(Consumer<ListLexiconsRequest.Builder> listLexiconsRequest)
Returns a list of pronunciation lexicons stored in an AWS Region.
|
default ListLexiconsResponse |
listLexicons(ListLexiconsRequest listLexiconsRequest)
Returns a list of pronunciation lexicons stored in an AWS Region.
|
default ListSpeechSynthesisTasksResponse |
listSpeechSynthesisTasks()
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 |
listSpeechSynthesisTasksPaginator()
Returns a list of SpeechSynthesisTask objects ordered by their creation date.
|
default ListSpeechSynthesisTasksIterable |
listSpeechSynthesisTasksPaginator(Consumer<ListSpeechSynthesisTasksRequest.Builder> listSpeechSynthesisTasksRequest)
Returns a list of SpeechSynthesisTask objects ordered by their creation date.
|
default ListSpeechSynthesisTasksIterable |
listSpeechSynthesisTasksPaginator(ListSpeechSynthesisTasksRequest listSpeechSynthesisTasksRequest)
Returns a list of SpeechSynthesisTask objects ordered by their creation date.
|
default PutLexiconResponse |
putLexicon(Consumer<PutLexiconRequest.Builder> putLexiconRequest)
Stores a pronunciation lexicon in an AWS Region.
|
default PutLexiconResponse |
putLexicon(PutLexiconRequest putLexiconRequest)
Stores a pronunciation lexicon in an AWS Region.
|
static ServiceMetadata |
serviceMetadata() |
default StartSpeechSynthesisTaskResponse |
startSpeechSynthesisTask(Consumer<StartSpeechSynthesisTaskRequest.Builder> startSpeechSynthesisTaskRequest)
Allows the creation of an asynchronous synthesis task, by starting a new
SpeechSynthesisTask. |
default StartSpeechSynthesisTaskResponse |
startSpeechSynthesisTask(StartSpeechSynthesisTaskRequest startSpeechSynthesisTaskRequest)
Allows the creation of an asynchronous synthesis task, by starting a new
SpeechSynthesisTask. |
default ResponseInputStream<SynthesizeSpeechResponse> |
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 filePath)
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.
|
default ResponseInputStream<SynthesizeSpeechResponse> |
synthesizeSpeech(SynthesizeSpeechRequest synthesizeSpeechRequest)
Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.
|
default SynthesizeSpeechResponse |
synthesizeSpeech(SynthesizeSpeechRequest synthesizeSpeechRequest,
Path filePath)
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.
|
serviceNameclosestatic final String SERVICE_NAME
static PollyClient create()
PollyClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static PollyClientBuilder builder()
PollyClient.default DeleteLexiconResponse deleteLexicon(DeleteLexiconRequest deleteLexiconRequest) throws LexiconNotFoundException, ServiceFailureException, AwsServiceException, SdkClientException, PollyException
Deletes the specified pronunciation lexicon stored in an AWS Region. A lexicon which has been deleted is not
available for speech synthesis, nor is it possible to retrieve it using either the GetLexicon or
ListLexicon APIs.
For more information, see Managing Lexicons.
deleteLexiconRequest - LexiconNotFoundException - Amazon Polly can't find the specified lexicon. This could be caused by a lexicon that is missing, its
name is misspelled or specifying a lexicon that is in a different region.
Verify that the lexicon exists, is in the region (see ListLexicons) and that you spelled its name is spelled correctly. Then try again.
ServiceFailureException - An unknown condition has caused a service failure.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.AwsServiceExceptiondefault DeleteLexiconResponse deleteLexicon(Consumer<DeleteLexiconRequest.Builder> deleteLexiconRequest) throws LexiconNotFoundException, ServiceFailureException, AwsServiceException, SdkClientException, PollyException
Deletes the specified pronunciation lexicon stored in an AWS Region. A lexicon which has been deleted is not
available for speech synthesis, nor is it possible to retrieve it using either the GetLexicon or
ListLexicon APIs.
For more information, see Managing Lexicons.
This is a convenience which creates an instance of the DeleteLexiconRequest.Builder avoiding the need to
create one manually via DeleteLexiconRequest.builder()
deleteLexiconRequest - A Consumer that will call methods on DeleteLexiconInput.Builder to create a request.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.AwsServiceExceptiondefault 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 by DescribeVoices.
For example, you want your news reader application to read news in a specific language, but giving a user the
option to choose the voice. Using the DescribeVoices operation you can provide the user with a list
of available voices to select from.
You can optionally specify a language code to filter the available voices. For example, if you specify
en-US, the operation returns a list of all available US English voices.
This operation requires permissions to perform the polly:DescribeVoices action.
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.AwsServiceExceptiondescribeVoices(DescribeVoicesRequest),
AWS API
Documentationdefault 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 by DescribeVoices.
For example, you want your news reader application to read news in a specific language, but giving a user the
option to choose the voice. Using the DescribeVoices operation you can provide the user with a list
of available voices to select from.
You can optionally specify a language code to filter the available voices. For example, if you specify
en-US, the operation returns a list of all available US English voices.
This operation requires permissions to perform the polly:DescribeVoices action.
describeVoicesRequest - InvalidNextTokenException - The NextToken is invalid. Verify that it's spelled correctly, and then try again.ServiceFailureException - An unknown condition has caused a service failure.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.AwsServiceExceptiondefault 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 by DescribeVoices.
For example, you want your news reader application to read news in a specific language, but giving a user the
option to choose the voice. Using the DescribeVoices operation you can provide the user with a list
of available voices to select from.
You can optionally specify a language code to filter the available voices. For example, if you specify
en-US, the operation returns a list of all available US English voices.
This operation requires permissions to perform the polly:DescribeVoices action.
This is a convenience which creates an instance of the DescribeVoicesRequest.Builder avoiding the need to
create one manually via DescribeVoicesRequest.builder()
describeVoicesRequest - A Consumer that will call methods on DescribeVoicesInput.Builder to create a request.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.AwsServiceExceptiondefault GetLexiconResponse getLexicon(GetLexiconRequest getLexiconRequest) throws LexiconNotFoundException, ServiceFailureException, AwsServiceException, SdkClientException, PollyException
Returns the content of the specified pronunciation lexicon stored in an AWS Region. For more information, see Managing Lexicons.
getLexiconRequest - LexiconNotFoundException - Amazon Polly can't find the specified lexicon. This could be caused by a lexicon that is missing, its
name is misspelled or specifying a lexicon that is in a different region.
Verify that the lexicon exists, is in the region (see ListLexicons) and that you spelled its name is spelled correctly. Then try again.
ServiceFailureException - An unknown condition has caused a service failure.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.AwsServiceExceptiondefault GetLexiconResponse getLexicon(Consumer<GetLexiconRequest.Builder> getLexiconRequest) throws LexiconNotFoundException, ServiceFailureException, AwsServiceException, SdkClientException, PollyException
Returns the content of the specified pronunciation lexicon stored in an AWS 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 via GetLexiconRequest.builder()
getLexiconRequest - A Consumer that will call methods on GetLexiconInput.Builder to create a request.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.AwsServiceExceptiondefault 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.
getSpeechSynthesisTaskRequest - InvalidTaskIdException - The provided Task ID is not valid. Please provide a valid Task ID and try again.ServiceFailureException - An unknown condition has caused a service failure.SynthesisTaskNotFoundException - The Speech Synthesis task with requested Task ID cannot be found.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.AwsServiceExceptiondefault 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 via GetSpeechSynthesisTaskRequest.builder()
getSpeechSynthesisTaskRequest - A Consumer that will call methods on GetSpeechSynthesisTaskInput.Builder to create a
request.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.AwsServiceExceptiondefault ListLexiconsResponse listLexicons() throws InvalidNextTokenException, ServiceFailureException, AwsServiceException, SdkClientException, PollyException
Returns a list of pronunciation lexicons stored in an AWS Region. For more information, see Managing Lexicons.
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.AwsServiceExceptionlistLexicons(ListLexiconsRequest),
AWS API
Documentationdefault ListLexiconsResponse listLexicons(ListLexiconsRequest listLexiconsRequest) throws InvalidNextTokenException, ServiceFailureException, AwsServiceException, SdkClientException, PollyException
Returns a list of pronunciation lexicons stored in an AWS Region. For more information, see Managing Lexicons.
listLexiconsRequest - InvalidNextTokenException - The NextToken is invalid. Verify that it's spelled correctly, and then try again.ServiceFailureException - An unknown condition has caused a service failure.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.AwsServiceExceptiondefault ListLexiconsResponse listLexicons(Consumer<ListLexiconsRequest.Builder> listLexiconsRequest) throws InvalidNextTokenException, ServiceFailureException, AwsServiceException, SdkClientException, PollyException
Returns a list of pronunciation lexicons stored in an AWS 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 via ListLexiconsRequest.builder()
listLexiconsRequest - A Consumer that will call methods on ListLexiconsInput.Builder to create a request.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.AwsServiceExceptiondefault 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.
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.AwsServiceExceptionlistSpeechSynthesisTasks(ListSpeechSynthesisTasksRequest),
AWS
API Documentationdefault 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.
listSpeechSynthesisTasksRequest - InvalidNextTokenException - The NextToken is invalid. Verify that it's spelled correctly, and then try again.ServiceFailureException - An unknown condition has caused a service failure.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.AwsServiceExceptiondefault 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 via ListSpeechSynthesisTasksRequest.builder()
listSpeechSynthesisTasksRequest - A Consumer that will call methods on ListSpeechSynthesisTasksInput.Builder to create a
request.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.AwsServiceExceptiondefault ListSpeechSynthesisTasksIterable listSpeechSynthesisTasksPaginator() 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 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
software.amazon.awssdk.services.polly.paginators.ListSpeechSynthesisTasksIterable responses = client.listSpeechSynthesisTasksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.polly.paginators.ListSpeechSynthesisTasksIterable responses = client.listSpeechSynthesisTasksPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listSpeechSynthesisTasks(software.amazon.awssdk.services.polly.model.ListSpeechSynthesisTasksRequest)
operation.
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.AwsServiceExceptionlistSpeechSynthesisTasksPaginator(ListSpeechSynthesisTasksRequest),
AWS
API Documentationdefault ListSpeechSynthesisTasksIterable listSpeechSynthesisTasksPaginator(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.
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
software.amazon.awssdk.services.polly.paginators.ListSpeechSynthesisTasksIterable responses = client.listSpeechSynthesisTasksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.polly.paginators.ListSpeechSynthesisTasksIterable responses = client.listSpeechSynthesisTasksPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listSpeechSynthesisTasks(software.amazon.awssdk.services.polly.model.ListSpeechSynthesisTasksRequest)
operation.
listSpeechSynthesisTasksRequest - InvalidNextTokenException - The NextToken is invalid. Verify that it's spelled correctly, and then try again.ServiceFailureException - An unknown condition has caused a service failure.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.AwsServiceExceptiondefault ListSpeechSynthesisTasksIterable listSpeechSynthesisTasksPaginator(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 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
software.amazon.awssdk.services.polly.paginators.ListSpeechSynthesisTasksIterable responses = client.listSpeechSynthesisTasksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.polly.paginators.ListSpeechSynthesisTasksIterable responses = client.listSpeechSynthesisTasksPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListSpeechSynthesisTasksRequest.builder()
listSpeechSynthesisTasksRequest - A Consumer that will call methods on ListSpeechSynthesisTasksInput.Builder to create a
request.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.AwsServiceExceptiondefault PutLexiconResponse putLexicon(PutLexiconRequest putLexiconRequest) throws InvalidLexiconException, UnsupportedPlsAlphabetException, UnsupportedPlsLanguageException, LexiconSizeExceededException, MaxLexemeLengthExceededException, MaxLexiconsNumberExceededException, ServiceFailureException, AwsServiceException, SdkClientException, PollyException
Stores a pronunciation lexicon in an AWS Region. If a lexicon with the same name already exists in the region, it is overwritten by the new lexicon. Lexicon operations have eventual consistency, therefore, it might take some time before the lexicon is available to the SynthesizeSpeech operation.
For more information, see Managing Lexicons.
putLexiconRequest - InvalidLexiconException - Amazon Polly can't find the specified lexicon. Verify that the lexicon's name is spelled correctly, and
then try again.UnsupportedPlsAlphabetException - The alphabet specified by the lexicon is not a supported alphabet. Valid values are x-sampa
and ipa.UnsupportedPlsLanguageException - The language specified in the lexicon is unsupported. For a list of supported languages, see Lexicon Attributes.LexiconSizeExceededException - The maximum size of the specified lexicon would be exceeded by this operation.MaxLexemeLengthExceededException - The maximum size of the lexeme would be exceeded by this operation.MaxLexiconsNumberExceededException - The maximum number of lexicons would be exceeded by this operation.ServiceFailureException - An unknown condition has caused a service failure.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.AwsServiceExceptiondefault PutLexiconResponse putLexicon(Consumer<PutLexiconRequest.Builder> putLexiconRequest) throws InvalidLexiconException, UnsupportedPlsAlphabetException, UnsupportedPlsLanguageException, LexiconSizeExceededException, MaxLexemeLengthExceededException, MaxLexiconsNumberExceededException, ServiceFailureException, AwsServiceException, SdkClientException, PollyException
Stores a pronunciation lexicon in an AWS Region. If a lexicon with the same name already exists in the region, it is overwritten by the new lexicon. Lexicon operations have eventual consistency, therefore, it might take some time before the lexicon is available to the SynthesizeSpeech operation.
For more information, see Managing Lexicons.
This is a convenience which creates an instance of the PutLexiconRequest.Builder avoiding the need to
create one manually via PutLexiconRequest.builder()
putLexiconRequest - A Consumer that will call methods on PutLexiconInput.Builder to create a request.InvalidLexiconException - Amazon Polly can't find the specified lexicon. Verify that the lexicon's name is spelled correctly, and
then try again.UnsupportedPlsAlphabetException - The alphabet specified by the lexicon is not a supported alphabet. Valid values are x-sampa
and ipa.UnsupportedPlsLanguageException - The language specified in the lexicon is unsupported. For a list of supported languages, see Lexicon Attributes.LexiconSizeExceededException - The maximum size of the specified lexicon would be exceeded by this operation.MaxLexemeLengthExceededException - The maximum size of the lexeme would be exceeded by this operation.MaxLexiconsNumberExceededException - The maximum number of lexicons would be exceeded by this operation.ServiceFailureException - An unknown condition has caused a service failure.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.AwsServiceExceptiondefault StartSpeechSynthesisTaskResponse startSpeechSynthesisTask(StartSpeechSynthesisTaskRequest startSpeechSynthesisTaskRequest) throws TextLengthExceededException, InvalidS3BucketException, InvalidS3KeyException, InvalidSampleRateException, InvalidSnsTopicArnException, InvalidSsmlException, 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 and
SnsTopicArn). Once the synthesis task is created, this operation will return a SpeechSynthesisTask object, which
will include an identifier of this task as well as the current status.
startSpeechSynthesisTaskRequest - TextLengthExceededException - The value of the "Text" parameter is longer than the accepted limits. For the
SynthesizeSpeech API, the limit for input text is a maximum of 6000 characters total, of
which no more than 3000 can be billed characters. For the StartSpeechSynthesisTask API, the
maximum is 200,000 characters, of which no more than 100,000 can be billed characters. SSML tags are not
counted as billed characters.InvalidS3BucketException - The provided Amazon S3 bucket name is invalid. Please check your input with S3 bucket naming requirements
and try again.InvalidS3KeyException - The provided Amazon S3 key prefix is invalid. Please provide a valid S3 object key name.InvalidSampleRateException - The specified sample rate is not valid.InvalidSnsTopicArnException - The provided SNS topic ARN is invalid. Please provide a valid SNS topic ARN and try again.InvalidSsmlException - The SSML you provided is invalid. Verify the SSML syntax, spelling of tags and values, and then try
again.LexiconNotFoundException - Amazon Polly can't find the specified lexicon. This could be caused by a lexicon that is missing, its
name is misspelled or specifying a lexicon that is in a different region.
Verify that the lexicon exists, is in the region (see ListLexicons) and that you spelled its name is spelled correctly. Then try again.
ServiceFailureException - An unknown condition has caused a service failure.MarksNotSupportedForFormatException - Speech marks are not supported for the OutputFormat selected. Speech marks are only
available for content in json format.SsmlMarksNotSupportedForTextTypeException - SSML speech marks are not supported for plain text-type input.LanguageNotSupportedException - The language specified is not currently supported by Amazon Polly in this capacity.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.AwsServiceExceptiondefault StartSpeechSynthesisTaskResponse startSpeechSynthesisTask(Consumer<StartSpeechSynthesisTaskRequest.Builder> startSpeechSynthesisTaskRequest) throws TextLengthExceededException, InvalidS3BucketException, InvalidS3KeyException, InvalidSampleRateException, InvalidSnsTopicArnException, InvalidSsmlException, 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 and
SnsTopicArn). Once the synthesis task is created, this operation will return a SpeechSynthesisTask object, which
will include an identifier of this task as well as the current status.
This is a convenience which creates an instance of the StartSpeechSynthesisTaskRequest.Builder avoiding
the need to create one manually via StartSpeechSynthesisTaskRequest.builder()
startSpeechSynthesisTaskRequest - A Consumer that will call methods on StartSpeechSynthesisTaskInput.Builder to create a
request.TextLengthExceededException - The value of the "Text" parameter is longer than the accepted limits. For the
SynthesizeSpeech API, the limit for input text is a maximum of 6000 characters total, of
which no more than 3000 can be billed characters. For the StartSpeechSynthesisTask API, the
maximum is 200,000 characters, of which no more than 100,000 can be billed characters. SSML tags are not
counted as billed characters.InvalidS3BucketException - The provided Amazon S3 bucket name is invalid. Please check your input with S3 bucket naming requirements
and try again.InvalidS3KeyException - The provided Amazon S3 key prefix is invalid. Please provide a valid S3 object key name.InvalidSampleRateException - The specified sample rate is not valid.InvalidSnsTopicArnException - The provided SNS topic ARN is invalid. Please provide a valid SNS topic ARN and try again.InvalidSsmlException - The SSML you provided is invalid. Verify the SSML syntax, spelling of tags and values, and then try
again.LexiconNotFoundException - Amazon Polly can't find the specified lexicon. This could be caused by a lexicon that is missing, its
name is misspelled or specifying a lexicon that is in a different region.
Verify that the lexicon exists, is in the region (see ListLexicons) and that you spelled its name is spelled correctly. Then try again.
ServiceFailureException - An unknown condition has caused a service failure.MarksNotSupportedForFormatException - Speech marks are not supported for the OutputFormat selected. Speech marks are only
available for content in json format.SsmlMarksNotSupportedForTextTypeException - SSML speech marks are not supported for plain text-type input.LanguageNotSupportedException - The language specified is not currently supported by Amazon Polly in this capacity.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.AwsServiceExceptiondefault <ReturnT> ReturnT synthesizeSpeech(SynthesizeSpeechRequest synthesizeSpeechRequest, ResponseTransformer<SynthesizeSpeechResponse,ReturnT> responseTransformer) throws TextLengthExceededException, InvalidSampleRateException, InvalidSsmlException, LexiconNotFoundException, ServiceFailureException, MarksNotSupportedForFormatException, SsmlMarksNotSupportedForTextTypeException, LanguageNotSupportedException, 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.
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. See
ResponseTransformer 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.
'.TextLengthExceededException - The value of the "Text" parameter is longer than the accepted limits. For the
SynthesizeSpeech API, the limit for input text is a maximum of 6000 characters total, of
which no more than 3000 can be billed characters. For the StartSpeechSynthesisTask API, the
maximum is 200,000 characters, of which no more than 100,000 can be billed characters. SSML tags are not
counted as billed characters.InvalidSampleRateException - The specified sample rate is not valid.InvalidSsmlException - The SSML you provided is invalid. Verify the SSML syntax, spelling of tags and values, and then try
again.LexiconNotFoundException - Amazon Polly can't find the specified lexicon. This could be caused by a lexicon that is missing, its
name is misspelled or specifying a lexicon that is in a different region.
Verify that the lexicon exists, is in the region (see ListLexicons) and that you spelled its name is spelled correctly. Then try again.
ServiceFailureException - An unknown condition has caused a service failure.MarksNotSupportedForFormatException - Speech marks are not supported for the OutputFormat selected. Speech marks are only
available for content in json format.SsmlMarksNotSupportedForTextTypeException - SSML speech marks are not supported for plain text-type input.LanguageNotSupportedException - The language specified is not currently supported by Amazon Polly in this capacity.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.AwsServiceExceptiondefault <ReturnT> ReturnT synthesizeSpeech(Consumer<SynthesizeSpeechRequest.Builder> synthesizeSpeechRequest, ResponseTransformer<SynthesizeSpeechResponse,ReturnT> responseTransformer) throws TextLengthExceededException, InvalidSampleRateException, InvalidSsmlException, LexiconNotFoundException, ServiceFailureException, MarksNotSupportedForFormatException, SsmlMarksNotSupportedForTextTypeException, LanguageNotSupportedException, 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 via SynthesizeSpeechRequest.builder()
synthesizeSpeechRequest - A Consumer that will call methods on SynthesizeSpeechInput.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. See
ResponseTransformer 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.
'.TextLengthExceededException - The value of the "Text" parameter is longer than the accepted limits. For the
SynthesizeSpeech API, the limit for input text is a maximum of 6000 characters total, of
which no more than 3000 can be billed characters. For the StartSpeechSynthesisTask API, the
maximum is 200,000 characters, of which no more than 100,000 can be billed characters. SSML tags are not
counted as billed characters.InvalidSampleRateException - The specified sample rate is not valid.InvalidSsmlException - The SSML you provided is invalid. Verify the SSML syntax, spelling of tags and values, and then try
again.LexiconNotFoundException - Amazon Polly can't find the specified lexicon. This could be caused by a lexicon that is missing, its
name is misspelled or specifying a lexicon that is in a different region.
Verify that the lexicon exists, is in the region (see ListLexicons) and that you spelled its name is spelled correctly. Then try again.
ServiceFailureException - An unknown condition has caused a service failure.MarksNotSupportedForFormatException - Speech marks are not supported for the OutputFormat selected. Speech marks are only
available for content in json format.SsmlMarksNotSupportedForTextTypeException - SSML speech marks are not supported for plain text-type input.LanguageNotSupportedException - The language specified is not currently supported by Amazon Polly in this capacity.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.AwsServiceExceptiondefault SynthesizeSpeechResponse synthesizeSpeech(SynthesizeSpeechRequest synthesizeSpeechRequest, Path filePath) throws TextLengthExceededException, InvalidSampleRateException, InvalidSsmlException, LexiconNotFoundException, ServiceFailureException, MarksNotSupportedForFormatException, SsmlMarksNotSupportedForTextTypeException, LanguageNotSupportedException, 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.
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.
'.TextLengthExceededException - The value of the "Text" parameter is longer than the accepted limits. For the
SynthesizeSpeech API, the limit for input text is a maximum of 6000 characters total, of
which no more than 3000 can be billed characters. For the StartSpeechSynthesisTask API, the
maximum is 200,000 characters, of which no more than 100,000 can be billed characters. SSML tags are not
counted as billed characters.InvalidSampleRateException - The specified sample rate is not valid.InvalidSsmlException - The SSML you provided is invalid. Verify the SSML syntax, spelling of tags and values, and then try
again.LexiconNotFoundException - Amazon Polly can't find the specified lexicon. This could be caused by a lexicon that is missing, its
name is misspelled or specifying a lexicon that is in a different region.
Verify that the lexicon exists, is in the region (see ListLexicons) and that you spelled its name is spelled correctly. Then try again.
ServiceFailureException - An unknown condition has caused a service failure.MarksNotSupportedForFormatException - Speech marks are not supported for the OutputFormat selected. Speech marks are only
available for content in json format.SsmlMarksNotSupportedForTextTypeException - SSML speech marks are not supported for plain text-type input.LanguageNotSupportedException - The language specified is not currently supported by Amazon Polly in this capacity.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.AwsServiceExceptionsynthesizeSpeech(SynthesizeSpeechRequest, ResponseTransformer),
AWS API
Documentationdefault SynthesizeSpeechResponse synthesizeSpeech(Consumer<SynthesizeSpeechRequest.Builder> synthesizeSpeechRequest, Path filePath) throws TextLengthExceededException, InvalidSampleRateException, InvalidSsmlException, LexiconNotFoundException, ServiceFailureException, MarksNotSupportedForFormatException, SsmlMarksNotSupportedForTextTypeException, LanguageNotSupportedException, 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 via SynthesizeSpeechRequest.builder()
synthesizeSpeechRequest - A Consumer that will call methods on SynthesizeSpeechInput.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.
'.TextLengthExceededException - The value of the "Text" parameter is longer than the accepted limits. For the
SynthesizeSpeech API, the limit for input text is a maximum of 6000 characters total, of
which no more than 3000 can be billed characters. For the StartSpeechSynthesisTask API, the
maximum is 200,000 characters, of which no more than 100,000 can be billed characters. SSML tags are not
counted as billed characters.InvalidSampleRateException - The specified sample rate is not valid.InvalidSsmlException - The SSML you provided is invalid. Verify the SSML syntax, spelling of tags and values, and then try
again.LexiconNotFoundException - Amazon Polly can't find the specified lexicon. This could be caused by a lexicon that is missing, its
name is misspelled or specifying a lexicon that is in a different region.
Verify that the lexicon exists, is in the region (see ListLexicons) and that you spelled its name is spelled correctly. Then try again.
ServiceFailureException - An unknown condition has caused a service failure.MarksNotSupportedForFormatException - Speech marks are not supported for the OutputFormat selected. Speech marks are only
available for content in json format.SsmlMarksNotSupportedForTextTypeException - SSML speech marks are not supported for plain text-type input.LanguageNotSupportedException - The language specified is not currently supported by Amazon Polly in this capacity.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.AwsServiceExceptionsynthesizeSpeech(SynthesizeSpeechRequest, ResponseTransformer),
AWS API
Documentationdefault ResponseInputStream<SynthesizeSpeechResponse> synthesizeSpeech(SynthesizeSpeechRequest synthesizeSpeechRequest) throws TextLengthExceededException, InvalidSampleRateException, InvalidSsmlException, LexiconNotFoundException, ServiceFailureException, MarksNotSupportedForFormatException, SsmlMarksNotSupportedForTextTypeException, LanguageNotSupportedException, 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.
synthesizeSpeechRequest - 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 via
ResponseInputStream.response(). The service documentation for the response content is as follows
'
Stream containing the synthesized speech.
'.TextLengthExceededException - The value of the "Text" parameter is longer than the accepted limits. For the
SynthesizeSpeech API, the limit for input text is a maximum of 6000 characters total, of
which no more than 3000 can be billed characters. For the StartSpeechSynthesisTask API, the
maximum is 200,000 characters, of which no more than 100,000 can be billed characters. SSML tags are not
counted as billed characters.InvalidSampleRateException - The specified sample rate is not valid.InvalidSsmlException - The SSML you provided is invalid. Verify the SSML syntax, spelling of tags and values, and then try
again.LexiconNotFoundException - Amazon Polly can't find the specified lexicon. This could be caused by a lexicon that is missing, its
name is misspelled or specifying a lexicon that is in a different region.
Verify that the lexicon exists, is in the region (see ListLexicons) and that you spelled its name is spelled correctly. Then try again.
ServiceFailureException - An unknown condition has caused a service failure.MarksNotSupportedForFormatException - Speech marks are not supported for the OutputFormat selected. Speech marks are only
available for content in json format.SsmlMarksNotSupportedForTextTypeException - SSML speech marks are not supported for plain text-type input.LanguageNotSupportedException - The language specified is not currently supported by Amazon Polly in this capacity.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#getObject(synthesizeSpeech, ResponseTransformer),
AWS API
Documentationdefault ResponseInputStream<SynthesizeSpeechResponse> synthesizeSpeech(Consumer<SynthesizeSpeechRequest.Builder> synthesizeSpeechRequest) throws TextLengthExceededException, InvalidSampleRateException, InvalidSsmlException, LexiconNotFoundException, ServiceFailureException, MarksNotSupportedForFormatException, SsmlMarksNotSupportedForTextTypeException, LanguageNotSupportedException, 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 via SynthesizeSpeechRequest.builder()
synthesizeSpeechRequest - A Consumer that will call methods on SynthesizeSpeechInput.Builder to create a request.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 via
ResponseInputStream.response(). The service documentation for the response content is as follows
'
Stream containing the synthesized speech.
'.TextLengthExceededException - The value of the "Text" parameter is longer than the accepted limits. For the
SynthesizeSpeech API, the limit for input text is a maximum of 6000 characters total, of
which no more than 3000 can be billed characters. For the StartSpeechSynthesisTask API, the
maximum is 200,000 characters, of which no more than 100,000 can be billed characters. SSML tags are not
counted as billed characters.InvalidSampleRateException - The specified sample rate is not valid.InvalidSsmlException - The SSML you provided is invalid. Verify the SSML syntax, spelling of tags and values, and then try
again.LexiconNotFoundException - Amazon Polly can't find the specified lexicon. This could be caused by a lexicon that is missing, its
name is misspelled or specifying a lexicon that is in a different region.
Verify that the lexicon exists, is in the region (see ListLexicons) and that you spelled its name is spelled correctly. Then try again.
ServiceFailureException - An unknown condition has caused a service failure.MarksNotSupportedForFormatException - Speech marks are not supported for the OutputFormat selected. Speech marks are only
available for content in json format.SsmlMarksNotSupportedForTextTypeException - SSML speech marks are not supported for plain text-type input.LanguageNotSupportedException - The language specified is not currently supported by Amazon Polly in this capacity.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#getObject(synthesizeSpeech, ResponseTransformer),
AWS API
Documentationdefault ResponseBytes<SynthesizeSpeechResponse> synthesizeSpeechAsBytes(SynthesizeSpeechRequest synthesizeSpeechRequest) throws TextLengthExceededException, InvalidSampleRateException, InvalidSsmlException, LexiconNotFoundException, ServiceFailureException, MarksNotSupportedForFormatException, SsmlMarksNotSupportedForTextTypeException, LanguageNotSupportedException, 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.
synthesizeSpeechRequest - 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 via ResponseBytes.response(). The service documentation for the response content is
as follows '
Stream containing the synthesized speech.
'.TextLengthExceededException - The value of the "Text" parameter is longer than the accepted limits. For the
SynthesizeSpeech API, the limit for input text is a maximum of 6000 characters total, of
which no more than 3000 can be billed characters. For the StartSpeechSynthesisTask API, the
maximum is 200,000 characters, of which no more than 100,000 can be billed characters. SSML tags are not
counted as billed characters.InvalidSampleRateException - The specified sample rate is not valid.InvalidSsmlException - The SSML you provided is invalid. Verify the SSML syntax, spelling of tags and values, and then try
again.LexiconNotFoundException - Amazon Polly can't find the specified lexicon. This could be caused by a lexicon that is missing, its
name is misspelled or specifying a lexicon that is in a different region.
Verify that the lexicon exists, is in the region (see ListLexicons) and that you spelled its name is spelled correctly. Then try again.
ServiceFailureException - An unknown condition has caused a service failure.MarksNotSupportedForFormatException - Speech marks are not supported for the OutputFormat selected. Speech marks are only
available for content in json format.SsmlMarksNotSupportedForTextTypeException - SSML speech marks are not supported for plain text-type input.LanguageNotSupportedException - The language specified is not currently supported by Amazon Polly in this capacity.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#getObject(synthesizeSpeech, ResponseTransformer),
AWS API
Documentationdefault ResponseBytes<SynthesizeSpeechResponse> synthesizeSpeechAsBytes(Consumer<SynthesizeSpeechRequest.Builder> synthesizeSpeechRequest) throws TextLengthExceededException, InvalidSampleRateException, InvalidSsmlException, LexiconNotFoundException, ServiceFailureException, MarksNotSupportedForFormatException, SsmlMarksNotSupportedForTextTypeException, LanguageNotSupportedException, 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 via SynthesizeSpeechRequest.builder()
synthesizeSpeechRequest - A Consumer that will call methods on SynthesizeSpeechInput.Builder to create a request.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 via ResponseBytes.response(). The service documentation for the response content is
as follows '
Stream containing the synthesized speech.
'.TextLengthExceededException - The value of the "Text" parameter is longer than the accepted limits. For the
SynthesizeSpeech API, the limit for input text is a maximum of 6000 characters total, of
which no more than 3000 can be billed characters. For the StartSpeechSynthesisTask API, the
maximum is 200,000 characters, of which no more than 100,000 can be billed characters. SSML tags are not
counted as billed characters.InvalidSampleRateException - The specified sample rate is not valid.InvalidSsmlException - The SSML you provided is invalid. Verify the SSML syntax, spelling of tags and values, and then try
again.LexiconNotFoundException - Amazon Polly can't find the specified lexicon. This could be caused by a lexicon that is missing, its
name is misspelled or specifying a lexicon that is in a different region.
Verify that the lexicon exists, is in the region (see ListLexicons) and that you spelled its name is spelled correctly. Then try again.
ServiceFailureException - An unknown condition has caused a service failure.MarksNotSupportedForFormatException - Speech marks are not supported for the OutputFormat selected. Speech marks are only
available for content in json format.SsmlMarksNotSupportedForTextTypeException - SSML speech marks are not supported for plain text-type input.LanguageNotSupportedException - The language specified is not currently supported by Amazon Polly in this capacity.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#getObject(synthesizeSpeech, ResponseTransformer),
AWS API
Documentationstatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.