AWS SDK for C++

AWS SDK for C++ Version 1.11.440

Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
Aws::Polly::PollyClient Class Reference

#include <PollyClient.h>

Inheritance diagram for Aws::Polly::PollyClient:
[legend]

Public Types

 
 
 

Public Types inherited from Aws::Client::AWSJsonClient

 

Public Member Functions

 PollyClient (const Aws::Polly::PollyClientConfiguration &clientConfiguration=Aws::Polly::PollyClientConfiguration(), std::shared_ptr< PollyEndpointProviderBase > endpointProvider=nullptr)
 
 PollyClient (const Aws::Auth::AWSCredentials &credentials, std::shared_ptr< PollyEndpointProviderBase > endpointProvider=nullptr, const Aws::Polly::PollyClientConfiguration &clientConfiguration=Aws::Polly::PollyClientConfiguration())
 
 PollyClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, std::shared_ptr< PollyEndpointProviderBase > endpointProvider=nullptr, const Aws::Polly::PollyClientConfiguration &clientConfiguration=Aws::Polly::PollyClientConfiguration())
 
 PollyClient (const Aws::Client::ClientConfiguration &clientConfiguration)
 
 PollyClient (const Aws::Auth::AWSCredentials &credentials, const Aws::Client::ClientConfiguration &clientConfiguration)
 
 PollyClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, const Aws::Client::ClientConfiguration &clientConfiguration)
 
virtual ~PollyClient ()
 
 
template<typename DeleteLexiconRequestT = Model::DeleteLexiconRequest>
Model::DeleteLexiconOutcomeCallable DeleteLexiconCallable (const DeleteLexiconRequestT &request) const
 
template<typename DeleteLexiconRequestT = Model::DeleteLexiconRequest>
void DeleteLexiconAsync (const DeleteLexiconRequestT &request, const DeleteLexiconResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
 
template<typename DescribeVoicesRequestT = Model::DescribeVoicesRequest>
Model::DescribeVoicesOutcomeCallable DescribeVoicesCallable (const DescribeVoicesRequestT &request={}) const
 
template<typename DescribeVoicesRequestT = Model::DescribeVoicesRequest>
void DescribeVoicesAsync (const DescribeVoicesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const DescribeVoicesRequestT &request={}) const
 
 
template<typename GetLexiconRequestT = Model::GetLexiconRequest>
Model::GetLexiconOutcomeCallable GetLexiconCallable (const GetLexiconRequestT &request) const
 
template<typename GetLexiconRequestT = Model::GetLexiconRequest>
void GetLexiconAsync (const GetLexiconRequestT &request, const GetLexiconResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
 
template<typename GetSpeechSynthesisTaskRequestT = Model::GetSpeechSynthesisTaskRequest>
Model::GetSpeechSynthesisTaskOutcomeCallable GetSpeechSynthesisTaskCallable (const GetSpeechSynthesisTaskRequestT &request) const
 
template<typename GetSpeechSynthesisTaskRequestT = Model::GetSpeechSynthesisTaskRequest>
void GetSpeechSynthesisTaskAsync (const GetSpeechSynthesisTaskRequestT &request, const GetSpeechSynthesisTaskResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
 
template<typename ListLexiconsRequestT = Model::ListLexiconsRequest>
Model::ListLexiconsOutcomeCallable ListLexiconsCallable (const ListLexiconsRequestT &request={}) const
 
template<typename ListLexiconsRequestT = Model::ListLexiconsRequest>
void ListLexiconsAsync (const ListLexiconsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const ListLexiconsRequestT &request={}) const
 
 
template<typename ListSpeechSynthesisTasksRequestT = Model::ListSpeechSynthesisTasksRequest>
Model::ListSpeechSynthesisTasksOutcomeCallable ListSpeechSynthesisTasksCallable (const ListSpeechSynthesisTasksRequestT &request={}) const
 
template<typename ListSpeechSynthesisTasksRequestT = Model::ListSpeechSynthesisTasksRequest>
void ListSpeechSynthesisTasksAsync (const ListSpeechSynthesisTasksResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const ListSpeechSynthesisTasksRequestT &request={}) const
 
 
template<typename PutLexiconRequestT = Model::PutLexiconRequest>
Model::PutLexiconOutcomeCallable PutLexiconCallable (const PutLexiconRequestT &request) const
 
template<typename PutLexiconRequestT = Model::PutLexiconRequest>
void PutLexiconAsync (const PutLexiconRequestT &request, const PutLexiconResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
 
template<typename StartSpeechSynthesisTaskRequestT = Model::StartSpeechSynthesisTaskRequest>
Model::StartSpeechSynthesisTaskOutcomeCallable StartSpeechSynthesisTaskCallable (const StartSpeechSynthesisTaskRequestT &request) const
 
template<typename StartSpeechSynthesisTaskRequestT = Model::StartSpeechSynthesisTaskRequest>
void StartSpeechSynthesisTaskAsync (const StartSpeechSynthesisTaskRequestT &request, const StartSpeechSynthesisTaskResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
 
template<typename SynthesizeSpeechRequestT = Model::SynthesizeSpeechRequest>
Model::SynthesizeSpeechOutcomeCallable SynthesizeSpeechCallable (const SynthesizeSpeechRequestT &request) const
 
template<typename SynthesizeSpeechRequestT = Model::SynthesizeSpeechRequest>
void SynthesizeSpeechAsync (const SynthesizeSpeechRequestT &request, const SynthesizeSpeechResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
void OverrideEndpoint (const Aws::String &endpoint)
 
 

Public Member Functions inherited from Aws::Client::AWSJsonClient

 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSJsonClient ()=default
 

Public Member Functions inherited from Aws::Client::AWSClient

 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSClient ()
 
Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})
 
Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})
 
Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const
 
Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})
 
Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const
 
Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})
 
Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const
 
Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})
 
Aws::String GeneratePresignedUrl (const Aws::Endpoint::AWSEndpoint &endpoint, Aws::Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const Aws::Http::HeaderValueCollection &customizedHeaders={}, uint64_t expirationInSeconds=0, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const
 
const std::shared_ptr< Aws::Http::HttpClient > & GetHttpClient () const
 
 
 
virtual const char * GetServiceClientName () const
 
virtual void SetServiceClientName (const Aws::String &name)
 
void AppendToUserAgent (const Aws::String &valueToAppend)
 

Public Member Functions inherited from Aws::Client::ClientWithAsyncTemplateMethods< PollyClient >

 
 
 
 
void SubmitAsync (OperationFuncT operationFunc, const RequestT &request, const HandlerT &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
void SubmitAsync (OperationFuncT operationFunc, RequestT &request, const HandlerT &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
void SubmitAsync (OperationFuncT operationFunc, const HandlerT &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
auto SubmitCallable (OperationFuncT operationFunc, const RequestT &request) const -> std::future< decltype((static_cast< const AwsServiceClientT * >(nullptr) -> *operationFunc)(request))>
 
auto SubmitCallable (OperationFuncT operationFunc, RequestT &request) const -> std::future< decltype((static_cast< const AwsServiceClientT * >(nullptr) -> *operationFunc)(request))>
 
auto SubmitCallable (OperationFuncT operationFunc) const -> std::future< decltype((static_cast< const AwsServiceClientT * >(nullptr) -> *operationFunc)())>
 

Static Public Member Functions

static const char * GetServiceName ()
 
static const char * GetAllocationTag ()
 

Static Public Member Functions inherited from Aws::Client::ClientWithAsyncTemplateMethods< PollyClient >

static void ShutdownSdkClient (void *pThis, int64_t timeoutMs=-1)
 

Friends

 

Additional Inherited Members

Protected Member Functions inherited from Aws::Client::AWSJsonClient

virtual AWSError< CoreErrorsBuildAWSError (const std::shared_ptr< Aws::Http::HttpResponse > &response) const override
 
JsonOutcome MakeRequest (const Aws::AmazonWebServiceRequest &request, const Aws::Endpoint::AWSEndpoint &endpoint, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
JsonOutcome MakeRequest (const Aws::Endpoint::AWSEndpoint &endpoint, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
JsonOutcome MakeRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
JsonOutcome MakeRequest (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
JsonOutcome MakeEventStreamRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const
 

Protected Member Functions inherited from Aws::Client::AWSClient

HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod httpMethod, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, Http::HttpMethod httpMethod, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const Aws::AmazonWebServiceRequest &request, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::AmazonWebServiceRequest &request, const Aws::Endpoint::AWSEndpoint &endpoint, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
virtual void BuildHttpRequest (const Aws::AmazonWebServiceRequest &request, const std::shared_ptr< Aws::Http::HttpRequest > &httpRequest) const
 
const std::shared_ptr< AWSErrorMarshaller > & GetErrorMarshaller () const
 
Aws::Client::AWSAuthSignerGetSignerByName (const char *name) const
 
 
std::shared_ptr< Aws::Http::HttpRequestBuildAndSignHttpRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method, const char *signerName) const
 
std::shared_ptr< Aws::Http::HttpResponseMakeHttpRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const
 

Static Protected Member Functions inherited from Aws::Client::AWSClient

static void AppendRecursionDetectionHeader (std::shared_ptr< Aws::Http::HttpRequest > ioRequest)
 
 
static bool DoesResponseGenerateError (const std::shared_ptr< Aws::Http::HttpResponse > &response)
 

Protected Attributes inherited from Aws::Client::AWSClient

 
 
 
std::atomic< bool > m_isInitialized
 
std::atomic< size_t > m_operationsProcessed
 
std::condition_variable m_shutdownSignal
 
std::mutex m_shutdownMutex
 

Detailed Description

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.

Definition at line 25 of file PollyClient.h.

Member Typedef Documentation

◆ BASECLASS

Definition at line 28 of file PollyClient.h.

◆ ClientConfigurationType

Definition at line 32 of file PollyClient.h.

◆ EndpointProviderType

Definition at line 33 of file PollyClient.h.

Constructor & Destructor Documentation

◆ PollyClient() [1/6]

Aws::Polly::PollyClient::PollyClient ( const Aws::Polly::PollyClientConfiguration clientConfiguration = Aws::Polly::PollyClientConfiguration(),
std::shared_ptr< PollyEndpointProviderBase endpointProvider = nullptr 
)

Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

◆ PollyClient() [2/6]

Aws::Polly::PollyClient::PollyClient ( const Aws::Auth::AWSCredentials credentials,
std::shared_ptr< PollyEndpointProviderBase endpointProvider = nullptr,
const Aws::Polly::PollyClientConfiguration clientConfiguration = Aws::Polly::PollyClientConfiguration() 
)

Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

◆ PollyClient() [3/6]

Aws::Polly::PollyClient::PollyClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,
std::shared_ptr< PollyEndpointProviderBase endpointProvider = nullptr,
const Aws::Polly::PollyClientConfiguration clientConfiguration = Aws::Polly::PollyClientConfiguration() 
)

Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used

◆ PollyClient() [4/6]

Aws::Polly::PollyClient::PollyClient ( const Aws::Client::ClientConfiguration clientConfiguration)

Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

◆ PollyClient() [5/6]

Aws::Polly::PollyClient::PollyClient ( const Aws::Auth::AWSCredentials credentials,
const Aws::Client::ClientConfiguration clientConfiguration 
)

Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

◆ PollyClient() [6/6]

Aws::Polly::PollyClient::PollyClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,
const Aws::Client::ClientConfiguration clientConfiguration 
)

Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used

◆ ~PollyClient()

virtual Aws::Polly::PollyClient::~PollyClient ( )
virtual

Member Function Documentation

◆ accessEndpointProvider()

std::shared_ptr< PollyEndpointProviderBase > & Aws::Polly::PollyClient::accessEndpointProvider ( )

◆ DeleteLexicon()

virtual Model::DeleteLexiconOutcome Aws::Polly::PollyClient::DeleteLexicon ( const Model::DeleteLexiconRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ DeleteLexiconAsync()

template<typename DeleteLexiconRequestT = Model::DeleteLexiconRequest>
void Aws::Polly::PollyClient::DeleteLexiconAsync ( const DeleteLexiconRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for DeleteLexicon that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 108 of file PollyClient.h.

◆ DeleteLexiconCallable()

template<typename DeleteLexiconRequestT = Model::DeleteLexiconRequest>
Model::DeleteLexiconOutcomeCallable Aws::Polly::PollyClient::DeleteLexiconCallable ( const DeleteLexiconRequestT &  request) const
inline

A Callable wrapper for DeleteLexicon that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 99 of file PollyClient.h.

◆ DescribeVoices()

virtual Model::DescribeVoicesOutcome Aws::Polly::PollyClient::DescribeVoices ( const Model::DescribeVoicesRequest request = {}) const
virtual

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.

See Also:

AWS API Reference

◆ DescribeVoicesAsync()

template<typename DescribeVoicesRequestT = Model::DescribeVoicesRequest>
void Aws::Polly::PollyClient::DescribeVoicesAsync ( const DescribeVoicesResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr,
const DescribeVoicesRequestT &  request = {} 
) const
inline

An Async wrapper for DescribeVoices that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 145 of file PollyClient.h.

◆ DescribeVoicesCallable()

template<typename DescribeVoicesRequestT = Model::DescribeVoicesRequest>
Model::DescribeVoicesOutcomeCallable Aws::Polly::PollyClient::DescribeVoicesCallable ( const DescribeVoicesRequestT &  request = {}) const
inline

A Callable wrapper for DescribeVoices that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 136 of file PollyClient.h.

◆ GetAllocationTag()

static const char * Aws::Polly::PollyClient::GetAllocationTag ( )
static

◆ GetLexicon()

virtual Model::GetLexiconOutcome Aws::Polly::PollyClient::GetLexicon ( const Model::GetLexiconRequest request) const
virtual

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

See Also:

AWS API Reference

◆ GetLexiconAsync()

template<typename GetLexiconRequestT = Model::GetLexiconRequest>
void Aws::Polly::PollyClient::GetLexiconAsync ( const GetLexiconRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for GetLexicon that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 173 of file PollyClient.h.

◆ GetLexiconCallable()

template<typename GetLexiconRequestT = Model::GetLexiconRequest>
Model::GetLexiconOutcomeCallable Aws::Polly::PollyClient::GetLexiconCallable ( const GetLexiconRequestT &  request) const
inline

A Callable wrapper for GetLexicon that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 164 of file PollyClient.h.

◆ GetServiceName()

static const char * Aws::Polly::PollyClient::GetServiceName ( )
static

◆ GetSpeechSynthesisTask()

virtual Model::GetSpeechSynthesisTaskOutcome Aws::Polly::PollyClient::GetSpeechSynthesisTask ( const Model::GetSpeechSynthesisTaskRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ GetSpeechSynthesisTaskAsync()

template<typename GetSpeechSynthesisTaskRequestT = Model::GetSpeechSynthesisTaskRequest>
void Aws::Polly::PollyClient::GetSpeechSynthesisTaskAsync ( const GetSpeechSynthesisTaskRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for GetSpeechSynthesisTask that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 201 of file PollyClient.h.

◆ GetSpeechSynthesisTaskCallable()

template<typename GetSpeechSynthesisTaskRequestT = Model::GetSpeechSynthesisTaskRequest>
Model::GetSpeechSynthesisTaskOutcomeCallable Aws::Polly::PollyClient::GetSpeechSynthesisTaskCallable ( const GetSpeechSynthesisTaskRequestT &  request) const
inline

A Callable wrapper for GetSpeechSynthesisTask that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 192 of file PollyClient.h.

◆ ListLexicons()

virtual Model::ListLexiconsOutcome Aws::Polly::PollyClient::ListLexicons ( const Model::ListLexiconsRequest request = {}) const
virtual

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

See Also:

AWS API Reference

◆ ListLexiconsAsync()

template<typename ListLexiconsRequestT = Model::ListLexiconsRequest>
void Aws::Polly::PollyClient::ListLexiconsAsync ( const ListLexiconsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr,
const ListLexiconsRequestT &  request = {} 
) const
inline

An Async wrapper for ListLexicons that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 229 of file PollyClient.h.

◆ ListLexiconsCallable()

template<typename ListLexiconsRequestT = Model::ListLexiconsRequest>
Model::ListLexiconsOutcomeCallable Aws::Polly::PollyClient::ListLexiconsCallable ( const ListLexiconsRequestT &  request = {}) const
inline

A Callable wrapper for ListLexicons that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 220 of file PollyClient.h.

◆ ListSpeechSynthesisTasks()

virtual Model::ListSpeechSynthesisTasksOutcome Aws::Polly::PollyClient::ListSpeechSynthesisTasks ( const Model::ListSpeechSynthesisTasksRequest request = {}) const
virtual

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.

See Also:

AWS API Reference

◆ ListSpeechSynthesisTasksAsync()

template<typename ListSpeechSynthesisTasksRequestT = Model::ListSpeechSynthesisTasksRequest>
void Aws::Polly::PollyClient::ListSpeechSynthesisTasksAsync ( const ListSpeechSynthesisTasksResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr,
const ListSpeechSynthesisTasksRequestT &  request = {} 
) const
inline

An Async wrapper for ListSpeechSynthesisTasks that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 256 of file PollyClient.h.

◆ ListSpeechSynthesisTasksCallable()

template<typename ListSpeechSynthesisTasksRequestT = Model::ListSpeechSynthesisTasksRequest>
Model::ListSpeechSynthesisTasksOutcomeCallable Aws::Polly::PollyClient::ListSpeechSynthesisTasksCallable ( const ListSpeechSynthesisTasksRequestT &  request = {}) const
inline

A Callable wrapper for ListSpeechSynthesisTasks that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 247 of file PollyClient.h.

◆ OverrideEndpoint()

void Aws::Polly::PollyClient::OverrideEndpoint ( const Aws::String endpoint)

◆ PutLexicon()

virtual Model::PutLexiconOutcome Aws::Polly::PollyClient::PutLexicon ( const Model::PutLexiconRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ PutLexiconAsync()

template<typename PutLexiconRequestT = Model::PutLexiconRequest>
void Aws::Polly::PollyClient::PutLexiconAsync ( const PutLexiconRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for PutLexicon that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 287 of file PollyClient.h.

◆ PutLexiconCallable()

template<typename PutLexiconRequestT = Model::PutLexiconRequest>
Model::PutLexiconOutcomeCallable Aws::Polly::PollyClient::PutLexiconCallable ( const PutLexiconRequestT &  request) const
inline

A Callable wrapper for PutLexicon that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 278 of file PollyClient.h.

◆ StartSpeechSynthesisTask()

virtual Model::StartSpeechSynthesisTaskOutcome Aws::Polly::PollyClient::StartSpeechSynthesisTask ( const Model::StartSpeechSynthesisTaskRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ StartSpeechSynthesisTaskAsync()

template<typename StartSpeechSynthesisTaskRequestT = Model::StartSpeechSynthesisTaskRequest>
void Aws::Polly::PollyClient::StartSpeechSynthesisTaskAsync ( const StartSpeechSynthesisTaskRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for StartSpeechSynthesisTask that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 321 of file PollyClient.h.

◆ StartSpeechSynthesisTaskCallable()

template<typename StartSpeechSynthesisTaskRequestT = Model::StartSpeechSynthesisTaskRequest>
Model::StartSpeechSynthesisTaskOutcomeCallable Aws::Polly::PollyClient::StartSpeechSynthesisTaskCallable ( const StartSpeechSynthesisTaskRequestT &  request) const
inline

A Callable wrapper for StartSpeechSynthesisTask that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 312 of file PollyClient.h.

◆ SynthesizeSpeech()

virtual Model::SynthesizeSpeechOutcome Aws::Polly::PollyClient::SynthesizeSpeech ( const Model::SynthesizeSpeechRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ SynthesizeSpeechAsync()

template<typename SynthesizeSpeechRequestT = Model::SynthesizeSpeechRequest>
void Aws::Polly::PollyClient::SynthesizeSpeechAsync ( const SynthesizeSpeechRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for SynthesizeSpeech that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 351 of file PollyClient.h.

◆ SynthesizeSpeechCallable()

template<typename SynthesizeSpeechRequestT = Model::SynthesizeSpeechRequest>
Model::SynthesizeSpeechOutcomeCallable Aws::Polly::PollyClient::SynthesizeSpeechCallable ( const SynthesizeSpeechRequestT &  request) const
inline

A Callable wrapper for SynthesizeSpeech that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 342 of file PollyClient.h.

Friends And Related Symbol Documentation

◆ Aws::Client::ClientWithAsyncTemplateMethods< PollyClient >

Definition at line 358 of file PollyClient.h.


The documentation for this class was generated from the following file: