305 lines
No EOL
16 KiB
HTML
305 lines
No EOL
16 KiB
HTML
<!doctype html>
|
|
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
|
|
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
|
|
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>AWS Lambda - Home Assistant</title>
|
|
<meta name="author" content="Paulus Schoutsen">
|
|
<meta name="description" content="Instructions how to invoke AWS Lambda functions from Home Assistant.">
|
|
|
|
<meta name="viewport" content="width=device-width">
|
|
<link rel="canonical" href="https://home-assistant.io/components/notify.aws_lambda/">
|
|
|
|
<meta property="fb:app_id" content="338291289691179">
|
|
<meta property="og:title" content="AWS Lambda">
|
|
<meta property="og:site_name" content="Home Assistant">
|
|
<meta property="og:url" content="https://home-assistant.io/components/notify.aws_lambda/">
|
|
<meta property="og:type" content="article">
|
|
<meta property="og:description" content="Instructions how to invoke AWS Lambda functions from Home Assistant.">
|
|
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
|
|
|
|
<meta name="twitter:card" content="summary_large_image">
|
|
<meta name="twitter:site" content="@home_assistant">
|
|
|
|
<meta name="twitter:title" content="AWS Lambda">
|
|
<meta name="twitter:description" content="Instructions how to invoke AWS Lambda functions from Home Assistant.">
|
|
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
|
|
|
<link href="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
|
|
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
|
|
<link rel='shortcut icon' href='/images/favicon.ico' />
|
|
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
|
|
</head>
|
|
|
|
<body >
|
|
|
|
<header>
|
|
<div class="grid-wrapper">
|
|
<div class="grid">
|
|
|
|
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
|
|
<a href="/" class="site-title">
|
|
<img width='40' src='/demo/favicon-192x192.png'>
|
|
<span>Home Assistant</span>
|
|
</a>
|
|
</div>
|
|
|
|
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
|
|
<nav>
|
|
<input type="checkbox" id="toggle">
|
|
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
|
|
<ul class="menu pull-right">
|
|
|
|
<li><a href='/getting-started/'>Getting started</a></li>
|
|
<li><a href='/components/'>Components</a></li>
|
|
<li><a href='/cookbook/'>Examples</a></li>
|
|
<li><a href="/developers/">Developers</a></li>
|
|
<li><a href="/blog/">Blog</a></li>
|
|
<li><a href="/help/">Need help?</a></li>
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</header>
|
|
|
|
|
|
|
|
<div class="grid-wrapper">
|
|
<div class="grid grid-center">
|
|
|
|
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
|
|
|
|
|
|
<article class="page">
|
|
|
|
|
|
|
|
|
|
<header>
|
|
<h1 class="title indent">
|
|
AWS Lambda
|
|
</h1>
|
|
</header>
|
|
<hr class="divider">
|
|
|
|
|
|
<p>The <code>aws_lambda</code> notification platform enables invoking <a href="https://aws.amazon.com/lambda/">AWS Lambda</a> functions.</p>
|
|
|
|
<p>To use this notification platform in your installation, add the following to your <code>configuration.yaml</code> file:</p>
|
|
|
|
<h3>Configuration</h3>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre><span class="comment"># Example configuration.yaml entry</span>
|
|
<span class="key">notify</span>:
|
|
<span class="key">platform</span>: <span class="string"><span class="content">aws_lambda</span></span>
|
|
<span class="key">name</span>: <span class="string"><span class="content">NOTIFIER_NAME</span></span>
|
|
<span class="key">aws_access_key_id</span>: <span class="string"><span class="content">AWS_ACCESS_KEY_ID</span></span>
|
|
<span class="key">aws_secret_access_key</span>: <span class="string"><span class="content">AWS_SECRET_ACCESS_KEY</span></span>
|
|
<span class="key">profile_name</span>: <span class="string"><span class="content">AWS_PROFILE</span></span>
|
|
<span class="key">region_name</span>: <span class="string"><span class="content">'us-east-1'</span></span>
|
|
<span class="key">context</span>:
|
|
<span class="error">...</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<p>Configuration variables:</p>
|
|
|
|
<ul>
|
|
<li><strong>aws_access_key_id</strong> (<em>Required if aws_secret_access_key is provided</em>): Your AWS Access Key ID. For more information, please read the <a href="http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html">AWS General Reference regarding Security Credentials</a>. If provided, you must also provide an <code>aws_secret_access_key</code> and must <strong>not</strong> provide a <code>profile_name</code>.</li>
|
|
<li><strong>aws_secret_access_key</strong> (<em>Required if aws_access_key_id is provided</em>): Your AWS Secret Access Key. For more information, please read the <a href="http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html">AWS General Reference regarding Security Credentials</a>. If provided, you must also provide an <code>aws_access_key_id</code> and must <strong>not</strong> provide a <code>profile_name</code>.</li>
|
|
<li><strong>profile_name</strong> (<em>Optional</em>): A credentials profile name. For more information, please see the <a href="http://boto3.readthedocs.io/en/latest/guide/configuration.html#shared-credentials-file">boto3 documentation section about credentials</a>.</li>
|
|
<li><strong>region_name</strong> (<em>Required</em>): The region identifier to connect to. The default is <code>us-east-1</code>.</li>
|
|
<li><strong>name</strong> (<em>Optional</em>): Setting the optional parameter <code>name</code> allows multiple notifiers to be created. The default value is <code>notify</code>. The notifier will bind to the service <code>notify.NOTIFIER_NAME</code>.</li>
|
|
<li><strong>context</strong> (<em>Optional</em>): An optional dictionary you can provide to pass custom context through to the Lambda function. The <code>context</code> dictionary (if any) is combined with the same data available at the <code>/api/config</code> HTTP API route.</li>
|
|
</ul>
|
|
|
|
<h3><a class="title-link" name="usage" href="#usage"></a> Usage</h3>
|
|
|
|
<p>AWS Lambda is a notify platform and thus can be controlled by calling the notify service <a href="/components/notify/">as described here</a>. 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 (<a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name</a>) or a partial ARN. For more information, please see the <a href="http://boto3.readthedocs.io/en/latest/reference/services/lambda.html#Lambda.Client.invoke">boto3 docs</a>.</p>
|
|
|
|
<p>The Lambda event payload will contain everything passed in the service call payload. Here is an example payload that would be sent to Lambda:</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>{
|
|
<span class="key"><span class="delimiter">"</span><span class="content">title</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">Test message!</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">target</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">arn:aws:lambda:us-east-1:123456789012:function:ProcessKinesisRecords</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">data</span><span class="delimiter">"</span></span>: {
|
|
<span class="key"><span class="delimiter">"</span><span class="content">test</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">okay</span><span class="delimiter">"</span></span>
|
|
},
|
|
<span class="key"><span class="delimiter">"</span><span class="content">message</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">Hello world!</span><span class="delimiter">"</span></span>
|
|
}
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<p>The context will look like this:</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>{
|
|
<span class="key"><span class="delimiter">"</span><span class="content">hass</span><span class="delimiter">"</span></span>: {
|
|
<span class="key"><span class="delimiter">"</span><span class="content">components</span><span class="delimiter">"</span></span>: [<span class="string"><span class="delimiter">"</span><span class="content">recorder</span><span class="delimiter">"</span></span>, <span class="string"><span class="delimiter">"</span><span class="content">logger</span><span class="delimiter">"</span></span>, <span class="string"><span class="delimiter">"</span><span class="content">http</span><span class="delimiter">"</span></span>, <span class="string"><span class="delimiter">"</span><span class="content">logbook</span><span class="delimiter">"</span></span>, <span class="string"><span class="delimiter">"</span><span class="content">api</span><span class="delimiter">"</span></span>, <span class="string"><span class="delimiter">"</span><span class="content">frontend</span><span class="delimiter">"</span></span>],
|
|
<span class="key"><span class="delimiter">"</span><span class="content">latitude</span><span class="delimiter">"</span></span>: <span class="float">44.1234</span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">location_name</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">Home</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">longitude</span><span class="delimiter">"</span></span>: <span class="float">5.5678</span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">temperature_unit</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">°C</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">time_zone</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">Europe/Zurich</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">version</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">0.20.0.dev0</span><span class="delimiter">"</span></span>
|
|
},
|
|
<span class="key"><span class="delimiter">"</span><span class="content">custom</span><span class="delimiter">"</span></span>: {
|
|
<span class="key"><span class="delimiter">"</span><span class="content">two</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">three</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">test</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">one</span><span class="delimiter">"</span></span>
|
|
}
|
|
}
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
|
|
<div class="grid">
|
|
|
|
|
|
<section class="aside-module grid__item one-whole lap-one-half">
|
|
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.io/tree/master/source/_components/notify.aws_lambda.markdown'>Edit this page on GitHub</a></div>
|
|
<div class='brand-logo-container section'>
|
|
<img src='/images/supported_brands/aws_lambda.png' />
|
|
</div>
|
|
<div class='section'>
|
|
Introduced in release: 0.20
|
|
</div>
|
|
<div class='section'>
|
|
This is a platform for
|
|
<a href='/components/notify/'>the Notifications component</a>.
|
|
</div>
|
|
<div class='section'>
|
|
<h1 class="title delta">Category Notifications</h1>
|
|
<ul class='divided'>
|
|
<li>
|
|
AWS Lambda
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.aws_sns/'>AWS SNS</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.aws_sqs/'>AWS SQS</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.command_line/'>Command line Notify</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.ecobee/'>Ecobee Notify</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.file/'>File</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.free_mobile/'>Free Mobile</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.gntp/'>GNTP (Growl)</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.google_voice/'>Google Voice SMS</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.instapush/'>Instapush</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.xmpp/'>Jabber (XMPP)</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.webostv/'>LG WebOS TV notifications</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.mqtt/'>MQTT Notifications</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.message_bird/'>MessageBird</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.nma/'>Notify My Android</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.pushbullet/'>PushBullet</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.pushover/'>PushOver</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.pushetta/'>Pushetta</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.rest/'>REST</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.smtp/'>SMTP</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.sendgrid/'>SendGrid</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.slack/'>Slack</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.syslog/'>Syslog</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.telegram/'>Telegram</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.twilio_sms/'>Twilio SMS</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.twitter/'>Twitter</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
|
|
</div>
|
|
</aside>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<footer>
|
|
<div class="grid-wrapper">
|
|
<div class="grid">
|
|
<div class="grid__item">
|
|
<div class="copyright">
|
|
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
|
|
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
|
|
|
|
<div class="credit">
|
|
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a>.<br>
|
|
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
|
|
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
|
|
<script>
|
|
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
|
|
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
|
|
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
|
|
s.parentNode.insertBefore(g,s)}(document,'script'));
|
|
</script>
|
|
</body>
|
|
</html> |