1{
2  "version": "1.0",
3  "examples": {
4    "AddPermission": [
5      {
6        "input": {
7          "Action": "lambda:InvokeFunction",
8          "FunctionName": "MyFunction",
9          "Principal": "s3.amazonaws.com",
10          "SourceAccount": "123456789012",
11          "SourceArn": "arn:aws:s3:::examplebucket/*",
12          "StatementId": "ID-1"
13        },
14        "output": {
15          "Statement": "ID-1"
16        },
17        "comments": {
18          "input": {
19          },
20          "output": {
21          }
22        },
23        "description": "This example adds a permission for an S3 bucket to invoke a Lambda function.",
24        "id": "add-permission-1474651469455",
25        "title": "add-permission"
26      }
27    ],
28    "CreateFunction": [
29      {
30        "input": {
31          "Code": {
32          },
33          "Description": "",
34          "FunctionName": "MyFunction",
35          "Handler": "souce_file.handler_name",
36          "MemorySize": 128,
37          "Publish": true,
38          "Role": "arn:aws:iam::123456789012:role/service-role/role-name",
39          "Runtime": "nodejs4.3",
40          "Timeout": 15,
41          "VpcConfig": {
42          }
43        },
44        "output": {
45          "CodeSha256": "",
46          "CodeSize": 123,
47          "Description": "",
48          "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:MyFunction",
49          "FunctionName": "MyFunction",
50          "Handler": "source_file.handler_name",
51          "LastModified": "2016-11-21T19:49:20.006+0000",
52          "MemorySize": 128,
53          "Role": "arn:aws:iam::123456789012:role/service-role/role-name",
54          "Runtime": "nodejs4.3",
55          "Timeout": 123,
56          "Version": "1",
57          "VpcConfig": {
58          }
59        },
60        "comments": {
61          "input": {
62            "Handler": "is of the form of the name of your source file and then name of your function handler",
63            "Role": "replace with the actual arn of the execution role you created"
64          },
65          "output": {
66          }
67        },
68        "description": "This example creates a Lambda function.",
69        "id": "create-function-1474653449931",
70        "title": "create-function"
71      }
72    ],
73    "DeleteAlias": [
74      {
75        "input": {
76          "FunctionName": "myFunction",
77          "Name": "alias"
78        },
79        "comments": {
80          "input": {
81          },
82          "output": {
83          }
84        },
85        "description": "This operation deletes a Lambda function alias",
86        "id": "to-delete-a-lambda-function-alias-1481660370804",
87        "title": "To delete a Lambda function alias"
88      }
89    ],
90    "DeleteEventSourceMapping": [
91      {
92        "input": {
93          "UUID": "12345kxodurf3443"
94        },
95        "output": {
96          "BatchSize": 123,
97          "EventSourceArn": "arn:aws:s3:::examplebucket/*",
98          "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction",
99          "LastModified": "2016-11-21T19:49:20.006+0000",
100          "LastProcessingResult": "",
101          "State": "",
102          "StateTransitionReason": "",
103          "UUID": "12345kxodurf3443"
104        },
105        "comments": {
106          "input": {
107          },
108          "output": {
109          }
110        },
111        "description": "This operation deletes a Lambda function event source mapping",
112        "id": "to-delete-a-lambda-function-event-source-mapping-1481658973862",
113        "title": "To delete a Lambda function event source mapping"
114      }
115    ],
116    "DeleteFunction": [
117      {
118        "input": {
119          "FunctionName": "myFunction",
120          "Qualifier": "1"
121        },
122        "comments": {
123          "input": {
124          },
125          "output": {
126          }
127        },
128        "description": "This operation deletes a Lambda function",
129        "id": "to-delete-a-lambda-function-1481648553696",
130        "title": "To delete a Lambda function"
131      }
132    ],
133    "GetAccountSettings": [
134      {
135        "input": {
136        },
137        "output": {
138          "AccountLimit": {
139          },
140          "AccountUsage": {
141          }
142        },
143        "comments": {
144          "input": {
145          },
146          "output": {
147          }
148        },
149        "description": "This operation retrieves a Lambda customer's account settings",
150        "id": "to-retrieves-a-lambda-customers-account-settings-1481657495274",
151        "title": "To retrieves a Lambda customer's account settings"
152      }
153    ],
154    "GetAlias": [
155      {
156        "input": {
157          "FunctionName": "myFunction",
158          "Name": "myFunctionAlias"
159        },
160        "output": {
161          "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunctionAlias",
162          "Description": "",
163          "FunctionVersion": "1",
164          "Name": "myFunctionAlias"
165        },
166        "comments": {
167          "input": {
168          },
169          "output": {
170          }
171        },
172        "description": "This operation retrieves a Lambda function alias",
173        "id": "to-retrieve-a-lambda-function-alias-1481648742254",
174        "title": "To retrieve a Lambda function alias"
175      }
176    ],
177    "GetEventSourceMapping": [
178      {
179        "input": {
180          "UUID": "123489-xxxxx-kdla8d89d7"
181        },
182        "output": {
183          "BatchSize": 123,
184          "EventSourceArn": "arn:aws:iam::123456789012:eventsource",
185          "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction",
186          "LastModified": "2016-11-21T19:49:20.006+0000",
187          "LastProcessingResult": "",
188          "State": "",
189          "StateTransitionReason": "",
190          "UUID": "123489-xxxxx-kdla8d89d7"
191        },
192        "comments": {
193          "input": {
194          },
195          "output": {
196          }
197        },
198        "description": "This operation retrieves a Lambda function's event source mapping",
199        "id": "to-retrieve-a-lambda-functions-event-source-mapping-1481661622799",
200        "title": "To retrieve a Lambda function's event source mapping"
201      }
202    ],
203    "GetFunction": [
204      {
205        "input": {
206          "FunctionName": "myFunction",
207          "Qualifier": "1"
208        },
209        "output": {
210          "Code": {
211            "Location": "somelocation",
212            "RepositoryType": "S3"
213          },
214          "Configuration": {
215            "CodeSha256": "LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=",
216            "CodeSize": 262,
217            "Description": "A starter AWS Lambda function.",
218            "Environment": {
219              "Variables": {
220                "S3_BUCKET": "test"
221              }
222            },
223            "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction",
224            "FunctionName": "myFunction",
225            "Handler": "index.handler",
226            "LastModified": "2016-11-21T19:49:20.006+0000",
227            "MemorySize": 128,
228            "Role": "arn:aws:iam::123456789012:role/lambda_basic_execution",
229            "Runtime": "nodejs4.3",
230            "Timeout": 3,
231            "Version": "$LATEST",
232            "VpcConfig": {
233              "SecurityGroupIds": [
234
235              ],
236              "SubnetIds": [
237
238              ]
239            }
240          }
241        },
242        "comments": {
243          "input": {
244          },
245          "output": {
246          }
247        },
248        "description": "This operation retrieves a Lambda function's event source mapping",
249        "id": "to-retrieve-a-lambda-functions-event-source-mapping-1481661622799",
250        "title": "To retrieve a Lambda function's event source mapping"
251      }
252    ],
253    "GetFunctionConfiguration": [
254      {
255        "input": {
256          "FunctionName": "myFunction",
257          "Qualifier": "1"
258        },
259        "output": {
260          "CodeSha256": "LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=",
261          "CodeSize": 123,
262          "DeadLetterConfig": {
263          },
264          "Description": "",
265          "Environment": {
266          },
267          "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction",
268          "FunctionName": "myFunction",
269          "Handler": "index.handler",
270          "KMSKeyArn": "",
271          "LastModified": "2016-11-21T19:49:20.006+0000",
272          "MemorySize": 128,
273          "Role": "arn:aws:iam::123456789012:role/lambda_basic_execution",
274          "Runtime": "python2.7",
275          "Timeout": 123,
276          "Version": "1",
277          "VpcConfig": {
278          }
279        },
280        "comments": {
281          "input": {
282          },
283          "output": {
284          }
285        },
286        "description": "This operation retrieves a Lambda function's event source mapping",
287        "id": "to-retrieve-a-lambda-functions-event-source-mapping-1481661622799",
288        "title": "To retrieve a Lambda function's event source mapping"
289      }
290    ],
291    "GetPolicy": [
292      {
293        "input": {
294          "FunctionName": "myFunction",
295          "Qualifier": "1"
296        },
297        "output": {
298          "Policy": ""
299        },
300        "comments": {
301          "input": {
302          },
303          "output": {
304          }
305        },
306        "description": "This operation retrieves a Lambda function policy",
307        "id": "to-retrieve-a-lambda-function-policy-1481649319053",
308        "title": "To retrieve a Lambda function policy"
309      }
310    ],
311    "Invoke": [
312      {
313        "input": {
314          "ClientContext": "MyApp",
315          "FunctionName": "MyFunction",
316          "InvocationType": "Event",
317          "LogType": "Tail",
318          "Payload": "fileb://file-path/input.json",
319          "Qualifier": "1"
320        },
321        "output": {
322          "FunctionError": "",
323          "LogResult": "",
324          "Payload": "?",
325          "StatusCode": 123
326        },
327        "comments": {
328          "input": {
329          },
330          "output": {
331          }
332        },
333        "description": "This operation invokes a Lambda function",
334        "id": "to-invoke-a-lambda-function-1481659683915",
335        "title": "To invoke a Lambda function"
336      }
337    ],
338    "InvokeAsync": [
339      {
340        "input": {
341          "FunctionName": "myFunction",
342          "InvokeArgs": "fileb://file-path/input.json"
343        },
344        "output": {
345          "Status": 123
346        },
347        "comments": {
348          "input": {
349          },
350          "output": {
351          }
352        },
353        "description": "This operation invokes a Lambda function asynchronously",
354        "id": "to-invoke-a-lambda-function-asynchronously-1481649694923",
355        "title": "To invoke a Lambda function asynchronously"
356      }
357    ],
358    "ListAliases": [
359      {
360        "input": {
361          "FunctionName": "myFunction",
362          "FunctionVersion": "1",
363          "Marker": "",
364          "MaxItems": 123
365        },
366        "output": {
367          "Aliases": [
368
369          ],
370          "NextMarker": ""
371        },
372        "comments": {
373          "input": {
374          },
375          "output": {
376          }
377        },
378        "description": "This operation retrieves a Lambda function's aliases",
379        "id": "to-retrieve-a-lambda-function-aliases-1481650199732",
380        "title": "To retrieve a Lambda function aliases"
381      }
382    ],
383    "ListFunctions": [
384      {
385        "input": {
386          "Marker": "",
387          "MaxItems": 123
388        },
389        "output": {
390          "Functions": [
391
392          ],
393          "NextMarker": ""
394        },
395        "comments": {
396          "input": {
397          },
398          "output": {
399          }
400        },
401        "description": "This operation retrieves a Lambda functions",
402        "id": "to-retrieve-a-list-of-lambda-functions-1481650507425",
403        "title": "To retrieve a list of Lambda functions"
404      }
405    ],
406    "ListVersionsByFunction": [
407      {
408        "input": {
409          "FunctionName": "myFunction",
410          "Marker": "",
411          "MaxItems": 123
412        },
413        "output": {
414          "NextMarker": "",
415          "Versions": [
416
417          ]
418        },
419        "comments": {
420          "input": {
421          },
422          "output": {
423          }
424        },
425        "description": "This operation retrieves a Lambda function versions",
426        "id": "to-retrieve-a-list-of-lambda-function-versions-1481650603750",
427        "title": "To retrieve a list of Lambda function versions"
428      }
429    ],
430    "PublishVersion": [
431      {
432        "input": {
433          "CodeSha256": "",
434          "Description": "",
435          "FunctionName": "myFunction"
436        },
437        "output": {
438          "CodeSha256": "",
439          "CodeSize": 123,
440          "Description": "",
441          "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction",
442          "FunctionName": "myFunction",
443          "Handler": "index.handler",
444          "LastModified": "2016-11-21T19:49:20.006+0000",
445          "MemorySize": 128,
446          "Role": "arn:aws:iam::123456789012:role/lambda_basic_execution",
447          "Runtime": "python2.7",
448          "Timeout": 123,
449          "Version": "1",
450          "VpcConfig": {
451          }
452        },
453        "comments": {
454          "input": {
455          },
456          "output": {
457          }
458        },
459        "description": "This operation publishes a version of a Lambda function",
460        "id": "to-publish-a-version-of-a-lambda-function-1481650704986",
461        "title": "To publish a version of a Lambda function"
462      }
463    ],
464    "RemovePermission": [
465      {
466        "input": {
467          "FunctionName": "myFunction",
468          "Qualifier": "1",
469          "StatementId": "role-statement-id"
470        },
471        "comments": {
472          "input": {
473          },
474          "output": {
475          }
476        },
477        "description": "This operation removes a Lambda function's permissions",
478        "id": "to-remove-a-lambda-functions-permissions-1481661337021",
479        "title": "To remove a Lambda function's permissions"
480      }
481    ],
482    "UpdateAlias": [
483      {
484        "input": {
485          "Description": "",
486          "FunctionName": "myFunction",
487          "FunctionVersion": "1",
488          "Name": "functionAlias"
489        },
490        "output": {
491          "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:functionAlias",
492          "Description": "",
493          "FunctionVersion": "1",
494          "Name": "functionAlias"
495        },
496        "comments": {
497          "input": {
498          },
499          "output": {
500          }
501        },
502        "description": "This operation updates a Lambda function alias",
503        "id": "to-update-a-lambda-function-alias-1481650817950",
504        "title": "To update a Lambda function alias"
505      }
506    ],
507    "UpdateEventSourceMapping": [
508      {
509        "input": {
510          "BatchSize": 123,
511          "Enabled": true,
512          "FunctionName": "myFunction",
513          "UUID": "1234xCy789012"
514        },
515        "output": {
516          "BatchSize": 123,
517          "EventSourceArn": "arn:aws:s3:::examplebucket/*",
518          "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction",
519          "LastModified": "2016-11-21T19:49:20.006+0000",
520          "LastProcessingResult": "",
521          "State": "",
522          "StateTransitionReason": "",
523          "UUID": "1234xCy789012"
524        },
525        "comments": {
526          "input": {
527          },
528          "output": {
529          }
530        },
531        "description": "This operation updates a Lambda function event source mapping",
532        "id": "to-update-a-lambda-function-event-source-mapping-1481650907413",
533        "title": "To update a Lambda function event source mapping"
534      }
535    ],
536    "UpdateFunctionCode": [
537      {
538        "input": {
539          "FunctionName": "myFunction",
540          "Publish": true,
541          "S3Bucket": "myBucket",
542          "S3Key": "myKey",
543          "S3ObjectVersion": "1",
544          "ZipFile": "fileb://file-path/file.zip"
545        },
546        "output": {
547          "CodeSha256": "LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=",
548          "CodeSize": 123,
549          "Description": "",
550          "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction",
551          "FunctionName": "myFunction",
552          "Handler": "index.handler",
553          "LastModified": "2016-11-21T19:49:20.006+0000",
554          "MemorySize": 128,
555          "Role": "arn:aws:iam::123456789012:role/lambda_basic_execution",
556          "Runtime": "python2.7",
557          "Timeout": 123,
558          "Version": "1",
559          "VpcConfig": {
560          }
561        },
562        "comments": {
563          "input": {
564          },
565          "output": {
566          }
567        },
568        "description": "This operation updates a Lambda function's code",
569        "id": "to-update-a-lambda-functions-code-1481650992672",
570        "title": "To update a Lambda function's code"
571      }
572    ],
573    "UpdateFunctionConfiguration": [
574      {
575        "input": {
576          "Description": "",
577          "FunctionName": "myFunction",
578          "Handler": "index.handler",
579          "MemorySize": 128,
580          "Role": "arn:aws:iam::123456789012:role/lambda_basic_execution",
581          "Runtime": "python2.7",
582          "Timeout": 123,
583          "VpcConfig": {
584          }
585        },
586        "output": {
587          "CodeSha256": "LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=",
588          "CodeSize": 123,
589          "Description": "",
590          "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction",
591          "FunctionName": "myFunction",
592          "Handler": "index.handler",
593          "LastModified": "2016-11-21T19:49:20.006+0000",
594          "MemorySize": 128,
595          "Role": "arn:aws:iam::123456789012:role/lambda_basic_execution",
596          "Runtime": "python2.7",
597          "Timeout": 123,
598          "Version": "1",
599          "VpcConfig": {
600          }
601        },
602        "comments": {
603          "input": {
604          },
605          "output": {
606          }
607        },
608        "description": "This operation updates a Lambda function's configuration",
609        "id": "to-update-a-lambda-functions-configuration-1481651096447",
610        "title": "To update a Lambda function's configuration"
611      }
612    ]
613  }
614}
615