Serialized Form

Package com.amazonaws.services.polly.model

Class com.amazonaws.services.polly.model.DeleteLexiconRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

String name

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

Constraints:
Pattern: [0-9A-Za-z]{1,20}

Class com.amazonaws.services.polly.model.DeleteLexiconResult extends Object implements Serializable

Class com.amazonaws.services.polly.model.DescribeVoicesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

languageCode

String languageCode

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.

Constraints:
Allowed Values: cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR

includeAdditionalLanguageCodes

Boolean includeAdditionalLanguageCodes

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.

nextToken

String nextToken

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

Class com.amazonaws.services.polly.model.DescribeVoicesResult extends Object implements Serializable

Serialized Fields

voices

List<E> voices

A list of voices with their properties.

nextToken

String nextToken

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

Class com.amazonaws.services.polly.model.GetLexiconRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

String name

Name of the lexicon.

Constraints:
Pattern: [0-9A-Za-z]{1,20}

Class com.amazonaws.services.polly.model.GetLexiconResult extends Object implements Serializable

Serialized Fields

lexicon

Lexicon lexicon

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

lexiconAttributes

LexiconAttributes lexiconAttributes

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.

Class com.amazonaws.services.polly.model.GetSpeechSynthesisTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

taskId

String taskId

The Amazon Polly generated identifier for a speech synthesis task.

Constraints:
Length: 1 - 128

Class com.amazonaws.services.polly.model.GetSpeechSynthesisTaskResult extends Object implements Serializable

Serialized Fields

synthesisTask

SynthesisTask synthesisTask

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

Class com.amazonaws.services.polly.model.InvalidLexiconException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.InvalidNextTokenException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.InvalidS3BucketException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.InvalidS3KeyException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.InvalidSampleRateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.InvalidSnsTopicArnException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.InvalidSsmlException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.InvalidTaskIdException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.LanguageNotSupportedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.Lexicon extends Object implements Serializable

Serialized Fields

content

String content

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

name

String name

Name of the lexicon.

Constraints:
Pattern: [0-9A-Za-z]{1,20}

Class com.amazonaws.services.polly.model.LexiconAttributes extends Object implements Serializable

Serialized Fields

alphabet

String alphabet

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

languageCode

String languageCode

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.

Constraints:
Allowed Values: cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR

lastModified

Date lastModified

Date lexicon was last modified (a timestamp value).

lexiconArn

String lexiconArn

Amazon Resource Name (ARN) of the lexicon.

lexemesCount

Integer lexemesCount

Number of lexemes in the lexicon.

size

Integer size

Total size of the lexicon, in characters.

Class com.amazonaws.services.polly.model.LexiconDescription extends Object implements Serializable

Serialized Fields

name

String name

Name of the lexicon.

Constraints:
Pattern: [0-9A-Za-z]{1,20}

attributes

LexiconAttributes attributes

Provides lexicon metadata.

Class com.amazonaws.services.polly.model.LexiconNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.LexiconSizeExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.ListLexiconsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextToken

String nextToken

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

Class com.amazonaws.services.polly.model.ListLexiconsResult extends Object implements Serializable

Serialized Fields

lexicons

List<E> lexicons

A list of lexicon names and attributes.

nextToken

String nextToken

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

Class com.amazonaws.services.polly.model.ListSpeechSynthesisTasksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

Integer maxResults

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

Constraints:
Range: 1 - 100

nextToken

String nextToken

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

status

String status

Status of the speech synthesis tasks returned in a List operation

Constraints:
Allowed Values: scheduled, inProgress, completed, failed

Class com.amazonaws.services.polly.model.ListSpeechSynthesisTasksResult extends Object implements Serializable

Serialized Fields

nextToken

String nextToken

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

synthesisTasks

List<E> synthesisTasks

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.

Class com.amazonaws.services.polly.model.MarksNotSupportedForFormatException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.MaxLexemeLengthExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.MaxLexiconsNumberExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.PutLexiconRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

String name

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.

Constraints:
Pattern: [0-9A-Za-z]{1,20}

content

String content

Content of the PLS lexicon as string data.

Class com.amazonaws.services.polly.model.PutLexiconResult extends Object implements Serializable

Class com.amazonaws.services.polly.model.ServiceFailureException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.SsmlMarksNotSupportedForTextTypeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.StartSpeechSynthesisTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

lexiconNames

List<E> lexiconNames

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.

outputFormat

String outputFormat

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.

Constraints:
Allowed Values: json, mp3, ogg_vorbis, pcm

outputS3BucketName

String outputS3BucketName

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

Constraints:
Pattern: ^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$

outputS3KeyPrefix

String outputS3KeyPrefix

The Amazon S3 key prefix for the output speech file.

Constraints:
Pattern: ^[0-9a-zA-Z\/\!\-_\.\*\'\(\)]{0,800}$

sampleRate

String sampleRate

The audio frequency specified in Hz.

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

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

snsTopicArn

String snsTopicArn

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

Constraints:
Pattern: ^arn:aws(-(cn|iso(-b)?|us-gov))?:sns:.*:\w{12}:.+$

speechMarkTypes

List<E> speechMarkTypes

The type of speech marks returned for the input text.

text

String text

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

textType

String textType

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

Constraints:
Allowed Values: ssml, text

voiceId

String voiceId

Voice ID to use for the synthesis.

Constraints:
Allowed Values: Geraint, Gwyneth, Mads, Naja, Hans, Marlene, Nicole, Russell, Amy, Brian, Emma, Raveena, Ivy, Joanna, Joey, Justin, Kendra, Kimberly, Matthew, Salli, Conchita, Enrique, Miguel, Penelope, Chantal, Celine, Lea, Mathieu, Dora, Karl, Carla, Giorgio, Mizuki, Liv, Lotte, Ruben, Ewa, Jacek, Jan, Maja, Ricardo, Vitoria, Cristiano, Ines, Carmen, Maxim, Tatyana, Astrid, Filiz, Vicki, Takumi, Seoyeon, Aditi, Zhiyu

languageCode

String languageCode

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 will use 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.

Constraints:
Allowed Values: cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR

Class com.amazonaws.services.polly.model.StartSpeechSynthesisTaskResult extends Object implements Serializable

Serialized Fields

synthesisTask

SynthesisTask synthesisTask

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

Class com.amazonaws.services.polly.model.SynthesisTask extends Object implements Serializable

Serialized Fields

taskId

String taskId

The Amazon Polly generated identifier for a speech synthesis task.

Constraints:
Length: 1 - 128

taskStatus

String taskStatus

Current status of the individual speech synthesis task.

Constraints:
Allowed Values: scheduled, inProgress, completed, failed

taskStatusReason

String taskStatusReason

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

outputUri

String outputUri

Pathway for the output speech file.

creationTime

Date creationTime

Timestamp for the time the synthesis task was started.

requestCharacters

Integer requestCharacters

Number of billable characters synthesized.

snsTopicArn

String snsTopicArn

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

Constraints:
Pattern: ^arn:aws(-(cn|iso(-b)?|us-gov))?:sns:.*:\w{12}:.+$

lexiconNames

List<E> lexiconNames

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.

outputFormat

String outputFormat

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.

Constraints:
Allowed Values: json, mp3, ogg_vorbis, pcm

sampleRate

String sampleRate

The audio frequency specified in Hz.

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

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

speechMarkTypes

List<E> speechMarkTypes

The type of speech marks returned for the input text.

textType

String textType

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

Constraints:
Allowed Values: ssml, text

voiceId

String voiceId

Voice ID to use for the synthesis.

Constraints:
Allowed Values: Geraint, Gwyneth, Mads, Naja, Hans, Marlene, Nicole, Russell, Amy, Brian, Emma, Raveena, Ivy, Joanna, Joey, Justin, Kendra, Kimberly, Matthew, Salli, Conchita, Enrique, Miguel, Penelope, Chantal, Celine, Lea, Mathieu, Dora, Karl, Carla, Giorgio, Mizuki, Liv, Lotte, Ruben, Ewa, Jacek, Jan, Maja, Ricardo, Vitoria, Cristiano, Ines, Carmen, Maxim, Tatyana, Astrid, Filiz, Vicki, Takumi, Seoyeon, Aditi, Zhiyu

languageCode

String languageCode

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 will use 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.

Constraints:
Allowed Values: cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR

Class com.amazonaws.services.polly.model.SynthesisTaskNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.SynthesizeSpeechPresignRequest extends Object implements Serializable

Serialized Fields

expiration

Date expiration

An optional expiration date at which point the generated pre-signed URL will no longer be accepted by Amazon Polly. If not specified, a default value will be supplied, calculated as 15 minutes from getting the pre-signed URL.

credentials

AWSCredentials credentials

The optional credentials to use for this request - overrides the default credentials set at the client level.

lexiconNames

List<E> lexiconNames

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.

outputFormat

String outputFormat

The audio format in which the resulting stream will be encoded.

Constraints:
Allowed Values: mp3, ogg_vorbis, pcm

sampleRate

String sampleRate

The audio frequency specified in Hz.

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

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

speechMarkTypes

List<E> speechMarkTypes

The new value for the speechMarkTypes property for this object.

text

String text

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

textType

String textType

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

Constraints:
Allowed Values: ssml, text

voiceId

String voiceId

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

Constraints:
Allowed Values: Geraint, Gwyneth, Mads, Naja, Hans, Marlene, Nicole, Russell, Amy, Brian, Emma, Raveena, Ivy, Joanna, Joey, Justin, Kendra, Kimberly, Matthew, Salli, Conchita, Enrique, Miguel, Penelope, Chantal, Celine, Mathieu, Dora, Karl, Carla, Giorgio, Mizuki, Liv, Lotte, Ruben, Ewa, Jacek, Jan, Maja, Ricardo, Vitoria, Cristiano, Ines, Carmen, Maxim, Tatyana, Astrid, Filiz, Vicki, Takumi, Seoyeon, Aditi, Lea, Zhiyu

languageCode

String languageCode

Class com.amazonaws.services.polly.model.SynthesizeSpeechRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

lexiconNames

List<E> lexiconNames

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.

outputFormat

String outputFormat

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.

Constraints:
Allowed Values: json, mp3, ogg_vorbis, pcm

sampleRate

String sampleRate

The audio frequency specified in Hz.

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

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

speechMarkTypes

List<E> speechMarkTypes

The type of speech marks returned for the input text.

text

String text

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

textType

String textType

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

Constraints:
Allowed Values: ssml, text

voiceId

String voiceId

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

Constraints:
Allowed Values: Geraint, Gwyneth, Mads, Naja, Hans, Marlene, Nicole, Russell, Amy, Brian, Emma, Raveena, Ivy, Joanna, Joey, Justin, Kendra, Kimberly, Matthew, Salli, Conchita, Enrique, Miguel, Penelope, Chantal, Celine, Lea, Mathieu, Dora, Karl, Carla, Giorgio, Mizuki, Liv, Lotte, Ruben, Ewa, Jacek, Jan, Maja, Ricardo, Vitoria, Cristiano, Ines, Carmen, Maxim, Tatyana, Astrid, Filiz, Vicki, Takumi, Seoyeon, Aditi, Zhiyu

languageCode

String languageCode

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 will use 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.

Constraints:
Allowed Values: cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR

Class com.amazonaws.services.polly.model.SynthesizeSpeechResult extends Object implements Serializable

Serialized Fields

audioStream

InputStream audioStream

Stream containing the synthesized speech.

contentType

String contentType

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.

requestCharacters

Integer requestCharacters

Number of characters synthesized.

Class com.amazonaws.services.polly.model.TextLengthExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.UnsupportedPlsAlphabetException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.UnsupportedPlsLanguageException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.Voice extends Object implements Serializable

Serialized Fields

gender

String gender

Gender of the voice.

Constraints:
Allowed Values: Female, Male

id

String id

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

Constraints:
Allowed Values: Geraint, Gwyneth, Mads, Naja, Hans, Marlene, Nicole, Russell, Amy, Brian, Emma, Raveena, Ivy, Joanna, Joey, Justin, Kendra, Kimberly, Matthew, Salli, Conchita, Enrique, Miguel, Penelope, Chantal, Celine, Lea, Mathieu, Dora, Karl, Carla, Giorgio, Mizuki, Liv, Lotte, Ruben, Ewa, Jacek, Jan, Maja, Ricardo, Vitoria, Cristiano, Ines, Carmen, Maxim, Tatyana, Astrid, Filiz, Vicki, Takumi, Seoyeon, Aditi, Zhiyu

languageCode

String languageCode

Language code of the voice.

Constraints:
Allowed Values: cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR

languageName

String languageName

Human readable name of the language in English.

name

String name

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

additionalLanguageCodes

List<E> additionalLanguageCodes

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.