openapi: 3.0.0 info: version: 2016-06-10 x-release: v4 title: Amazon Polly Lexicons Voices API 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.
x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: polly x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/polly-2016-06-10.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://polly.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon Polly multi-region endpoint - url: https://polly.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon Polly multi-region endpoint - url: http://polly.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon Polly endpoint for China (Beijing) and China (Ningxia) - url: https://polly.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon Polly endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Voices paths: /v1/voices: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: DescribeVoices description: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.
standard or neural) used by Amazon Polly when processing input text for speech synthesis. '
schema:
type: string
enum:
- standard
- neural
- name: LanguageCode
in: query
required: false
description: ' 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. '
schema:
type: string
enum:
- 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
- en-NZ
- en-ZA
- ca-ES
- de-AT
- yue-CN
- ar-AE
- fi-FI
- name: IncludeAdditionalLanguageCodes
in: query
required: false
description: 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.
schema:
type: boolean
- name: NextToken
in: query
required: false
description: An opaque pagination token returned from the previous DescribeVoices operation. If present, this indicates where to continue the listing.
schema:
type: string
minLength: 0
maxLength: 4096
summary: Amazon Polly Describe Voices
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Voices
components:
schemas:
VoiceId:
type: string
enum:
- Aditi
- Amy
- Astrid
- Bianca
- Brian
- Camila
- Carla
- Carmen
- Celine
- Chantal
- Conchita
- Cristiano
- Dora
- Emma
- Enrique
- Ewa
- Filiz
- Gabrielle
- Geraint
- Giorgio
- Gwyneth
- Hans
- Ines
- Ivy
- Jacek
- Jan
- Joanna
- Joey
- Justin
- Karl
- Kendra
- Kevin
- Kimberly
- Lea
- Liv
- Lotte
- Lucia
- Lupe
- Mads
- Maja
- Marlene
- Mathieu
- Matthew
- Maxim
- Mia
- Miguel
- Mizuki
- Naja
- Nicole
- Olivia
- Penelope
- Raveena
- Ricardo
- Ruben
- Russell
- Salli
- Seoyeon
- Takumi
- Tatyana
- Vicki
- Vitoria
- Zeina
- Zhiyu
- Aria
- Ayanda
- Arlet
- Hannah
- Arthur
- Daniel
- Liam
- Pedro
- Kajal
- Hiujin
- Laura
- Elin
- Ida
- Suvi
- Ola
- Hala
- Andres
- Sergio
- Remi
- Adriano
- Thiago
- Ruth
- Stephen
- Kazuha
- Tomoko
VoiceList:
type: array
items:
$ref: '#/components/schemas/Voice'
Voice:
type: object
properties:
Gender:
allOf:
- $ref: '#/components/schemas/Gender'
- description: Gender of the voice.
Id:
allOf:
- $ref: '#/components/schemas/VoiceId'
- description: Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.
LanguageCode:
allOf:
- $ref: '#/components/schemas/LanguageCode'
- description: Language code of the voice.
LanguageName:
allOf:
- $ref: '#/components/schemas/LanguageName'
- description: Human readable name of the language in English.
Name:
allOf:
- $ref: '#/components/schemas/VoiceName'
- description: Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.
AdditionalLanguageCodes:
allOf:
- $ref: '#/components/schemas/LanguageCodeList'
- description: 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.
standard or neural) that are supported by a given voice.
description: Description of the voice.
LanguageCode:
type: string
enum:
- 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
- en-NZ
- en-ZA
- ca-ES
- de-AT
- yue-CN
- ar-AE
- fi-FI
DescribeVoicesOutput:
type: object
example:
Voices:
- Gender: Female
Id: Emma
LanguageCode: en-GB
LanguageName: British English
Name: Emma
- Gender: Male
Id: Brian
LanguageCode: en-GB
LanguageName: British English
Name: Brian
- Gender: Female
Id: Amy
LanguageCode: en-GB
LanguageName: British English
Name: Amy
properties:
Voices:
allOf:
- $ref: '#/components/schemas/VoiceList'
- description: A list of voices with their properties.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The pagination token to use in the next request to continue the listing of voices. NextToken is returned only if the response is truncated.
Gender:
type: string
enum:
- Female
- Male
NextToken:
type: string
minLength: 0
maxLength: 4096
LanguageName:
type: string
ServiceFailureException: {}
LanguageCodeList:
type: array
items:
$ref: '#/components/schemas/LanguageCode'
InvalidNextTokenException: {}
Engine:
type: string
enum:
- standard
- neural
VoiceName:
type: string
EngineList:
type: array
items:
$ref: '#/components/schemas/Engine'
parameters:
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/polly/