home-assistant.io/source/_components/tts.amazon_polly.markdown

layout	title	description	date	sidebar	comments	sharing	footer	logo	ha_category	ha_release
page	Amazon Polly	Instructions on how to setup Amazon Polly with Home Assistant.	2017-01-28 09:00	true	false	true	true	polly.png	Text-to-speech	0.37

The amazon_polly text-to-speech platform that works with Amazon Polly to create the spoken output. Polly is a paid service via Amazon Web Services. There is a free tier for the first 12 months and then a charge per million characters afterwards.

{% linkable_title Setup %}

For more information, please read the AWS General Reference regarding Security Credentials to get the needed details. Also, check the boto3 Documentation about the profiles and the AWS Regions and Endpoints Reference for available regions.

Available voices are listed in the Amazon Documentation.

{% linkable_title Configuration %}

To get started, add the following lines to your configuration.yaml (example for Amazon Polly):

# Example configuration.yaml entry
tts:
  - platform: amazon_polly
    aws_access_key_id: AWS_ACCESS_KEY_ID
    aws_secret_access_key: AWS_SECRET_ACCESS_KEY

{% configuration %} aws_access_key_id: description: "Your AWS Access Key ID. If provided, you must also provide an aws_secret_access_key and must not provide a profile_name." required: true type: string aws_secret_access_key: description: "Your AWS Secret Access Key. If provided, you must also provide an aws_access_key_id and must not provide a profile_name." required: true type: string profile_name: description: A credentials profile name. required: false type: string region_name: description: The region identifier to connect to. required: false type: string or list default: us-east-1 name: description: "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." required: false type: string text_type: description: "Specify wherever to use text (default) or ssml markup by default." required: false type: string default: text voice: description: Voice name to be used. required: false type: string output_format: description: "Override the default output format. Either mp3, ogg_vorbis or pcm." required: false type: string default: mp3 sample_rate: description: "Override the default sample rate." required: false type: string default: 22050 for MP3 and Ogg Vorbis, 16000 for pcm {% endconfiguration %}

{% linkable_title Usage %}

Say to all media_player device entities:

- service: tts.amazon_polly_say
  data_template:
    message: '<speak>Hello from Amazon Polly</speak>'

or

- service: tts.amazon_polly_say
  data_template:
    message: >
      <speak>
          Hello from Amazon Polly
      </speak>

Say to the media_player.living_room device entity:

- service: tts.amazon_polly_say
  data_template:
    entity_id: media_player.living_room
    message: >
      <speak>
          Hello from Amazon Polly
      </speak>

Say with break:

- service: tts.amazon_polly_say
  data_template:
    message: >
      <speak>
          Hello from
          <break time=".9s" />
          Amazon Polly
      </speak>