libZSservicesZSamazonka-pollyZSamazonka-polly
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Polly.Lens

Description

 
Synopsis

Operations

GetLexicon

getLexicon_name :: Lens' GetLexicon Text Source #

Name of the lexicon.

getLexiconResponse_lexiconAttributes :: Lens' GetLexiconResponse (Maybe LexiconAttributes) Source #

Metadata of the lexicon, including phonetic alphabetic used, language code, lexicon ARN, number of lexemes defined in the lexicon, and size of lexicon in bytes.

getLexiconResponse_lexicon :: Lens' GetLexiconResponse (Maybe Lexicon) Source #

Lexicon object that provides name and the string content of the lexicon.

GetSpeechSynthesisTask

getSpeechSynthesisTask_taskId :: Lens' GetSpeechSynthesisTask Text Source #

The Amazon Polly generated identifier for a speech synthesis task.

getSpeechSynthesisTaskResponse_synthesisTask :: Lens' GetSpeechSynthesisTaskResponse (Maybe SynthesisTask) Source #

SynthesisTask object that provides information from the requested task, including output format, creation time, task status, and so on.

DescribeVoices

describeVoices_languageCode :: Lens' DescribeVoices (Maybe LanguageCode) Source #

The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don't specify this optional parameter, all available voices are returned.

describeVoices_engine :: Lens' DescribeVoices (Maybe Engine) Source #

Specifies the engine (standard or neural) used by Amazon Polly when processing input text for speech synthesis.

describeVoices_nextToken :: Lens' DescribeVoices (Maybe Text) Source #

An opaque pagination token returned from the previous DescribeVoices operation. If present, this indicates where to continue the listing.

describeVoices_includeAdditionalLanguageCodes :: Lens' DescribeVoices (Maybe Bool) Source #

Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language. For instance, if you request all languages that use US English (es-US), and there is an Italian voice that speaks both Italian (it-IT) and US English, that voice will be included if you specify yes but not if you specify no.

describeVoicesResponse_nextToken :: Lens' DescribeVoicesResponse (Maybe Text) Source #

The pagination token to use in the next request to continue the listing of voices. NextToken is returned only if the response is truncated.

describeVoicesResponse_voices :: Lens' DescribeVoicesResponse (Maybe [Voice]) Source #

A list of voices with their properties.

ListLexicons

listLexicons_nextToken :: Lens' ListLexicons (Maybe Text) Source #

An opaque pagination token returned from previous ListLexicons operation. If present, indicates where to continue the list of lexicons.

listLexiconsResponse_nextToken :: Lens' ListLexiconsResponse (Maybe Text) Source #

The pagination token to use in the next request to continue the listing of lexicons. NextToken is returned only if the response is truncated.

SynthesizeSpeech

synthesizeSpeech_languageCode :: Lens' SynthesizeSpeech (Maybe LanguageCode) Source #

Optional language code for the Synthesize Speech request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

synthesizeSpeech_engine :: Lens' SynthesizeSpeech (Maybe Engine) Source #

Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. For information on Amazon Polly voices and which voices are available in standard-only, NTTS-only, and both standard and NTTS formats, see Available Voices.

NTTS-only voices

When using NTTS-only voices such as Kevin (en-US), this parameter is required and must be set to neural. If the engine is not specified, or is set to standard, this will result in an error.

Type: String

Valid Values: standard | neural

Required: Yes

Standard voices

For standard voices, this is not required; the engine parameter defaults to standard. If the engine is not specified, or is set to standard and an NTTS-only voice is selected, this will result in an error.

synthesizeSpeech_speechMarkTypes :: Lens' SynthesizeSpeech (Maybe [SpeechMarkType]) Source #

The type of speech marks returned for the input text.

synthesizeSpeech_sampleRate :: Lens' SynthesizeSpeech (Maybe Text) Source #

The audio frequency specified in Hz.

The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000".

Valid values for pcm are "8000" and "16000" The default value is "16000".

synthesizeSpeech_textType :: Lens' SynthesizeSpeech (Maybe TextType) Source #

Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using SSML.

synthesizeSpeech_lexiconNames :: Lens' SynthesizeSpeech (Maybe [Text]) Source #

List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice. For information about storing lexicons, see PutLexicon.

synthesizeSpeech_outputFormat :: Lens' SynthesizeSpeech OutputFormat Source #

The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.

synthesizeSpeech_text :: Lens' SynthesizeSpeech Text Source #

Input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

synthesizeSpeech_voiceId :: Lens' SynthesizeSpeech VoiceId Source #

Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.

synthesizeSpeechResponse_contentType :: Lens' SynthesizeSpeechResponse (Maybe Text) Source #

Specifies the type audio stream. This should reflect the OutputFormat parameter in your request.

  • If you request mp3 as the OutputFormat, the ContentType returned is audio/mpeg.
  • If you request ogg_vorbis as the OutputFormat, the ContentType returned is audio/ogg.
  • If you request pcm as the OutputFormat, the ContentType returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.
  • If you request json as the OutputFormat, the ContentType returned is audio/json.

ListSpeechSynthesisTasks

listSpeechSynthesisTasks_status :: Lens' ListSpeechSynthesisTasks (Maybe TaskStatus) Source #

Status of the speech synthesis tasks returned in a List operation

listSpeechSynthesisTasks_nextToken :: Lens' ListSpeechSynthesisTasks (Maybe Text) Source #

The pagination token to use in the next request to continue the listing of speech synthesis tasks.

listSpeechSynthesisTasks_maxResults :: Lens' ListSpeechSynthesisTasks (Maybe Natural) Source #

Maximum number of speech synthesis tasks returned in a List operation.

listSpeechSynthesisTasksResponse_nextToken :: Lens' ListSpeechSynthesisTasksResponse (Maybe Text) Source #

An opaque pagination token returned from the previous List operation in this request. If present, this indicates where to continue the listing.

listSpeechSynthesisTasksResponse_synthesisTasks :: Lens' ListSpeechSynthesisTasksResponse (Maybe [SynthesisTask]) Source #

List of SynthesisTask objects that provides information from the specified task in the list request, including output format, creation time, task status, and so on.

PutLexicon

putLexicon_name :: Lens' PutLexicon Text Source #

Name of the lexicon. The name must follow the regular express format [0-9A-Za-z]{1,20}. That is, the name is a case-sensitive alphanumeric string up to 20 characters long.

putLexicon_content :: Lens' PutLexicon Text Source #

Content of the PLS lexicon as string data.

DeleteLexicon

deleteLexicon_name :: Lens' DeleteLexicon Text Source #

The name of the lexicon to delete. Must be an existing lexicon in the region.

StartSpeechSynthesisTask

startSpeechSynthesisTask_languageCode :: Lens' StartSpeechSynthesisTask (Maybe LanguageCode) Source #

Optional language code for the Speech Synthesis request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

startSpeechSynthesisTask_snsTopicArn :: Lens' StartSpeechSynthesisTask (Maybe Text) Source #

ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

startSpeechSynthesisTask_outputS3KeyPrefix :: Lens' StartSpeechSynthesisTask (Maybe Text) Source #

The Amazon S3 key prefix for the output speech file.

startSpeechSynthesisTask_engine :: Lens' StartSpeechSynthesisTask (Maybe Engine) Source #

Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.

startSpeechSynthesisTask_speechMarkTypes :: Lens' StartSpeechSynthesisTask (Maybe [SpeechMarkType]) Source #

The type of speech marks returned for the input text.

startSpeechSynthesisTask_sampleRate :: Lens' StartSpeechSynthesisTask (Maybe Text) Source #

The audio frequency specified in Hz.

The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000".

Valid values for pcm are "8000" and "16000" The default value is "16000".

startSpeechSynthesisTask_textType :: Lens' StartSpeechSynthesisTask (Maybe TextType) Source #

Specifies whether the input text is plain text or SSML. The default value is plain text.

startSpeechSynthesisTask_lexiconNames :: Lens' StartSpeechSynthesisTask (Maybe [Text]) Source #

List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice.

startSpeechSynthesisTask_outputFormat :: Lens' StartSpeechSynthesisTask OutputFormat Source #

The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

startSpeechSynthesisTask_outputS3BucketName :: Lens' StartSpeechSynthesisTask Text Source #

Amazon S3 bucket name to which the output file will be saved.

startSpeechSynthesisTask_text :: Lens' StartSpeechSynthesisTask Text Source #

The input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

startSpeechSynthesisTaskResponse_synthesisTask :: Lens' StartSpeechSynthesisTaskResponse (Maybe SynthesisTask) Source #

SynthesisTask object that provides information and attributes about a newly submitted speech synthesis task.

Types

Lexicon

lexicon_content :: Lens' Lexicon (Maybe Text) Source #

Lexicon content in string format. The content of a lexicon must be in PLS format.

lexicon_name :: Lens' Lexicon (Maybe Text) Source #

Name of the lexicon.

LexiconAttributes

lexiconAttributes_languageCode :: Lens' LexiconAttributes (Maybe LanguageCode) Source #

Language code that the lexicon applies to. A lexicon with a language code such as "en" would be applied to all English languages (en-GB, en-US, en-AUS, en-WLS, and so on.

lexiconAttributes_size :: Lens' LexiconAttributes (Maybe Int) Source #

Total size of the lexicon, in characters.

lexiconAttributes_lexiconArn :: Lens' LexiconAttributes (Maybe Text) Source #

Amazon Resource Name (ARN) of the lexicon.

lexiconAttributes_alphabet :: Lens' LexiconAttributes (Maybe Text) Source #

Phonetic alphabet used in the lexicon. Valid values are ipa and x-sampa.

lexiconAttributes_lastModified :: Lens' LexiconAttributes (Maybe UTCTime) Source #

Date lexicon was last modified (a timestamp value).

LexiconDescription

SynthesisTask

synthesisTask_creationTime :: Lens' SynthesisTask (Maybe UTCTime) Source #

Timestamp for the time the synthesis task was started.

synthesisTask_languageCode :: Lens' SynthesisTask (Maybe LanguageCode) Source #

Optional language code for a synthesis task. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

synthesisTask_snsTopicArn :: Lens' SynthesisTask (Maybe Text) Source #

ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

synthesisTask_taskStatusReason :: Lens' SynthesisTask (Maybe Text) Source #

Reason for the current status of a specific speech synthesis task, including errors if the task has failed.

synthesisTask_taskId :: Lens' SynthesisTask (Maybe Text) Source #

The Amazon Polly generated identifier for a speech synthesis task.

synthesisTask_requestCharacters :: Lens' SynthesisTask (Maybe Int) Source #

Number of billable characters synthesized.

synthesisTask_engine :: Lens' SynthesisTask (Maybe Engine) Source #

Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.

synthesisTask_speechMarkTypes :: Lens' SynthesisTask (Maybe [SpeechMarkType]) Source #

The type of speech marks returned for the input text.

synthesisTask_sampleRate :: Lens' SynthesisTask (Maybe Text) Source #

The audio frequency specified in Hz.

The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000".

Valid values for pcm are "8000" and "16000" The default value is "16000".

synthesisTask_outputFormat :: Lens' SynthesisTask (Maybe OutputFormat) Source #

The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

synthesisTask_textType :: Lens' SynthesisTask (Maybe TextType) Source #

Specifies whether the input text is plain text or SSML. The default value is plain text.

synthesisTask_voiceId :: Lens' SynthesisTask (Maybe VoiceId) Source #

Voice ID to use for the synthesis.

synthesisTask_lexiconNames :: Lens' SynthesisTask (Maybe [Text]) Source #

List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice.

synthesisTask_taskStatus :: Lens' SynthesisTask (Maybe TaskStatus) Source #

Current status of the individual speech synthesis task.

synthesisTask_outputUri :: Lens' SynthesisTask (Maybe Text) Source #

Pathway for the output speech file.

Voice

voice_languageCode :: Lens' Voice (Maybe LanguageCode) Source #

Language code of the voice.

voice_languageName :: Lens' Voice (Maybe Text) Source #

Human readable name of the language in English.

voice_gender :: Lens' Voice (Maybe Gender) Source #

Gender of the voice.

voice_name :: Lens' Voice (Maybe Text) Source #

Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.

voice_id :: Lens' Voice (Maybe VoiceId) Source #

Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.

voice_additionalLanguageCodes :: Lens' Voice (Maybe [LanguageCode]) Source #

Additional codes for languages available for the specified voice in addition to its default language.

For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.

voice_supportedEngines :: Lens' Voice (Maybe [Engine]) Source #

Specifies which engines (standard or neural) that are supported by a given voice.