AWS API Changes

2016/11/30 - Amazon Polly - 6 new api methods

Changes Update polly client to latest version

DescribeVoices (new)

Link ¶

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: AWS API Documentation

Request Syntax

client.describe_voices(
    LanguageCode='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'|'nb-NO'|'nl-NL'|'pl-PL'|'pt-BR'|'pt-PT'|'ro-RO'|'ru-RU'|'sv-SE'|'tr-TR',
    NextToken='string'
)

type LanguageCode:

string

param 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.

type NextToken:

string

param NextToken:

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

rtype:

dict

returns:

Response Syntax

{
    'Voices': [
        {
            'Gender': 'Female'|'Male',
            'Id': 'Geraint'|'Gwyneth'|'Mads'|'Naja'|'Hans'|'Marlene'|'Nicole'|'Russell'|'Amy'|'Brian'|'Emma'|'Raveena'|'Ivy'|'Joanna'|'Joey'|'Justin'|'Kendra'|'Kimberly'|'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',
            'LanguageCode': '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'|'nb-NO'|'nl-NL'|'pl-PL'|'pt-BR'|'pt-PT'|'ro-RO'|'ru-RU'|'sv-SE'|'tr-TR',
            'LanguageName': 'string',
            'Name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Voices (list) --
  
  A list of voices with their properties.
  - (dict) --
    
    Description of the voice.
    - Gender (string) --
      
      Gender of the voice.
    - Id (string) --
      
      Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.
    - LanguageCode (string) --
      
      Language code of the voice.
    - LanguageName (string) --
      
      Human readable name of the language in English.
    - Name (string) --
      
      Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.
- NextToken (string) --
  
  The pagination token to use in the next request to continue the listing of voices. NextToken is returned only if the response is truncated.

GetLexicon (new)

Link ¶

Returns the content of the specified pronunciation lexicon stored in an AWS Region. For more information, see Managing Lexicons.

See also: AWS API Documentation

Request Syntax

client.get_lexicon(
    Name='string'
)

type Name:

string

param Name:

[REQUIRED]

Name of the lexicon.

rtype:

dict

returns:

Response Syntax

{
    'Lexicon': {
        'Content': 'string',
        'Name': 'string'
    },
    'LexiconAttributes': {
        'Alphabet': 'string',
        'LanguageCode': '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'|'nb-NO'|'nl-NL'|'pl-PL'|'pt-BR'|'pt-PT'|'ro-RO'|'ru-RU'|'sv-SE'|'tr-TR',
        'LastModified': datetime(2015, 1, 1),
        'LexiconArn': 'string',
        'LexemesCount': 123,
        'Size': 123
    }
}

Response Structure

(dict) --
- Lexicon (dict) --
  
  Lexicon object that provides name and the string content of the lexicon.
  - Content (string) --
    
    Lexicon content in string format. The content of a lexicon must be in PLS format.
  - Name (string) --
    
    Name of the lexicon.
- LexiconAttributes (dict) --
  
  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.
  - Alphabet (string) --
    
    Phonetic alphabet used in the lexicon. Valid values are ipa and x-sampa.
  - LanguageCode (string) --
    
    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.
  - LastModified (datetime) --
    
    Date lexicon was last modified (a timestamp value).
  - LexiconArn (string) --
    
    Amazon Resource Name (ARN) of the lexicon.
  - LexemesCount (integer) --
    
    Number of lexemes in the lexicon.
  - Size (integer) --
    
    Total size of the lexicon, in characters.

SynthesizeSpeech (new)

Link ¶

Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes. SSML input must be valid, well-formed SSML. Some alphabets might not be available with all the voices (for example, Cyrillic might not be read at all by English voices) unless phoneme mapping is used. For more information, see How it Works.

See also: AWS API Documentation

Request Syntax

client.synthesize_speech(
    LexiconNames=[
        'string',
    ],
    OutputFormat='mp3'|'ogg_vorbis'|'pcm',
    SampleRate='string',
    Text='string',
    TextType='ssml'|'text',
    VoiceId='Geraint'|'Gwyneth'|'Mads'|'Naja'|'Hans'|'Marlene'|'Nicole'|'Russell'|'Amy'|'Brian'|'Emma'|'Raveena'|'Ivy'|'Joanna'|'Joey'|'Justin'|'Kendra'|'Kimberly'|'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'
)

type LexiconNames:

list

param 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.

(string) --

type OutputFormat:

string

param OutputFormat:

[REQUIRED]

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

type SampleRate:

string

param 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".

type Text:

string

param Text:

[REQUIRED]

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

type TextType:

string

param TextType:

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

type VoiceId:

string

param VoiceId:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'AudioStream': StreamingBody(),
    'ContentType': 'string',
    'RequestCharacters': 123
}

Response Structure

(dict) --
- AudioStream (:class:`.StreamingBody`) --
  
  Stream containing the synthesized speech.
- ContentType (string) --
  
  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.
- RequestCharacters (integer) --
  
  Number of characters synthesized.

DeleteLexicon (new)

Link ¶

Deletes the specified pronunciation lexicon stored in an AWS Region. A lexicon which has been deleted is not available for speech synthesis, nor is it possible to retrieve it using either the GetLexicon or ListLexicon APIs.

For more information, see Managing Lexicons.

See also: AWS API Documentation

Request Syntax

client.delete_lexicon(
    Name='string'
)

type Name:

string

param Name:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

PutLexicon (new)

Link ¶

Stores a pronunciation lexicon in an AWS Region. If a lexicon with the same name already exists in the region, it is overwritten by the new lexicon. Lexicon operations have eventual consistency, therefore, it might take some time before the lexicon is available to the SynthesizeSpeech operation.

For more information, see Managing Lexicons.

See also: AWS API Documentation

Request Syntax

client.put_lexicon(
    Name='string',
    Content='string'
)

type Name:

string

param Name:

[REQUIRED]

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.

type Content:

string

param Content:

[REQUIRED]

Content of the PLS lexicon as string data.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

ListLexicons (new)

Link ¶

Returns a list of pronunciation lexicons stored in an AWS Region. For more information, see Managing Lexicons.

See also: AWS API Documentation

Request Syntax

client.list_lexicons(
    NextToken='string'
)

type NextToken:

string

param NextToken:

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

rtype:

dict

returns:

Response Syntax

{
    'Lexicons': [
        {
            'Name': 'string',
            'Attributes': {
                'Alphabet': 'string',
                'LanguageCode': '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'|'nb-NO'|'nl-NL'|'pl-PL'|'pt-BR'|'pt-PT'|'ro-RO'|'ru-RU'|'sv-SE'|'tr-TR',
                'LastModified': datetime(2015, 1, 1),
                'LexiconArn': 'string',
                'LexemesCount': 123,
                'Size': 123
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Lexicons (list) --
  
  A list of lexicon names and attributes.
  - (dict) --
    
    Describes the content of the lexicon.
    - Name (string) --
      
      Name of the lexicon.
    - Attributes (dict) --
      
      Provides lexicon metadata.
      - Alphabet (string) --
        
        Phonetic alphabet used in the lexicon. Valid values are ipa and x-sampa.
      - LanguageCode (string) --
        
        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.
      - LastModified (datetime) --
        
        Date lexicon was last modified (a timestamp value).
      - LexiconArn (string) --
        
        Amazon Resource Name (ARN) of the lexicon.
      - LexemesCount (integer) --
        
        Number of lexemes in the lexicon.
      - Size (integer) --
        
        Total size of the lexicon, in characters.
- NextToken (string) --
  
  The pagination token to use in the next request to continue the listing of lexicons. NextToken is returned only if the response is truncated.