# TTSAWSPolly

> Symcon documentation · English · generated on 2026-09-26  
> Index: https://www.symcon.de/en/llms.txt

Source: https://www.symcon.de/en/service/documentation/module-reference/notifications/ttsawspolly/

_Requires Symcon >= 5.1_

The Text to Speech (AWS Polly) module is used to generate sound data/files, which can be used e.g. for audio notifications or VoIP announcements.

### function scope
- Create sound data that can be stored in a media file for output via audio notifications, for example
- Create sound files that can be used for an output in the VoIP module

### requirements
- Account with Amazon Web Services
- User with appropriate Access Key/Secret Key and access rights to Polly (e.g. AmazonPollyFullAccess)

### Software Installation
The "Text to Speech (AWS Polly)" module can be installed directly from the [Module Store](https://www.symcon.de/en/service/documentation/components/management-console/module-store/).

### User setup in AWS IAM
On the Amazon AWS home page, you need to search for the IAM in AWS Services.

![Aws managementconsole](https://www.symcon.de/media/pages/service/dokumentation/modulreferenz/benachrichtigungen/ttsawspolly/43ac635bf9-1790424938/aws-managementconsole.png)

Within the IAM a new user has to be added

![Aws iam user](https://www.symcon.de/media/pages/service/dokumentation/modulreferenz/benachrichtigungen/ttsawspolly/81c3f9ab48-1790424938/aws-iam-user.png)
![Aws iam useradd](https://www.symcon.de/media/pages/service/dokumentation/modulreferenz/benachrichtigungen/ttsawspolly/828e98e7db-1790424938/aws-iam-useradd.png)

Afterwards, a speaking username should be assigned and "Program controlled access" should be activated.

![Aws iam userdetails](https://www.symcon.de/media/pages/service/dokumentation/modulreferenz/benachrichtigungen/ttsawspolly/2203669942-1790424938/aws-iam-userdetails.png)

As a policy "AmazonPollyFullAccess" must be activated.

![Aws iam userpermissions](https://www.symcon.de/media/pages/service/dokumentation/modulreferenz/benachrichtigungen/ttsawspolly/1a2e43251e-1790424938/aws-iam-userpermissions.png)

Skip the next dialog with "Next: Check".
Create the user by clicking on "Create user".

After creating the user, it will be assigned an access key ID and a secret access key.

![Aws iam userkeys](https://www.symcon.de/media/pages/service/dokumentation/modulreferenz/benachrichtigungen/ttsawspolly/52fa66de86-1790424938/aws-iam-userkeys.png)

### setting up the instances in IP-Symcon
- Under "Add Instance", the 'Text to Speech (AWS Polly)' module can be found using the quick filter.
  - For more information on adding instances, see the [Instances documentation](https://www.symcon.de/en/service/documentation/basics/instances/)

#### ConfigurationPage:

| Name          | Description                                                       |
| ------------- | ----------------------------------------------------------------- |
| Access Key    | Access Key from AWS user who has access to Polly                  |
| Secret Key    | Secret Key of the AWS user who has access to Polly                |
| Region        | Region in which Polly should be used                              |
| Language      | Language in which the output should take place                    |
| Output Format | Format (MP3/WAV/OGG) of the output                                |
| Sample Rate   | Sample Rate (Standard, 8000 Hz, 16000 Hz, 22050 Hz) of the output |
| Text type     | Type of text. For SSML the special SSML tags can be used          |

After entering the Access Key/Secret Key the configuration must be saved to load the available languages.

## TTSAWSPOLLY_GenerateData

Source: https://www.symcon.de/en/service/documentation/module-reference/notifications/ttsawspolly/ttsawspolly-generatedata/

`string TTSAWSPOLLY_GenerateData(int $InstanceID, string $Text)`

_Requires Symcon >= 5.1_

Queries the text via AWS and returns the speech data in the return.

**Parameters**

- `$InstanceID` (int): ID of the Instance
- `$Text` (string): Voice data

**Returns** (string): Base64 encoded voice data

Voice data

**Example**

```text
echo TTSAWSPOLLY_GenerateData(12345, "This is a test");
```

## TTSAWSPOLLY_GenerateFile

Source: https://www.symcon.de/en/service/documentation/module-reference/notifications/ttsawspolly/ttsawspolly-generatefile/

`string TTSAWSPOLLY_GenerateFile(int $InstanceID, string $Text)`

_Requires Symcon >= 5.1_

**Parameters**

- `$InstanceID` (int): ID of the Instance
- `$Text` (string): Voice data

**Returns** (string): Voice data filename

Voice data

**Example**

```text
echo TTSAWSPOLLY_GenerateFile(12345, "this is a test");
```