AbstractAmazonPolly (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.polly.AbstractAmazonPolly

All Implemented Interfaces:

AmazonPolly

Direct Known Subclasses:

AbstractAmazonPollyAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonPolly
extends Object
implements AmazonPolly
```
Abstract implementation of AmazonPolly. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.polly.AmazonPolly
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DeleteLexiconResult`	`deleteLexicon(DeleteLexiconRequest request)` Deletes the specified pronunciation lexicon stored in an Amazon Web Services Region.
`DescribeVoicesResult`	`describeVoices(DescribeVoicesRequest request)` Returns the list of voices that are available for use when requesting speech synthesis.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetLexiconResult`	`getLexicon(GetLexiconRequest request)` Returns the content of the specified pronunciation lexicon stored in an Amazon Web Services Region.
`GetSpeechSynthesisTaskResult`	`getSpeechSynthesisTask(GetSpeechSynthesisTaskRequest request)` Retrieves a specific SpeechSynthesisTask object based on its TaskID.
`ListLexiconsResult`	`listLexicons(ListLexiconsRequest request)` Returns a list of pronunciation lexicons stored in an Amazon Web Services Region.
`ListSpeechSynthesisTasksResult`	`listSpeechSynthesisTasks(ListSpeechSynthesisTasksRequest request)` Returns a list of SpeechSynthesisTask objects ordered by their creation date.
`AmazonPollyPresigners`	`presigners()` `AmazonPollyPresigners` contains extension methods for presigning certain requests.
`PutLexiconResult`	`putLexicon(PutLexiconRequest request)` Stores a pronunciation lexicon in an Amazon Web Services Region.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("polly.us-east-1.amazonaws.com").
`void`	`setRegion(Region region)` An alternative to `AmazonPolly.setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartSpeechSynthesisTaskResult`	`startSpeechSynthesisTask(StartSpeechSynthesisTaskRequest request)` Allows the creation of an asynchronous synthesis task, by starting a new `SpeechSynthesisTask`.
`SynthesizeSpeechResult`	`synthesizeSpeech(SynthesizeSpeechRequest request)` Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AmazonPolly
    
    Overrides the default endpoint for this client ("polly.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "polly.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "polly.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
    This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setEndpoint in interface AmazonPolly
    
    Parameters:
    
    endpoint - The endpoint (ex: "polly.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "polly.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AmazonPolly
    
    An alternative to AmazonPolly.setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
    By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.
    This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setRegion in interface AmazonPolly
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - deleteLexicon
```
public DeleteLexiconResult deleteLexicon(DeleteLexiconRequest request)
```
    Description copied from interface: AmazonPolly
    
    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.
    
    Specified by:
    
    deleteLexicon in interface AmazonPolly
    
    Returns:
    
    Result of the DeleteLexicon operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeVoices
```
public DescribeVoicesResult describeVoices(DescribeVoicesRequest request)
```
    Description copied from interface: AmazonPolly
    
    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.
    
    Specified by:
    
    describeVoices in interface AmazonPolly
    
    Returns:
    
    Result of the DescribeVoices operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getLexicon
```
public GetLexiconResult getLexicon(GetLexiconRequest request)
```
    Description copied from interface: AmazonPolly
    
    Returns the content of the specified pronunciation lexicon stored in an Amazon Web Services Region. For more information, see Managing Lexicons.
    
    Specified by:
    
    getLexicon in interface AmazonPolly
    
    Returns:
    
    Result of the GetLexicon operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getSpeechSynthesisTask
```
public GetSpeechSynthesisTaskResult getSpeechSynthesisTask(GetSpeechSynthesisTaskRequest request)
```
    Description copied from interface: AmazonPolly
    
    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.
    
    Specified by:
    
    getSpeechSynthesisTask in interface AmazonPolly
    
    Returns:
    
    Result of the GetSpeechSynthesisTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listLexicons
```
public ListLexiconsResult listLexicons(ListLexiconsRequest request)
```
    Description copied from interface: AmazonPolly
    
    Returns a list of pronunciation lexicons stored in an Amazon Web Services Region. For more information, see Managing Lexicons.
    
    Specified by:
    
    listLexicons in interface AmazonPolly
    
    Returns:
    
    Result of the ListLexicons operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listSpeechSynthesisTasks
```
public ListSpeechSynthesisTasksResult listSpeechSynthesisTasks(ListSpeechSynthesisTasksRequest request)
```
    Description copied from interface: AmazonPolly
    
    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.
    
    Specified by:
    
    listSpeechSynthesisTasks in interface AmazonPolly
    
    Returns:
    
    Result of the ListSpeechSynthesisTasks operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putLexicon
```
public PutLexiconResult putLexicon(PutLexiconRequest request)
```
    Description copied from interface: AmazonPolly
    
    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.
    
    Specified by:
    
    putLexicon in interface AmazonPolly
    
    Returns:
    
    Result of the PutLexicon operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startSpeechSynthesisTask
```
public StartSpeechSynthesisTaskResult startSpeechSynthesisTask(StartSpeechSynthesisTaskRequest request)
```
    Description copied from interface: AmazonPolly
    
    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.
    
    Specified by:
    
    startSpeechSynthesisTask in interface AmazonPolly
    
    Returns:
    
    Result of the StartSpeechSynthesisTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - synthesizeSpeech
```
public SynthesizeSpeechResult synthesizeSpeech(SynthesizeSpeechRequest request)
```
    Description copied from interface: AmazonPolly
    
    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.
    
    Specified by:
    
    synthesizeSpeech in interface AmazonPolly
    
    Returns:
    
    Result of the SynthesizeSpeech operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonPolly
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonPolly
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonPolly
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonPolly
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - presigners
```
public AmazonPollyPresigners presigners()
```
    Description copied from interface: AmazonPolly
    
    AmazonPollyPresigners contains extension methods for presigning certain requests. The presigner will use the endpoint and credentials currently configured in the client.
    
    Specified by:
    
    presigners in interface AmazonPolly
    
    Returns:
    
    Presigners utility object.

AWS SDK for Java 1.x API Reference - 1.12.792

Class AbstractAmazonPolly

Field Summary

Fields inherited from interface com.amazonaws.services.polly.AmazonPolly

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

deleteLexicon

describeVoices

getLexicon

getSpeechSynthesisTask

listLexicons

listSpeechSynthesisTasks

putLexicon

startSpeechSynthesisTask

synthesizeSpeech

shutdown

getCachedResponseMetadata

presigners