|
8 | 8 |
|
9 | 9 | <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
10 | 10 |
|
11 | | - <title>greengrasssdk.Lambda module — Greengrass Core Python SDK 1.5.0 documentation</title> |
| 11 | + <title>greengrasssdk.Lambda module — Greengrass Core Python SDK 1.6.0 documentation</title> |
12 | 12 |
|
13 | 13 |
|
14 | 14 |
|
|
56 | 56 |
|
57 | 57 |
|
58 | 58 | <div class="version"> |
59 | | - 1.5.0 |
| 59 | + 1.6.0 |
60 | 60 | </div> |
61 | 61 |
|
62 | 62 |
|
|
157 | 157 |
|
158 | 158 | <dl class="class"> |
159 | 159 | <dt id="greengrasssdk.Lambda.Client"> |
160 | | -<em class="property">class </em><code class="descclassname">greengrasssdk.Lambda.</code><code class="descname">Client</code><span class="sig-paren">(</span><em>endpoint='localhost'</em>, <em>port=8000</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/greengrasssdk/Lambda.html#Client"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#greengrasssdk.Lambda.Client" title="Permalink to this definition">¶</a></dt> |
| 160 | +<em class="property">class </em><code class="descclassname">greengrasssdk.Lambda.</code><code class="descname">Client</code><span class="sig-paren">(</span><em>endpoint='localhost'</em>, <em>port=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/greengrasssdk/Lambda.html#Client"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#greengrasssdk.Lambda.Client" title="Permalink to this definition">¶</a></dt> |
161 | 161 | <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> |
162 | 162 | <dl class="method"> |
163 | 163 | <dt id="greengrasssdk.Lambda.Client.invoke"> |
164 | 164 | <code class="descname">invoke</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/greengrasssdk/Lambda.html#Client.invoke"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#greengrasssdk.Lambda.Client.invoke" title="Permalink to this definition">¶</a></dt> |
165 | | -<dd></dd></dl> |
| 165 | +<dd><p>Invokes Lambda function of the given name.</p> |
| 166 | +<table class="docutils field-list" frame="void" rules="none"> |
| 167 | +<col class="field-name" /> |
| 168 | +<col class="field-body" /> |
| 169 | +<tbody valign="top"> |
| 170 | +<tr class="field-odd field"><th class="field-name" colspan="2">Keyword Arguments:</th></tr> |
| 171 | +<tr class="field-odd field"><td> </td><td class="field-body"><ul class="first simple"> |
| 172 | +<li><em>ClientContext</em> (<code class="docutils literal notranslate"><span class="pre">bytes</span></code>) – |
| 173 | +Optional Base64-encoded data about the invoking client to pass to the Lambda function</li> |
| 174 | +<li><em>FunctionName</em> (<code class="docutils literal notranslate"><span class="pre">string</span></code>) – |
| 175 | +[REQUIRED] |
| 176 | +The Amazon Resource Name (ARN) of the Lambda function to invoke. Name formats:<ul> |
| 177 | +<li>Qualified ARN - The function ARN with the version suffix. e.g. arn:aws:lambda:aws-region:acct-id:function:helloworld:1</li> |
| 178 | +<li>Unqualified ARN - The function ARN without the version suffix. e.g. arn:aws:lambda:aws-region:acct-id:function:helloworld</li> |
| 179 | +</ul> |
| 180 | +</li> |
| 181 | +<li><em>InvocationType</em> (<code class="docutils literal notranslate"><span class="pre">string</span></code>) – |
| 182 | +Choose from the following options.<ul> |
| 183 | +<li><code class="docutils literal notranslate"><span class="pre">RequestResponse</span></code> (default) - Invoke the Lambda synchronously. Block until the function returns a response or times out.</li> |
| 184 | +<li><code class="docutils literal notranslate"><span class="pre">Event</span></code> - Invoke the Lambda asynchronously. The response only includes empty payload.</li> |
| 185 | +</ul> |
| 186 | +</li> |
| 187 | +<li><em>Payload</em> (<code class="docutils literal notranslate"><span class="pre">bytes</span></code>) – |
| 188 | +Optional input for the Lambda function to invoke.</li> |
| 189 | +<li><em>Qualifier</em> (<code class="docutils literal notranslate"><span class="pre">string</span></code>) – |
| 190 | +Optional parameter to specify a Lambda function version if it was not included in the FunctionName field. |
| 191 | +If you specify a function version, the API uses the qualified function ARN to invoke a specific Lambda function.</li> |
| 192 | +</ul> |
| 193 | +</td> |
| 194 | +</tr> |
| 195 | +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><p>(<code class="docutils literal notranslate"><span class="pre">dict</span></code>) – |
| 196 | +* <em>FunctionError</em> (<code class="docutils literal notranslate"><span class="pre">string</span></code>) –</p> |
| 197 | +<blockquote> |
| 198 | +<div><p>If present, indicates that an error occurred while executing the Lambda function. If an error occurred, |
| 199 | +this field will have one of two values, <code class="docutils literal notranslate"><span class="pre">Handled</span></code> or <code class="docutils literal notranslate"><span class="pre">Unhandled</span></code>. <code class="docutils literal notranslate"><span class="pre">Handled</span></code> errors are errors that are reported by the function |
| 200 | +while the <code class="docutils literal notranslate"><span class="pre">Unhandled</span></code> errors are those detected and reported by Greengrass Core. |
| 201 | +<code class="docutils literal notranslate"><span class="pre">Unhandled</span></code> errors include out of memory errors and function timeouts. Error details are provided in the Payload.</p> |
| 202 | +</div></blockquote> |
| 203 | +<ul class="simple"> |
| 204 | +<li><em>Payload</em> (<code class="docutils literal notranslate"><span class="pre">bytes</span> <span class="pre">or</span> <span class="pre">StreamingBody</span> <span class="pre">object</span></code>) – |
| 205 | +It is the result returned by the Lambda function. This is present only if the invocation type is <code class="docutils literal notranslate"><span class="pre">RequestResponse</span></code>. |
| 206 | +In the event of a function error this field contains a message describing the error.</li> |
| 207 | +</ul> |
| 208 | +</p> |
| 209 | +</td> |
| 210 | +</tr> |
| 211 | +</tbody> |
| 212 | +</table> |
| 213 | +</dd></dl> |
166 | 214 |
|
167 | 215 | </dd></dl> |
168 | 216 |
|
|
199 | 247 |
|
200 | 248 | <div role="contentinfo"> |
201 | 249 | <p> |
202 | | - © Copyright 2019, Amazon.com. |
| 250 | + © Copyright 2020, Amazon.com. |
203 | 251 |
|
204 | 252 | </p> |
205 | 253 | </div> |
|
221 | 269 | <script type="text/javascript"> |
222 | 270 | var DOCUMENTATION_OPTIONS = { |
223 | 271 | URL_ROOT:'../', |
224 | | - VERSION:'1.5.0', |
| 272 | + VERSION:'1.6.0', |
225 | 273 | LANGUAGE:'None', |
226 | 274 | COLLAPSE_INDEX:false, |
227 | 275 | FILE_SUFFIX:'.html', |
|
0 commit comments