home-assistant.io/source/_components/aws_sqs.markdown

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_release, redirect_from

layout	title	description	date	sidebar	comments	sharing	footer	logo	ha_category	ha_release	redirect_from
page	AWS SQS	Instructions on how to publish messages to AWS SQS from Home Assistant.	2016-05-14 16:35	true	false	true	true	aws_sqs.png	Notifications	0.20	/components/notify.aws_sqs/

The aws_sqs notification platform enables publishing to an AWS SQS message queue.

{% 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.

{% linkable_title Configuration %}

To use this notification platform in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
notify:
  - name: NOTIFIER_NAME
    platform: aws_sqs
    aws_access_key_id: AWS_ACCESS_KEY_ID
    aws_secret_access_key: AWS_SECRET_ACCESS_KEY
    region_name: 'us-east-1'

{% 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: Required if aws_secret_access_key is provided 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: Required if aws_access_key_id is provided type: string profile_name: description: A credentials profile name. required: false type: string region_name: description: The region identifier to connect to. required: true default: us-east-1 type: string name: description: Setting the optional parameter name allows multiple notifiers to be created. The notifier will bind to the service notify.NOTIFIER_NAME. required: false default: notify type: string {% endconfiguration %}

{% linkable_title Usage %}

AWS SQS is a notify platform and thus can be controlled by calling the notify service as described here. It will publish a message to the queue for all targets given in the notification payload. A target must be a SQS topic URL. For more information, please see the SQS docs.

The SQS event payload will contain everything passed in the service call payload. SQS payloads will be published as stringified JSON. All attributes from the payload except message will also be sent as stringified message attributes. Here is an example message that would be published to the SQS queue:

{
  "title": "Test message!",
  "target": "http://sqs.us-east-1.amazonaws.com/123456789012/queue2",
  "data": {
    "test": "okay"
  },
  "message": "Hello world!"
}