Interface PollyClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface PollyClient
extends AwsClient

Service client for accessing Amazon Polly. This can be created using the static 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.

Authenticated API calls must be signed using the Signature Version 4 Signing Process. For more information, see Signing Amazon Web Services API Requests in the IAM User Guide.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	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 Amazon Web Services Region.
default DeleteLexiconResponse	deleteLexicon(DeleteLexiconRequest deleteLexiconRequest)	Deletes the specified pronunciation lexicon stored in an Amazon Web Services 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 Amazon Web Services Region.
default GetLexiconResponse	getLexicon(GetLexiconRequest getLexiconRequest)	Returns the content of the specified pronunciation lexicon stored in an Amazon Web Services Region.
default GetSpeechSynthesisTaskResponse	getSpeechSynthesisTask(Consumer<GetSpeechSynthesisTaskRequest.Builder> getSpeechSynthesisTaskRequest)	Retrieves a specific SpeechSynthesisTask object based on its TaskID.
default GetSpeechSynthesisTaskResponse	getSpeechSynthesisTask(GetSpeechSynthesisTaskRequest getSpeechSynthesisTaskRequest)	Retrieves a specific SpeechSynthesisTask object based on its TaskID.
default ListLexiconsResponse	listLexicons()	Returns a list of pronunciation lexicons stored in an Amazon Web Services Region.
default ListLexiconsResponse	listLexicons(Consumer<ListLexiconsRequest.Builder> listLexiconsRequest)	Returns a list of pronunciation lexicons stored in an Amazon Web Services Region.
default ListLexiconsResponse	listLexicons(ListLexiconsRequest listLexiconsRequest)	Returns a list of pronunciation lexicons stored in an Amazon Web Services Region.
default ListSpeechSynthesisTasksResponse	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()	This is a variant of listSpeechSynthesisTasks(software.amazon.awssdk.services.polly.model.ListSpeechSynthesisTasksRequest) operation.
default ListSpeechSynthesisTasksIterable	listSpeechSynthesisTasksPaginator(Consumer<ListSpeechSynthesisTasksRequest.Builder> listSpeechSynthesisTasksRequest)	This is a variant of listSpeechSynthesisTasks(software.amazon.awssdk.services.polly.model.ListSpeechSynthesisTasksRequest) operation.
default ListSpeechSynthesisTasksIterable	listSpeechSynthesisTasksPaginator(ListSpeechSynthesisTasksRequest listSpeechSynthesisTasksRequest)	This is a variant of listSpeechSynthesisTasks(software.amazon.awssdk.services.polly.model.ListSpeechSynthesisTasksRequest) operation.
default PutLexiconResponse	putLexicon(Consumer<PutLexiconRequest.Builder> putLexiconRequest)	Stores a pronunciation lexicon in an Amazon Web Services Region.
default PutLexiconResponse	putLexicon(PutLexiconRequest putLexiconRequest)	Stores a pronunciation lexicon in an Amazon Web Services Region.
default PollyServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
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 destinationPath)	Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.
default <ReturnT> ReturnT	synthesizeSpeech(Consumer<SynthesizeSpeechRequest.Builder> synthesizeSpeechRequest, ResponseTransformer<SynthesizeSpeechResponse,ReturnT> responseTransformer)	Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.
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 destinationPath)	Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.
default <ReturnT> ReturnT	synthesizeSpeech(SynthesizeSpeechRequest synthesizeSpeechRequest, ResponseTransformer<SynthesizeSpeechResponse,ReturnT> responseTransformer)	Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.
default ResponseBytes<SynthesizeSpeechResponse>	synthesizeSpeechAsBytes(Consumer<SynthesizeSpeechRequest.Builder> synthesizeSpeechRequest)	Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.
default ResponseBytes<SynthesizeSpeechResponse>	synthesizeSpeechAsBytes(SynthesizeSpeechRequest synthesizeSpeechRequest)	Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

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 the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

deleteLexicon

default DeleteLexiconResponse deleteLexicon(DeleteLexiconRequest deleteLexiconRequest)
                                     throws LexiconNotFoundException,
ServiceFailureException,
AwsServiceException,
SdkClientException,
PollyException

Deletes the specified pronunciation lexicon stored in an Amazon Web Services Region. A lexicon which has been deleted is not available for speech synthesis, nor is it possible to retrieve it using either the GetLexicon or ListLexicon APIs.

For more information, see Managing Lexicons.

Parameters:

deleteLexiconRequest -

Returns:

Result of the DeleteLexicon operation returned by the service.

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 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()

Parameters:

deleteLexiconRequest - A Consumer that will call methods on DeleteLexiconRequest.Builder to create a request.

Returns:

Result of the DeleteLexicon operation returned by the service.

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 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.

Parameters:

describeVoicesRequest -

Returns:

Result of the DescribeVoices operation returned by the service.

See Also:

• AWS API Documentation
• Code Example

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 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()

Parameters:

describeVoicesRequest - A Consumer that will call methods on DescribeVoicesRequest.Builder to create a request.

Returns:

Result of the DescribeVoices operation returned by the service.

See Also:

• AWS API Documentation
• Code Example

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 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.

Returns:

Result of the DescribeVoices operation returned by the service.

See Also:

• describeVoices(DescribeVoicesRequest)
• AWS API Documentation
• Code Example

getLexicon

default GetLexiconResponse getLexicon(GetLexiconRequest getLexiconRequest)
                               throws LexiconNotFoundException,
ServiceFailureException,
AwsServiceException,
SdkClientException,
PollyException

Returns the content of the specified pronunciation lexicon stored in an Amazon Web Services Region. For more information, see Managing Lexicons.

Parameters:

getLexiconRequest -

Returns:

Result of the GetLexicon operation returned by the service.

See Also:

• 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.Builder avoiding the need to create one manually via GetLexiconRequest.builder()

Parameters:

getLexiconRequest - A Consumer that will call methods on GetLexiconRequest.Builder to create a request.

Returns:

Result of the GetLexicon operation returned by the service.

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.

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.Builder avoiding the need to create one manually via GetSpeechSynthesisTaskRequest.builder()

Parameters:

getSpeechSynthesisTaskRequest - A Consumer that will call methods on GetSpeechSynthesisTaskRequest.Builder to create a request.

Returns:

Result of the GetSpeechSynthesisTask operation returned by the service.

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.

See Also:

• AWS API Documentation
• Code Example

listLexicons

default ListLexiconsResponse listLexicons(Consumer<ListLexiconsRequest.Builder> listLexiconsRequest)
                                   throws InvalidNextTokenException,
ServiceFailureException,
AwsServiceException,
SdkClientException,
PollyException

Returns a list of pronunciation lexicons stored in an Amazon Web Services Region. For more information, see Managing Lexicons.

This is a convenience which creates an instance of the ListLexiconsRequest.Builder avoiding the need to create one manually via ListLexiconsRequest.builder()

Parameters:

listLexiconsRequest - A Consumer that will call methods on ListLexiconsRequest.Builder to create a request.

Returns:

Result of the ListLexicons operation returned by the service.

See Also:

• AWS API Documentation
• Code Example

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.

See Also:

• listLexicons(ListLexiconsRequest)
• AWS API Documentation
• Code Example

listSpeechSynthesisTasks

default ListSpeechSynthesisTasksResponse listSpeechSynthesisTasks(ListSpeechSynthesisTasksRequest listSpeechSynthesisTasksRequest)
                                                           throws InvalidNextTokenException,
ServiceFailureException,
AwsServiceException,
SdkClientException,
PollyException

Returns a list of SpeechSynthesisTask objects ordered by their creation date. This operation can filter the tasks by their status, for example, allowing users to list only tasks that are completed.

Parameters:

listSpeechSynthesisTasksRequest -

Returns:

Result of the ListSpeechSynthesisTasks operation returned by the service.

See Also:

• 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.Builder avoiding the need to create one manually via ListSpeechSynthesisTasksRequest.builder()

Parameters:

listSpeechSynthesisTasksRequest - A Consumer that will call methods on ListSpeechSynthesisTasksRequest.Builder to create a request.

Returns:

Result of the ListSpeechSynthesisTasks operation returned by the service.

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.

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

 
 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(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSpeechSynthesisTasks(software.amazon.awssdk.services.polly.model.ListSpeechSynthesisTasksRequest) operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• listSpeechSynthesisTasksPaginator(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

 
 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(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSpeechSynthesisTasks(software.amazon.awssdk.services.polly.model.ListSpeechSynthesisTasksRequest) operation.

Parameters:

listSpeechSynthesisTasksRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• 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

 
 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(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSpeechSynthesisTasks(software.amazon.awssdk.services.polly.model.ListSpeechSynthesisTasksRequest) operation.

This is a convenience which creates an instance of the ListSpeechSynthesisTasksRequest.Builder avoiding the need to create one manually via ListSpeechSynthesisTasksRequest.builder()

Parameters:

listSpeechSynthesisTasksRequest - A Consumer that will call methods on ListSpeechSynthesisTasksRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

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.Builder avoiding the need to create one manually via PutLexiconRequest.builder()

Parameters:

putLexiconRequest - A Consumer that will call methods on PutLexiconRequest.Builder to create a request.

Returns:

Result of the PutLexicon operation returned by the service.

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 ( OutputS3KeyPrefix and SnsTopicArn). Once the synthesis task is created, this operation will return a SpeechSynthesisTask object, which will include an identifier of this task as well as the current status. The SpeechSynthesisTask object is available for 72 hours after starting the asynchronous synthesis task.

Parameters:

startSpeechSynthesisTaskRequest -

Returns:

Result of the StartSpeechSynthesisTask operation returned by the service.

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 ( OutputS3KeyPrefix and SnsTopicArn). Once the synthesis task is created, this operation will return a SpeechSynthesisTask object, which will include an identifier of this task as well as the current status. The SpeechSynthesisTask object is available for 72 hours after starting the asynchronous synthesis task.

This is a convenience which creates an instance of the StartSpeechSynthesisTaskRequest.Builder avoiding the need to create one manually via StartSpeechSynthesisTaskRequest.builder()

Parameters:

startSpeechSynthesisTaskRequest - A Consumer that will call methods on StartSpeechSynthesisTaskRequest.Builder to create a request.

Returns:

Result of the StartSpeechSynthesisTask operation returned by the service.

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. 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.

'.

Returns:

The transformed result of the ResponseTransformer.

See Also:

• AWS API Documentation
• Code Example

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.Builder avoiding the need to create one manually via SynthesizeSpeechRequest.builder()

Parameters:

synthesizeSpeechRequest - A Consumer that will call methods on SynthesizeSpeechRequest.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.

'.

Returns:

The transformed result of the ResponseTransformer.

See Also:

• AWS API Documentation
• Code Example

synthesizeSpeech

default SynthesizeSpeechResponse synthesizeSpeech(SynthesizeSpeechRequest synthesizeSpeechRequest,
 Path destinationPath)
                                           throws TextLengthExceededException,
InvalidSampleRateException,
InvalidSsmlException,
LexiconNotFoundException,
ServiceFailureException,
MarksNotSupportedForFormatException,
SsmlMarksNotSupportedForTextTypeException,
LanguageNotSupportedException,
EngineNotSupportedException,
AwsServiceException,
SdkClientException,
PollyException

Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes. SSML input must be valid, well-formed SSML. Some alphabets might not be available with all the voices (for example, Cyrillic might not be read at all by English voices) unless phoneme mapping is used. For more information, see How it Works.

Parameters:

synthesizeSpeechRequest -

destinationPath - Path to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows '

Stream containing the synthesized speech.

'.

Returns:

The transformed result of the ResponseTransformer.

See Also:

• synthesizeSpeech(SynthesizeSpeechRequest, ResponseTransformer)
• AWS API Documentation
• Code Example

synthesizeSpeech

default SynthesizeSpeechResponse synthesizeSpeech(Consumer<SynthesizeSpeechRequest.Builder> synthesizeSpeechRequest,
 Path destinationPath)
                                           throws TextLengthExceededException,
InvalidSampleRateException,
InvalidSsmlException,
LexiconNotFoundException,
ServiceFailureException,
MarksNotSupportedForFormatException,
SsmlMarksNotSupportedForTextTypeException,
LanguageNotSupportedException,
EngineNotSupportedException,
AwsServiceException,
SdkClientException,
PollyException

Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes. SSML input must be valid, well-formed SSML. Some alphabets might not be available with all the voices (for example, Cyrillic might not be read at all by English voices) unless phoneme mapping is used. For more information, see How it Works.

This is a convenience which creates an instance of the SynthesizeSpeechRequest.Builder avoiding the need to create one manually via SynthesizeSpeechRequest.builder()

Parameters:

synthesizeSpeechRequest - A Consumer that will call methods on SynthesizeSpeechRequest.Builder to create a request.

destinationPath - Path to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows '

Stream containing the synthesized speech.

'.

Returns:

The transformed result of the ResponseTransformer.

See Also:

• synthesizeSpeech(SynthesizeSpeechRequest, ResponseTransformer)
• AWS API Documentation
• Code Example

synthesizeSpeech

default ResponseInputStream<SynthesizeSpeechResponse> synthesizeSpeech(SynthesizeSpeechRequest synthesizeSpeechRequest)
                                                                throws TextLengthExceededException,
InvalidSampleRateException,
InvalidSsmlException,
LexiconNotFoundException,
ServiceFailureException,
MarksNotSupportedForFormatException,
SsmlMarksNotSupportedForTextTypeException,
LanguageNotSupportedException,
EngineNotSupportedException,
AwsServiceException,
SdkClientException,
PollyException

Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes. SSML input must be valid, well-formed SSML. Some alphabets might not be available with all the voices (for example, Cyrillic might not be read at all by English voices) unless phoneme mapping is used. For more information, see How it Works.

Parameters:

synthesizeSpeechRequest -

Returns:

A ResponseInputStream containing data streamed from service. Note that this is an unmanaged reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior and exhausting connections in the connection pool. The unmarshalled response object can be obtained via ResponseInputStream.response(). The service documentation for the response content is as follows '

Stream containing the synthesized speech.

'.

See Also:

• invalid reference

  #getObject(synthesizeSpeech, ResponseTransformer)

• AWS API Documentation
• Code Example

synthesizeSpeech

default ResponseInputStream<SynthesizeSpeechResponse> synthesizeSpeech(Consumer<SynthesizeSpeechRequest.Builder> synthesizeSpeechRequest)
                                                                throws TextLengthExceededException,
InvalidSampleRateException,
InvalidSsmlException,
LexiconNotFoundException,
ServiceFailureException,
MarksNotSupportedForFormatException,
SsmlMarksNotSupportedForTextTypeException,
LanguageNotSupportedException,
EngineNotSupportedException,
AwsServiceException,
SdkClientException,
PollyException

Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes. SSML input must be valid, well-formed SSML. Some alphabets might not be available with all the voices (for example, Cyrillic might not be read at all by English voices) unless phoneme mapping is used. For more information, see How it Works.

This is a convenience which creates an instance of the SynthesizeSpeechRequest.Builder avoiding the need to create one manually via SynthesizeSpeechRequest.builder()

Parameters:

synthesizeSpeechRequest - A Consumer that will call methods on SynthesizeSpeechRequest.Builder to create a request.

Returns:

A ResponseInputStream containing data streamed from service. Note that this is an unmanaged reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior and exhausting connections in the connection pool. The unmarshalled response object can be obtained via ResponseInputStream.response(). The service documentation for the response content is as follows '

Stream containing the synthesized speech.

'.

See Also:

• invalid reference

  #getObject(synthesizeSpeech, ResponseTransformer)

• AWS API Documentation
• Code Example

synthesizeSpeechAsBytes

default ResponseBytes<SynthesizeSpeechResponse> synthesizeSpeechAsBytes(SynthesizeSpeechRequest synthesizeSpeechRequest)
                                                                 throws TextLengthExceededException,
InvalidSampleRateException,
InvalidSsmlException,
LexiconNotFoundException,
ServiceFailureException,
MarksNotSupportedForFormatException,
SsmlMarksNotSupportedForTextTypeException,
LanguageNotSupportedException,
EngineNotSupportedException,
AwsServiceException,
SdkClientException,
PollyException

Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes. SSML input must be valid, well-formed SSML. Some alphabets might not be available with all the voices (for example, Cyrillic might not be read at all by English voices) unless phoneme mapping is used. For more information, see How it Works.

Parameters:

synthesizeSpeechRequest -

Returns:

A ResponseBytes that loads the data streamed from the service into memory and exposes it in convenient in-memory representations like a byte buffer or string. The unmarshalled response object can be obtained via ResponseBytes.response(). The service documentation for the response content is as follows '

Stream containing the synthesized speech.

'.

See Also:

• invalid reference

  #getObject(synthesizeSpeech, ResponseTransformer)

• AWS API Documentation
• Code Example

synthesizeSpeechAsBytes

default ResponseBytes<SynthesizeSpeechResponse> synthesizeSpeechAsBytes(Consumer<SynthesizeSpeechRequest.Builder> synthesizeSpeechRequest)
                                                                 throws TextLengthExceededException,
InvalidSampleRateException,
InvalidSsmlException,
LexiconNotFoundException,
ServiceFailureException,
MarksNotSupportedForFormatException,
SsmlMarksNotSupportedForTextTypeException,
LanguageNotSupportedException,
EngineNotSupportedException,
AwsServiceException,
SdkClientException,
PollyException

Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes. SSML input must be valid, well-formed SSML. Some alphabets might not be available with all the voices (for example, Cyrillic might not be read at all by English voices) unless phoneme mapping is used. For more information, see How it Works.

This is a convenience which creates an instance of the SynthesizeSpeechRequest.Builder avoiding the need to create one manually via SynthesizeSpeechRequest.builder()

Parameters:

synthesizeSpeechRequest - A Consumer that will call methods on SynthesizeSpeechRequest.Builder to create a request.

Returns:

A ResponseBytes that loads the data streamed from the service into memory and exposes it in convenient in-memory representations like a byte buffer or string. The unmarshalled response object can be obtained via ResponseBytes.response(). The service documentation for the response content is as follows '

Stream containing the synthesized speech.

'.

See Also:

• invalid reference

  #getObject(synthesizeSpeech, ResponseTransformer)

• AWS API Documentation
• Code Example

create

static PollyClient create()

Create a PollyClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static PollyClientBuilder builder()

Create a builder that can be used to configure and create a PollyClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default PollyServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration