AWS API Changes

2018/07/17 - Amazon Polly - 3 new api methods

Changes Update polly client to latest version

StartSpeechSynthesisTask (new)

Link ¶

Allows the creation of an asynchronous synthesis task, by starting a new SpeechSynthesisTask. This operation requires all the standard information needed for speech synthesis, plus the name of an Amazon S3 bucket for the service to store the output of the synthesis task and two optional parameters (OutputS3KeyPrefix and SnsTopicArn). Once the synthesis task is created, this operation will return a SpeechSynthesisTask object, which will include an identifier of this task as well as the current status.

See also: AWS API Documentation

Request Syntax

client.start_speech_synthesis_task(
    LexiconNames=[
        'string',
    ],
    OutputFormat='json'|'mp3'|'ogg_vorbis'|'pcm',
    OutputS3BucketName='string',
    OutputS3KeyPrefix='string',
    SampleRate='string',
    SnsTopicArn='string',
    SpeechMarkTypes=[
        'sentence'|'ssml'|'viseme'|'word',
    ],
    Text='string',
    TextType='ssml'|'text',
    VoiceId='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'
)

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.

(string) --

type OutputFormat:

string

param OutputFormat:

[REQUIRED]

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.

type OutputS3BucketName:

string

param OutputS3BucketName:

[REQUIRED]

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

type OutputS3KeyPrefix:

string

param OutputS3KeyPrefix:

The Amazon S3 Key prefix for the output speech file.

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 SnsTopicArn:

string

param SnsTopicArn:

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

type SpeechMarkTypes:

list

param SpeechMarkTypes:

The type of speech marks returned for the input text.

(string) --

type Text:

string

param Text:

[REQUIRED]

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

type VoiceId:

string

param VoiceId:

[REQUIRED]

Voice ID to use for the synthesis.

rtype:

dict

returns:

Response Syntax

{
    'SynthesisTask': {
        'TaskId': 'string',
        'TaskStatus': 'scheduled'|'inProgress'|'completed'|'failed',
        'TaskStatusReason': 'string',
        'OutputUri': 'string',
        'CreationTime': datetime(2015, 1, 1),
        'RequestCharacters': 123,
        'SnsTopicArn': 'string',
        'LexiconNames': [
            'string',
        ],
        'OutputFormat': 'json'|'mp3'|'ogg_vorbis'|'pcm',
        'SampleRate': 'string',
        'SpeechMarkTypes': [
            'sentence'|'ssml'|'viseme'|'word',
        ],
        'TextType': 'ssml'|'text',
        'VoiceId': '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'
    }
}

Response Structure

(dict) --
- SynthesisTask (dict) --
  
  SynthesisTask object that provides information and attributes about a newly submitted speech synthesis task.
  - TaskId (string) --
    
    The Amazon Polly generated identifier for a speech synthesis task.
  - TaskStatus (string) --
    
    Current status of the individual speech synthesis task.
  - TaskStatusReason (string) --
    
    Reason for the current status of a specific speech synthesis task, including errors if the task has failed.
  - OutputUri (string) --
    
    Pathway for the output speech file.
  - CreationTime (datetime) --
    
    Timestamp for the time the synthesis task was started.
  - RequestCharacters (integer) --
    
    Number of billable characters synthesized.
  - SnsTopicArn (string) --
    
    ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
  - LexiconNames (list) --
    
    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.
    - (string) --
  - OutputFormat (string) --
    
    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.
  - SampleRate (string) --
    
    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) --
    
    The type of speech marks returned for the input text.
    - (string) --
  - TextType (string) --
    
    Specifies whether the input text is plain text or SSML. The default value is plain text.
  - VoiceId (string) --
    
    Voice ID to use for the synthesis.

GetSpeechSynthesisTask (new)

Link ¶

Retrieves a specific SpeechSynthesisTask object based on its TaskID. This object contains information about the given speech synthesis task, including the status of the task, and a link to the S3 bucket containing the output of the task.

See also: AWS API Documentation

Request Syntax

client.get_speech_synthesis_task(
    TaskId='string'
)

type TaskId:

string

param TaskId:

[REQUIRED]

The Amazon Polly generated identifier for a speech synthesis task.

rtype:

dict

returns:

Response Syntax

{
    'SynthesisTask': {
        'TaskId': 'string',
        'TaskStatus': 'scheduled'|'inProgress'|'completed'|'failed',
        'TaskStatusReason': 'string',
        'OutputUri': 'string',
        'CreationTime': datetime(2015, 1, 1),
        'RequestCharacters': 123,
        'SnsTopicArn': 'string',
        'LexiconNames': [
            'string',
        ],
        'OutputFormat': 'json'|'mp3'|'ogg_vorbis'|'pcm',
        'SampleRate': 'string',
        'SpeechMarkTypes': [
            'sentence'|'ssml'|'viseme'|'word',
        ],
        'TextType': 'ssml'|'text',
        'VoiceId': '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'
    }
}

Response Structure

(dict) --
- SynthesisTask (dict) --
  
  SynthesisTask object that provides information from the requested task, including output format, creation time, task status, and so on.
  - TaskId (string) --
    
    The Amazon Polly generated identifier for a speech synthesis task.
  - TaskStatus (string) --
    
    Current status of the individual speech synthesis task.
  - TaskStatusReason (string) --
    
    Reason for the current status of a specific speech synthesis task, including errors if the task has failed.
  - OutputUri (string) --
    
    Pathway for the output speech file.
  - CreationTime (datetime) --
    
    Timestamp for the time the synthesis task was started.
  - RequestCharacters (integer) --
    
    Number of billable characters synthesized.
  - SnsTopicArn (string) --
    
    ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
  - LexiconNames (list) --
    
    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.
    - (string) --
  - OutputFormat (string) --
    
    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.
  - SampleRate (string) --
    
    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) --
    
    The type of speech marks returned for the input text.
    - (string) --
  - TextType (string) --
    
    Specifies whether the input text is plain text or SSML. The default value is plain text.
  - VoiceId (string) --
    
    Voice ID to use for the synthesis.

ListSpeechSynthesisTasks (new)

Link ¶

Returns a list of SpeechSynthesisTask objects ordered by their creation date. This operation can filter the tasks by their status, for example, allowing users to list only tasks that are completed.

See also: AWS API Documentation

Request Syntax

client.list_speech_synthesis_tasks(
    MaxResults=123,
    NextToken='string',
    Status='scheduled'|'inProgress'|'completed'|'failed'
)

type MaxResults:

integer

param MaxResults:

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

type NextToken:

string

param NextToken:

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

type Status:

string

param Status:

Status of the speech synthesis tasks returned in a List operation

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'SynthesisTasks': [
        {
            'TaskId': 'string',
            'TaskStatus': 'scheduled'|'inProgress'|'completed'|'failed',
            'TaskStatusReason': 'string',
            'OutputUri': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'RequestCharacters': 123,
            'SnsTopicArn': 'string',
            'LexiconNames': [
                'string',
            ],
            'OutputFormat': 'json'|'mp3'|'ogg_vorbis'|'pcm',
            'SampleRate': 'string',
            'SpeechMarkTypes': [
                'sentence'|'ssml'|'viseme'|'word',
            ],
            'TextType': 'ssml'|'text',
            'VoiceId': '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'
        },
    ]
}

Response Structure

(dict) --
- NextToken (string) --
  
  An opaque pagination token returned from the previous List operation in this request. If present, this indicates where to continue the listing.
- SynthesisTasks (list) --
  
  SynthesisTask object that provides information from the specified task in the list request, including output format, creation time, task status, and so on.
  - (dict) --
    
    SynthesisTask object that provides information about a speech synthesis task.
    - TaskId (string) --
      
      The Amazon Polly generated identifier for a speech synthesis task.
    - TaskStatus (string) --
      
      Current status of the individual speech synthesis task.
    - TaskStatusReason (string) --
      
      Reason for the current status of a specific speech synthesis task, including errors if the task has failed.
    - OutputUri (string) --
      
      Pathway for the output speech file.
    - CreationTime (datetime) --
      
      Timestamp for the time the synthesis task was started.
    - RequestCharacters (integer) --
      
      Number of billable characters synthesized.
    - SnsTopicArn (string) --
      
      ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
    - LexiconNames (list) --
      
      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.
      - (string) --
    - OutputFormat (string) --
      
      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.
    - SampleRate (string) --
      
      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) --
      
      The type of speech marks returned for the input text.
      - (string) --
    - TextType (string) --
      
      Specifies whether the input text is plain text or SSML. The default value is plain text.
    - VoiceId (string) --
      
      Voice ID to use for the synthesis.