Amazon Web Services (AWS)

The aws integration provides a single place to interact with Amazon Web Services. Currently it provides a notification platform that can send a message to AWS SQS, AWS SNS, or invoke AWS Lambda functions.

Setup

You have to have an AWS account to use Amazon Web Services, create one here with a 12 months free tier benefit. Please note, even in the first 12-months, you may still be billed if you use more resources than offered in the free tier. We advise you to monitor your costs in the AWS Billing Console closely. You can read the Control your AWS costs guide for more information.

The lambda, sns, sqs, and events services, used in the aws integration, all provide an Always Free tier for all users even after the 12-month period. The general usage in Home Automation will most likely not reach the free tier limit. Please read Lambda Pricing, SNS Pricing, SQS Pricing, and EventBridge Pricing for more details.

The aws integration is using botocore to communicate with Amazon Web Services, which is also used by the AWS Command Client Interface tool. Therefore, aws shares the same credential and profiles with awscli tool. Please read Configuring the AWS CLI to learn how to get access keys and how to manage them on your local system securely.

Configuration

To use the aws integration and the notify platform in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
aws:
  credentials:
    - name: My AWS Account
      aws_access_key_id: AWS_ID
      aws_secret_access_key: AWS_SECRET
  notify:
    # use the first credential defined in aws integration by default
    - service: lambda
      region_name: us-east-1

Configuration for credentials

Configuration for notify

Lambda Notify Usage

AWS Lambda is a notification platform and thus can be controlled by calling the notify service as described here. It will invoke a Lambda for all targets given in the notification payload. A target can be formatted as a function name, an entire ARN (Amazon Resource Name) or a partial ARN. For more information, please see the botocore documentation.

The Lambda event payload will contain everything passed in the service call payload. Here is an example payload that would be sent to Lambda:

{
  "title": "Test message!",
  "target": "arn:aws:lambda:us-east-1:123456789012:function:ProcessKinesisRecords",
  "data": {
    "test": "okay"
  },
  "message": "Hello world!"
}

The context will look like this:

{
  "custom": {
    "two": "three",
    "test": "one"
  }
}

SNS Notify Usage

AWS SNS is a notification platform and thus can be controlled by calling the notify service as described here. It will publish a message to all targets given in the notification payload. A target must be a SNS topic or endpoint ARN (Amazon Resource Name). For more information, please see the botocore documentation.

If one exists, the SNS Subject will be set to the title. All attributes from the payload, except the message, will be sent as stringified message attributes.

Setting up SNS within AWS

• Log into your AWS console and under “Security and Identity”, select “Identity & Access Management”.
• On the left-hand side, select “Users” then click “Create New Users”. Enter a name here and then click “Create”.
• You can either download the credentials or click the arrow to display them one time.

• Copy/Paste the two keys that are shown here in your configuration.yaml file.
• On the left-hand side of the screen go back to “Users” and select the user you just created. On the “Permissions” tab click the “Attach Policy” icon. Search for “SNS” and attach the policy “AmazonSNSFullAccess”.
• Back to the AWS Console you now need to find “SNS” and click in to that service. It is under the Mobile Services group.
• On the left-hand side, select “Topics” then “Create new topic”.
• Choose a Topic Name and Display Name.
• Now check the box next to the Topic you just created and under Actions, select “Subscribe to topic”.
• In the box that pops up, select the Protocol = SMS and enter in the phone number next to “Endpoint” you wish to SMS. Now click “Create”.
• Repeat for additional numbers.
• Back in the “Users” section you will see a long alphanumeric line that starts with “arn:” and ends with the Topic Name you choose previously. This is what your “target” in Home Assistant will be.

SQS Notify Usage

AWS SQS is a notification 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 documentation and botocore documentation

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": "https://sqs.us-east-1.amazonaws.com/123456789012/queue2%22",
  "data": {
    "test": "okay"
  },
  "message": "Hello world!"
}

EventBridge Notify Usage

AWS EventBridge is a notification platform and thus can be controlled by calling the notify service as described here. It will publish a message to the event bus for all targets given in the notification payload. A target must be a name of an event bus accessible by the given credentials. A target is not required, and the default event bus will be used if none are specified. For more information, please see the EventBridge documentation and botocore documentation

There are two options for generating the event detail based on the service call payload. If the detail attribute is specified, then its value will be serialized as a JSON object and used for the event detail. If the attribute is not specified, then the value of the message attribute is serialized as a simple JSON object with a single key named message and the value of the message supplied to the service call.

Here are a couple of examples showing the service call input and corresponding API entry:

// Service call payload
{
  "message": "Hello world!"
}

// Corresponding Entries
{
  "Detail": "{\"message\": \"Hello world!\"}"
  "DetailType": "",
  "Source": "homeassistant",
  "Resources": [],
}

// Service Call Payload:
{
  "target": ["eventbus1", "eventbus2"]
  "data": {
    "detail_type": "test_event":
    "detail": {
      "key1", "value1",
      "key2", "value2"
    },
    "resources": ["resource1", "resource2"],
    "source": "example"
  }
  
}

// Corresponding Entries
[
  {
    "Detail": "{\"key1\": \"value1\",\"key2\": \"key2\": \"value2\"}"
    "DetailType": "test_event",
    "EventBusName": "eventbus1",
    "Resources": ["resource1", "resource2"],
    "Source": "example"
  },
  {
    "Detail": "{\"key1\": \"value1\",\"key2\": \"key2\": \"value2\"}"
    "DetailType": "test_event",
    "EventBusName": "eventbus2",
    "Resources": ["resource1", "resource2"],
    "Source": "example"
  }
]