com.amazonaws.services.polly

Class AmazonPollyPresigningClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.polly.AmazonPollyClient

com.amazonaws.services.polly.AmazonPollyPresigningClient

All Implemented Interfaces:

AmazonPolly

public class AmazonPollyPresigningClient
extends AmazonPollyClient
implements AmazonPolly

Client for accessing Amazon Polly. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon Polly is a web service that makes it easy to synthesize speech from text.

The Amazon Polly service provides API operations for synthesizing high-quality speech from plain text and Speech Synthesis Markup Language (SSML), along with managing pronunciations lexicons that enable you to get the best results for your application domain.

Field Summary

Fields inherited from class com.amazonaws.services.polly.AmazonPollyClient

jsonErrorUnmarshallers

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, endpointPrefix, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AmazonPollyPresigningClient(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AmazonPolly using the specified AWS account credentials provider.
AmazonPollyPresigningClient(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider, com.amazonaws.ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonPolly using the specified AWS account credentials provider and client configuration options.
AmazonPollyPresigningClient(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider, com.amazonaws.ClientConfiguration clientConfiguration, com.amazonaws.http.HttpClient httpClient) Constructs a new client to invoke service methods on AmazonPolly using the specified AWS account credentials provider, client configuration options and request metric collector.

Method Summary

Modifier and Type	Method and Description
java.net.URL	getPresignedSynthesizeSpeechUrl(SynthesizeSpeechPresignRequest synthesizeSpeechPresignRequest) Returns a pre-signed URL for accessing an Amazon Polly resource.

Methods inherited from class com.amazonaws.services.polly.AmazonPollyClient

deleteLexicon, describeVoices, getCachedResponseMetadata, getLexicon, getSpeechSynthesisTask, listLexicons, listSpeechSynthesisTasks, putLexicon, startSpeechSynthesisTask, synthesizeSpeech

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configSigner, configSigner, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpoint, getEndpointPrefix, getRegions, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

deleteLexicon, describeVoices, getCachedResponseMetadata, getLexicon, getSpeechSynthesisTask, listLexicons, listSpeechSynthesisTasks, putLexicon, setEndpoint, setRegion, shutdown, startSpeechSynthesisTask, synthesizeSpeech

Constructor Detail

AmazonPollyPresigningClient

public AmazonPollyPresigningClient(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AmazonPolly using the specified AWS account credentials provider.

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonPollyPresigningClient client = new AmazonPollyPresigningClient(AWSMobileClient.getInstance());
     }

     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonPollyPresigningClient

public AmazonPollyPresigningClient(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider,
                                   com.amazonaws.ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonPolly using the specified AWS account credentials provider and client configuration options.

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonPollyPresigningClient client = new AmazonPollyPresigningClient(AWSMobileClient.getInstance());
     }

     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonPolly (ex: proxy settings, retry counts, etc.).

AmazonPollyPresigningClient

public AmazonPollyPresigningClient(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider,
                                   com.amazonaws.ClientConfiguration clientConfiguration,
                                   com.amazonaws.http.HttpClient httpClient)

Constructs a new client to invoke service methods on AmazonPolly using the specified AWS account credentials provider, client configuration options and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonPolly (ex: proxy settings, retry counts, etc.).

httpClient - A http client

Method Detail

getPresignedSynthesizeSpeechUrl

public java.net.URL getPresignedSynthesizeSpeechUrl(SynthesizeSpeechPresignRequest synthesizeSpeechPresignRequest)

Returns a pre-signed URL for accessing an Amazon Polly resource.

Pre-signed URLs allow clients to form a URL for an Amazon Polly resource, and then sign it with the current AWS security credentials. The pre-signed URL can be shared to other users, allowing access to the resource without providing an account's AWS security credentials.

Pre-signed URLs are useful in many situations where AWS security credentials aren't available from the client that needs to make the actual request to Amazon Polly.

For example, a pre-signed URL to GET the synthesized speech audio stream using the owner's AWS account can be generated and passed to a system media player.

Parameters:

synthesizeSpeechPresignRequest - Object providing pre-signed synthesize speech request parameters.

Returns:

Pre-signed URL of audio stream containing synthesized speech matching parameters provided in synthesizeSpeechPresignRequest that is possible to obtain using HTTP GET method.