polly/aws.sdk.kotlin.services.polly

Package-level declarations

Types

PollyClient

interface PollyClient : SdkClient

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

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

deleteLexicon

inline suspend fun PollyClient.deleteLexicon(crossinline block: DeleteLexiconRequest.Builder.() -> Unit): DeleteLexiconResponse

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.

describeVoices

inline suspend fun PollyClient.describeVoices(crossinline block: DescribeVoicesRequest.Builder.() -> Unit): DescribeVoicesResponse

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.

getLexicon

inline suspend fun PollyClient.getLexicon(crossinline block: GetLexiconRequest.Builder.() -> Unit): GetLexiconResponse

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

getSpeechSynthesisTask

inline suspend fun PollyClient.getSpeechSynthesisTask(crossinline block: GetSpeechSynthesisTaskRequest.Builder.() -> Unit): GetSpeechSynthesisTaskResponse

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.

listLexicons

inline suspend fun PollyClient.listLexicons(crossinline block: ListLexiconsRequest.Builder.() -> Unit): ListLexiconsResponse

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

listSpeechSynthesisTasks

inline suspend fun PollyClient.listSpeechSynthesisTasks(crossinline block: ListSpeechSynthesisTasksRequest.Builder.() -> Unit): ListSpeechSynthesisTasksResponse

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.

putLexicon

inline suspend fun PollyClient.putLexicon(crossinline block: PutLexiconRequest.Builder.() -> Unit): PutLexiconResponse

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.

startSpeechSynthesisTask

inline suspend fun PollyClient.startSpeechSynthesisTask(crossinline block: StartSpeechSynthesisTaskRequest.Builder.() -> Unit): StartSpeechSynthesisTaskResponse

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.

withConfig

fun PollyClient.withConfig(block: PollyClient.Config.Builder.() -> Unit): PollyClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.