Amazon Polly Voices API

openapi: 3.1.0
info:
  title: Amazon Polly Voices API
  version: '2016-06-10'
  description: Generated from AWS's published Smithy model for Amazon Polly. 1 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://polly.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /v1/voices:
    get:
      operationId: DescribeVoices
      summary: Describe Voices
      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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeVoicesOutput'
              example:
                Voices:
                - Gender: Female
                  Name: Emma
                  LanguageName: British English
                  Id: Emma
                  LanguageCode: en-GB
                - Gender: Male
                  Name: Brian
                  LanguageName: British English
                  Id: Brian
                  LanguageCode: en-GB
                - Gender: Female
                  Name: Amy
                  LanguageName: British English
                  Id: Amy
                  LanguageCode: en-GB
        '400':
          description: InvalidNextTokenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidNextTokenException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceFailureException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeVoicesInput'
            example:
              LanguageCode: en-GB
      tags:
      - Voices
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: polly
  schemas:
    DescribeVoicesInput:
      type: object
      properties:
        Engine:
          type: string
          enum:
          - standard
          - neural
          - long-form
          - generative
          description: Specifies the engine (standard, neural, long-form or generative) used by Amazon Polly when processing
            input text for speech synthesis.
        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
          - en-IE
          - nl-BE
          - fr-BE
          - cs-CZ
          - de-CH
          - en-SG
          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.
        IncludeAdditionalLanguageCodes:
          type: boolean
          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.
        NextToken:
          type: string
          description: An opaque pagination token returned from the previous DescribeVoices operation. If present, this indicates
            where to continue the listing.
    DescribeVoicesOutput:
      type: object
      properties:
        Voices:
          type: array
          items:
            $ref: '#/components/schemas/Voice'
          description: A list of voices with their properties.
        NextToken:
          type: string
          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.
    InvalidNextTokenException:
      type: object
      properties:
        message:
          type: string
    ServiceFailureException:
      type: object
      properties:
        message:
          type: string
    Voice:
      type: object
      properties:
        Gender:
          type: string
          enum:
          - Female
          - Male
          description: Gender of the voice.
        Id:
          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
          - Niamh
          - Sofie
          - Lisa
          - Isabelle
          - Zayd
          - Danielle
          - Gregory
          - Burcu
          - Jitka
          - Sabrina
          - Jasmine
          - Jihye
          - Ambre
          - Beatrice
          - Florian
          - Lennart
          - Lorenzo
          - Tiffany
          - Arjun
          - Carlos
          - Carolina
          - Curtis
          - Hyunduk
          - Kenneth
          - Kiara
          - Leo
          - Nate
          - Tina
          description: Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.
        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
          - en-IE
          - nl-BE
          - fr-BE
          - cs-CZ
          - de-CH
          - en-SG
          description: Language code of the voice.
        LanguageName:
          type: string
          description: Human readable name of the language in English.
        Name:
          type: string
          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:
          type: array
          items:
            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
            - en-IE
            - nl-BE
            - fr-BE
            - cs-CZ
            - de-CH
            - en-SG
          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.
        SupportedEngines:
          type: array
          items:
            type: string
            enum:
            - standard
            - neural
            - long-form
            - generative
          description: Specifies which engines (standard, neural, long-form or generative) are supported by a given voice.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/polly/service/2016-06-10/polly-2016-06-10.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)