mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 17:27:19 +00:00
Add inital docs for Amazon Polly (#1896)
This commit is contained in:
parent
d48df70ec9
commit
878905e2a3
36
source/_components/tts.amazon_polly.markdown
Normal file
36
source/_components/tts.amazon_polly.markdown
Normal file
@ -0,0 +1,36 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Amazon Polly"
|
||||
description: "Instructions how to setup Amazon Polly with Home Assistant."
|
||||
date: 2017-01-28 09:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: polly.png
|
||||
ha_category: Text-to-speech
|
||||
ha_release: 0.37
|
||||
---
|
||||
|
||||
The `amazon_polly` text-to-speech platform that works with [Amazon Polly](https://aws.amazon.com/polly/) to create the spoken output.
|
||||
|
||||
To enable text-to-speech with Amazon Polly, add the following lines to your `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
tts:
|
||||
- platform: amazon_polly
|
||||
aws_access_key_id: AWS_ACCESS_KEY_ID
|
||||
aws_secret_access_key: AWS_SECRET_ACCESS_KEY
|
||||
profile_name: AWS_PROFILE
|
||||
region_name: 'us-east-1'
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **aws_access_key_id** (*Required if aws_secret_access_key is provided*): Your AWS Access Key ID. For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html). If provided, you must also provide an `aws_secret_access_key` and must **not** provide a `profile_name`.
|
||||
- **aws_secret_access_key** (*Required if aws_access_key_id is provided*): Your AWS Secret Access Key. For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html). If provided, you must also provide an `aws_access_key_id` and must **not** provide a `profile_name`.
|
||||
- **profile_name** (*Optional*): A credentials profile name. For more information, please see the [boto3 documentation section about credentials](http://boto3.readthedocs.io/en/latest/guide/configuration.html#shared-credentials-file).
|
||||
- **region_name** (*Required*): The region identifier to connect to. The default is `us-east-1`.
|
||||
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
|
||||
|
BIN
source/images/supported_brands/polly.png
Normal file
BIN
source/images/supported_brands/polly.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 3.3 KiB |
Loading…
x
Reference in New Issue
Block a user