Adapter - Amazon Polly
This page describes version 2.0.13 of the adapter.
Overview
This adapter uses the the Amazon Web Service Polly API to turn text into speech.
A valid AWS account is needed to use this adapter. Please refer to Amazon's Documentation for information about Amazon's Polly API.
Configuration
All of the Amazon adapters, require a region, accessKey and secretKey. The regions list can be in Amazon's documentation. The accessKey and secretKey are accessed by logging in to your amazon account.
Accessing Secret Key
The secretKey can only be accessed once, directly after the accessKey and secretKey are generated.
Properties
| Name | Display | Is Required | Comments | Type | Default Value | Maximum Value | Minimum Value | Maximum Length | Minimum Length |
|---|---|---|---|---|---|---|---|---|---|
| region | Region | True | The Amazon (AWS) region to run the commands on. | string | us-west-1 | 1024 | 1 | ||
| accessKey | Access Key | True | The Amazon account's Access Key. | password | 1024 | 1 | |||
| secretKey | Secret Key | True | The Amazon account's Secret Key. | password | 1024 | 1 | |||
| roleArn | Role ARN | False | The optional role ARN to assume. | string | 2048 | 1 | |||
| externalId | External ID | False | The external id to pass if assuming a role. | password | 1024 | 1 |
Commands
Synthesize Speech (synthesizeSpeech)
Turns text into audio bytes with a predetermined set of voices.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| text | Text | The text to turn into audio bytes. | True | string |
| voiceName | Voice Name | The name of the voice to use when turning the text into audio. Please refer to Amazon's documentation for a list of voice names. | True | string |
| lexiconNames | Lexicon Names | A list of lexicon names using a comma deliminated string. ex: lexicon1, lexicon2, lexicon3, limited to a list of 5 lexicons. For a complete list of lexicon uses, see AWS Documentation. | False | string |
| textType | Text Type | The text type of the input text. Valid Text Types are: ssml or text. | False | string |
| outputFormat | Output Format | The output format of the audio bytes. Valid Values are json, mp3, ogg_vorbis or pcm. | True | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| status | The general status of the executed command. Typically a success or failure message. | string |
| streamBytes | The byte stream that represents the audio of the text. | string |
Get Lexicon (getLexicon)
Gets a lexicon that has already been added.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| lexiconName | Lexicon Name | The lexicon name | True | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| status | The general status of the executed command. Typically a success or failure message. | string |
| lexiconName | The name of the lexicon | string |
| lexiconContent | The content of the lexicon. | string |
| lexiconArn | The Amazon resource name of the lexicon. | string |
| lexiconLanguageCode | The language code of the lexicon. | string |
List Lexicons (listLexicons)
Returns the list of added lexicons.
Response Properties
| Name | Description | Type |
|---|---|---|
| lexicons | The array of lexicons returned. | array |
| lexicons.lexiconName | The name of the Lexicon. | string |
| lexicons.attributes.alphabet | The alphabet used in the Lexicon. | string |
| lexicons.attributes.languageCode | The language code of the lexicon. | string |
| lexicons.attributes.lastModified | The last modified date and time of the Lexicon. | string |
| lexicons.attributes.lexemesCount | The number of lexemes that are in the Lexicon. | string |
| lexicons.attributes.lexiconArn | The Amazon resource name of the Lexicon. | string |
| lexicons.attributes.size | The size of the Lexicon. | string |
Put Lexicon (putLexicon)
Adds a lexicon to the list of lexicons in an Amazon region.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| lexiconName | Lexicon Name | The name of the new lexicon to create. | True | string |
| content | Content | The content of the new lexicon to create. | True | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| status | The general status of the executed command. Typically a success or failure message. | string |
Delete Lexicon (deleteLexicon)
Delete a lexicon.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| lexiconName | Lexicon Name | The name of the lexicon to delete. | True | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| status | The general status of the executed command. Typically a success or failure message. | string |
Release History
| Version | Type | Description | Tracking # | Date |
|---|---|---|---|---|
| 2.0.1 | Initial | First release in the Adapter Type store. | ||
| 2.0.10 | Maintenance | Updated third-party components and improved maintainability. | NAP-11518 | |
| 2.0.11 | Maintenance | Updated third-party components and improved maintainability. | NAP-23945 | 2022-11-30 |
| 2.0.12 | Bug fix | Removed spaces from comma delimited string for lexicon names. | NAP-24722 | 2023-02-02 |
| 2.0.13 | Maintenance | Updated third-party components and improved maintainability. | NAP-27635 | 2024-07-31 |