com.amazonaws.services.polly.model

Class DescribeVoicesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.polly.model.DescribeVoicesRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class DescribeVoicesRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

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:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeVoicesRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getEngine() Specifies the engine (standard or neural) used by Amazon Polly when processing input text for speech synthesis.
java.lang.Boolean	getIncludeAdditionalLanguageCodes() Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language.
java.lang.String	getLanguageCode() The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned.
java.lang.String	getNextToken() An opaque pagination token returned from the previous DescribeVoices operation.
int	hashCode()
java.lang.Boolean	isIncludeAdditionalLanguageCodes() Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language.
void	setEngine(Engine engine) Specifies the engine (standard or neural) used by Amazon Polly when processing input text for speech synthesis.
void	setEngine(java.lang.String engine) Specifies the engine (standard or neural) used by Amazon Polly when processing input text for speech synthesis.
void	setIncludeAdditionalLanguageCodes(java.lang.Boolean includeAdditionalLanguageCodes) Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language.
void	setLanguageCode(LanguageCode languageCode) The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned.
void	setLanguageCode(java.lang.String languageCode) The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned.
void	setNextToken(java.lang.String nextToken) An opaque pagination token returned from the previous DescribeVoices operation.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeVoicesRequest	withEngine(Engine engine) Specifies the engine (standard or neural) used by Amazon Polly when processing input text for speech synthesis.
DescribeVoicesRequest	withEngine(java.lang.String engine) Specifies the engine (standard or neural) used by Amazon Polly when processing input text for speech synthesis.
DescribeVoicesRequest	withIncludeAdditionalLanguageCodes(java.lang.Boolean includeAdditionalLanguageCodes) Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language.
DescribeVoicesRequest	withLanguageCode(LanguageCode languageCode) The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned.
DescribeVoicesRequest	withLanguageCode(java.lang.String languageCode) The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned.
DescribeVoicesRequest	withNextToken(java.lang.String nextToken) An opaque pagination token returned from the previous DescribeVoices operation.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeVoicesRequest

public DescribeVoicesRequest()

Method Detail

getEngine

public java.lang.String getEngine()

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

Constraints:
Allowed Values: standard, neural

Returns:

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

See Also:

Engine

setEngine

public void setEngine(java.lang.String engine)

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

Constraints:
Allowed Values: standard, neural

Parameters:

engine -

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

See Also:

Engine

withEngine

public DescribeVoicesRequest withEngine(java.lang.String engine)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: standard, neural

Parameters:

engine -

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

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

Engine

setEngine

public void setEngine(Engine engine)

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

Constraints:
Allowed Values: standard, neural

Parameters:

engine -

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

See Also:

Engine

withEngine

public DescribeVoicesRequest withEngine(Engine engine)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: standard, neural

Parameters:

engine -

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

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

Engine

getLanguageCode

public java.lang.String getLanguageCode()

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: arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, 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

Returns:

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.

See Also:

LanguageCode

setLanguageCode

public void setLanguageCode(java.lang.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: arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, 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

Parameters:

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.

See Also:

LanguageCode

withLanguageCode

public DescribeVoicesRequest withLanguageCode(java.lang.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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, 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

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

LanguageCode

setLanguageCode

public void setLanguageCode(LanguageCode 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: arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, 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

Parameters:

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.

See Also:

LanguageCode

withLanguageCode

public DescribeVoicesRequest withLanguageCode(LanguageCode 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, 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

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

LanguageCode

isIncludeAdditionalLanguageCodes

public java.lang.Boolean isIncludeAdditionalLanguageCodes()

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.

Returns:

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.

getIncludeAdditionalLanguageCodes

public java.lang.Boolean getIncludeAdditionalLanguageCodes()

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.

Returns:

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.

setIncludeAdditionalLanguageCodes

public void setIncludeAdditionalLanguageCodes(java.lang.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.

Parameters:

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.

withIncludeAdditionalLanguageCodes

public DescribeVoicesRequest withIncludeAdditionalLanguageCodes(java.lang.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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getNextToken

public java.lang.String getNextToken()

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

Constraints:
Length: 0 - 4096

Returns:

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

setNextToken

public void setNextToken(java.lang.String nextToken)

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

Constraints:
Length: 0 - 4096

Parameters:

nextToken -

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

withNextToken

public DescribeVoicesRequest withNextToken(java.lang.String nextToken)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 4096

Parameters:

nextToken -

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

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object