Skip to content

Commit 19024bd

Browse files
craftizardcraftizard
committed
all example README files updated
1 parent ce34fcd commit 19024bd

File tree

61 files changed

+651
-257
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+651
-257
lines changed

‎aws-golang-simple-http-endpoint/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!--
2+
title: TODO
3+
description: TODO
4+
layout: Doc
5+
framework: v1
6+
platform: AWS
7+
language: Go
8+
authorLink: 'https://github.com/sebito91'
9+
authorName: 'Sebastian Borza'
10+
authorAvatar: 'https://avatars0.githubusercontent.com/u/3159454?v=4&s=140'
11+
-->

‎aws-java-simple-http-endpoint/README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
<!--
2-
title: AWS Simple HTTP Endpoint example in Java
3-
description: This example demonstrates how to setup a simple HTTP GET endpoint using Java. Once you ping it, it will reply with the current time.
2+
title: 'AWS Simple HTTP Endpoint example in Java'
3+
description: 'This example demonstrates how to setup a simple HTTP GET endpoint using Java. Once you ping it, it will reply with the current time.'
44
layout: Doc
5+
framework: v1
6+
platform: AWS
7+
language: Java
8+
authorLink: 'https://github.com/DoWhileGeek'
9+
authorName: 'Joeseph Rodrigues'
10+
authorAvatar: 'https://avatars3.githubusercontent.com/u/1767769?v=4&s=140'
511
-->
612
# Simple HTTP Endpoint Example
713

@@ -131,7 +137,7 @@ The expected result should be similar to:
131137
}
132138
--------------------------------------------------------------------
133139
START RequestId: XXXXXXX Version: $LATEST
134-
2017-01-04 23:44:37 <XXXXXXX> INFO com.serverless.Handler:18 - received: {}
140+
2004 23:44:37 <XXXXXXX> INFO com.serverless.Handler:18 - received: {}
135141
END RequestId: XXXXXXX
136142
REPORT RequestId: XXXXXXX Duration: 0.51 ms Billed Duration: 100 ms Memory Size: 1024 MB Max Memory Used: 53 MB
137143
```

‎aws-multiple-runtime/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!--
2+
title: TODO
3+
description: TODO
4+
layout: Doc
5+
framework: v1
6+
platform: AWS
7+
language: nodeJS
8+
authorLink: 'https://github.com/christophgysin'
9+
authorName: 'Christoph Gysin'
10+
authorAvatar: 'https://avatars0.githubusercontent.com/u/527924?v=4&s=140'
11+
-->

‎aws-node-alexa-skill/README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
<!--
2-
title: AWS Serverless Alexa Skill example in NodeJS
3-
description: This example demonstrates how to setup your own Alexa skill using AWS Lambdas.
2+
title: 'AWS Serverless Alexa Skill example in NodeJS'
3+
description: 'This example demonstrates how to setup your own Alexa skill using AWS Lambdas.'
44
layout: Doc
5+
framework: v1
6+
platform: AWS
7+
language: nodeJS
8+
authorLink: 'https://github.com/rupakg'
9+
authorName: 'Rupak Ganguly'
10+
authorAvatar: 'https://avatars0.githubusercontent.com/u/8188?v=4&s=140'
511
-->
612
# Serverless Alexa Skill Example
713

@@ -49,11 +55,11 @@ functions:
4955

5056
Next we need to setup an Alexa skill. Once you've signed up for the Amazon Developer Platform visit `https://developer.amazon.com/edw/home.html`. There you should see the following screen:
5157

52-
![Welcome](https://cloud.githubusercontent.com/assets/223045/21183285/8403b37c-c207-11e6-89c0-d36582010af8.png)
58+
![Welcome](https://cloud.githubusercontent.com/assets/223045/21183285/8403b37c-c211e6-89c0-d36582010af8.png)
5359

5460
Next click on `Add a new Skill`:
5561

56-
![Add Skill](https://cloud.githubusercontent.com/assets/223045/21183286/84051262-c207-11e6-8422-945b6b45e83b.png)
62+
![Add Skill](https://cloud.githubusercontent.com/assets/223045/21183286/840512c211e6-84945b6b45e83b.png)
5763

5864
Go through the steps and fill in all the required fields e.g. Intent Schema and Sample Utterances:
5965

@@ -82,19 +88,19 @@ GetLuckyNumbers what are my lucky numbers lower than {UpperLimit}
8288
GetLuckyNumbers tell me my lucky numbers lower than {UpperLimit}
8389
```
8490

85-
![Skill Information](https://cloud.githubusercontent.com/assets/223045/21183279/83eec480-c207-11e6-841b-d8925f0804a5.png)
86-
![Interaction Model](https://cloud.githubusercontent.com/assets/223045/21183280/83ef3d84-c207-11e6-87a5-bb8dcbb903f8.png)
91+
![Skill Information](https://cloud.githubusercontent.com/assets/223045/21183279/83eec4c211e6-841b-d8925f0804a5.png)
92+
![Interaction Model](https://cloud.githubusercontent.com/assets/223045/21183280/83ef3dc211e6-87a5-bb8dcbb903f8.png)
8793

8894
Fill in the Lambda ARN which was printed or run `serverless info` to retrieve the ARN again.
8995

90-
![Configuration](https://cloud.githubusercontent.com/assets/223045/21183281/83f17086-c207-11e6-89b7-2f6d96ac559c.png)
96+
![Configuration](https://cloud.githubusercontent.com/assets/223045/21183281/83f170c211e6-89b7-2f6d96ac559c.png)
9197

9298
Next up visit the test page, fill in the utterance and click on `Ask LuckyNumbers`.
9399

94-
![Test](https://cloud.githubusercontent.com/assets/223045/21183283/83f1f632-c207-11e6-858d-41b1a3154e91.png)
95-
![Test](https://cloud.githubusercontent.com/assets/223045/21183282/83f1f628-c207-11e6-974e-b7c051ffb6eb.png)
96-
![Test](https://cloud.githubusercontent.com/assets/223045/21183284/83f708ac-c207-11e6-8199-9489e8f3e494.png)
97-
![Test](https://cloud.githubusercontent.com/assets/223045/21185805/78c1df06-c212-11e6-9cf9-ce44edc30cdd.gif)
100+
![Test](https://cloud.githubusercontent.com/assets/223045/21183283/83f1f6c211e6-858d-41b1a3154e91.png)
101+
![Test](https://cloud.githubusercontent.com/assets/223045/21183282/83f1f6c211e6-974e-b7c051ffb6eb.png)
102+
![Test](https://cloud.githubusercontent.com/assets/223045/21183284/83f708ac-c211e6-819489e8f3e494.png)
103+
![Test](https://cloud.githubusercontent.com/assets/223045/21185805/78c1dfc211e6-9cf9-ce44edc30cdd.gif)
98104

99105
You should have received a response containing the text `Your lucky number is` followed by your lucky number :)
100106

‎aws-node-auth0-cognito-custom-authorizers-api/README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
<!--
2-
title: API Gateway Authorizer Function for Auth0 or AWS Cognito using RS256 JSON Web Key Sets tokens.
3-
description: Authorize your API Gateway with either Auth0 or Cognito JWKS RS256 tokens.
2+
title: 'API Gateway Authorizer Function for Auth0 or AWS Cognito using RS256 JSON Web Key Sets tokens.'
3+
description: 'Authorize your API Gateway with either Auth0 or Cognito JWKS RS256 tokens.'
44
layout: Doc
5+
framework: v1
6+
platform: AWS
7+
language: nodeJS
8+
authorLink: 'https://github.com/shahzeb1'
9+
authorName: 'Shahzeb K.'
10+
authorAvatar: 'https://avatars2.githubusercontent.com/u/1383831?v=4&s=140'
511
-->
612
# API Gateway Authorizer Function for Auth0 or AWS Cognito using the [JWKS](https://auth0.com/docs/jwks) method.
713

‎aws-node-auth0-custom-authorizers-api/README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
<!--
2-
title: AWS API Gateway Custom Authorizer Function with Auth0 example in NodeJS
3-
description: This is an example of how to protect API endpoints with Auth0, JSON Web Tokens (jwt) and a custom authorizer lambda function.
2+
title: 'AWS API Gateway Custom Authorizer Function with Auth0 example in NodeJS'
3+
description: 'This is an example of how to protect API endpoints with Auth0, JSON Web Tokens (jwt) and a custom authorizer lambda function.'
44
layout: Doc
5+
framework: v1
6+
platform: AWS
7+
language: nodeJS
8+
authorLink: 'https://github.com/erezrokah'
9+
authorName: 'Erez Rokah'
10+
authorAvatar: 'https://avatars0.githubusercontent.com/u/26760571?v=4&s=140'
511
-->
612
# API Gateway Custom Authorizer Function + Auth0
713

‎aws-node-dynamodb-backup/README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,19 @@
1+
<!--
2+
title: TODO
3+
description: TODO
4+
layout: Doc
5+
framework: v1
6+
platform: AWS
7+
language: nodeJS
8+
authorLink: 'https://github.com/kaihendry'
9+
authorName: 'Kai Hendry'
10+
authorAvatar: 'https://avatars3.githubusercontent.com/u/765871?v=4&s=140'
11+
-->
112
# DynamoDB stream events to AWS S3
213

314
Which effectively creates a **backup of your dynamoDB table** assuming an event
415
was caught for every record. Hint: [Introduce a new field
5-
"backedup"](https://s.natalian.org/2017-06-22/rupdated.js) to effectively
16+
"backedup"](https://s.natalian.org/2022/rupdated.js) to effectively
617
trigger a backup.
718

819
NOTE: DynamoDB triggers need to be manually associated / setup with the lambda function.

‎aws-node-env-variables-encrypted-in-a-file/README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
<!--
2-
title: AWS Storing Encrypted Secrets example in NodeJS
3-
description: This example demonstrates how to store secrets like API keys encrypted in your repository while providing them as environment variables to your AWS Lambda functions.
2+
title: 'AWS Storing Encrypted Secrets example in NodeJS'
3+
description: 'This example demonstrates how to store secrets like API keys encrypted in your repository while providing them as environment variables to your AWS Lambda functions.'
44
layout: Doc
5+
framework: v1
6+
platform: AWS
7+
language: nodeJS
8+
authorLink: 'https://github.com/rupakg'
9+
authorName: 'Rupak Ganguly'
10+
authorAvatar: 'https://avatars0.githubusercontent.com/u/8188?v=4&s=140'
511
-->
612
# Serverless
713

‎aws-node-env-variables/README.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
<!--
2-
title: AWS Serverless Environment Variables Usage example in NodeJS
3-
description: This example demonstrates how to use environment variables for AWS Lambdas.
2+
title: 'AWS Serverless Environment Variables Usage example in NodeJS'
3+
description: 'This example demonstrates how to use environment variables for AWS Lambdas.'
44
layout: Doc
5+
framework: v1
6+
platform: AWS
7+
language: nodeJS
8+
authorLink: 'https://github.com/rupakg'
9+
authorName: 'Rupak Ganguly'
10+
authorAvatar: 'https://avatars0.githubusercontent.com/u/8188?v=4&s=140'
511
-->
612
# Serverless Environment Variables Usage
713

@@ -73,12 +79,12 @@ The expected result should be similar to:
7379
"body": "{\"message\":\"User created\"}"
7480
}
7581
--------------------------------------------------------------------
76-
START RequestId: 78b0785d-afd3-11e6-8582-a7abb1cd48ef Version: $LATEST
77-
2016-11-21 11:15:48.575 (+01:00) 78b0785d-afd3-11e6-8582-a7abb1cd48ef PASSWORD_ITERATIONS: 4096
78-
2016-11-21 11:15:48.576 (+01:00) 78b0785d-afd3-11e6-8582-a7abb1cd48ef PASSWORD_DERIVED_KEY_LENGTH: 256
79-
2016-11-21 11:15:48.576 (+01:00) 78b0785d-afd3-11e6-8582-a7abb1cd48ef EMAIL_SERVICE_API_KEY: KEYEXAMPLE1234
80-
END RequestId: 78b0785d-afd3-11e6-8582-a7abb1cd48ef
81-
REPORT RequestId: 78b0785d-afd3-11e6-8582-a7abb1cd48ef Duration: 3.36 ms Billed Duration: 100 ms Memory Size: 1024 MB Max Memory Used: 15 MB
82+
START RequestId: 78b0785d-afd3-11e6-85a7abb1cd48ef Version: $LATEST
83+
2021 11:15:48.575 (+01:00) 78b0785d-afd3-11e6-85a7abb1cd48ef PASSWORD_ITERATIONS: 4096
84+
2021 11:15:48.576 (+01:00) 78b0785d-afd3-11e6-85a7abb1cd48ef PASSWORD_DERIVED_KEY_LENGTH: 256
85+
2021 11:15:48.576 (+01:00) 78b0785d-afd3-11e6-85a7abb1cd48ef EMAIL_SERVICE_API_KEY: KEYEXAMPLE1234
86+
END RequestId: 78b0785d-afd3-11e6-85a7abb1cd48ef
87+
REPORT RequestId: 78b0785d-afd3-11e6-85a7abb1cd48ef Duration: 3.36 ms Billed Duration: 100 ms Memory Size: 1024 MB Max Memory Used: 15 MB
8288
```
8389

8490
```bash
@@ -93,10 +99,10 @@ The expected result should be similar to:
9399
"body": "{\"message\":\"Password sent.\"}"
94100
}
95101
--------------------------------------------------------------------
96-
START RequestId: 9cc33d72-afd3-11e6-b918-19a4e146bf3d Version: $LATEST
97-
2016-11-21 11:16:48.838 (+01:00) 9cc33d72-afd3-11e6-b918-19a4e146bf3d EMAIL_SERVICE_API_KEY: KEYEXAMPLE1234
98-
END RequestId: 9cc33d72-afd3-11e6-b918-19a4e146bf3d
99-
REPORT RequestId: 9cc33d72-afd3-11e6-b918-19a4e146bf3d Duration: 3.14 ms Billed Duration: 100 ms Memory Size: 1024 MB Max Memory Used: 15 MB
102+
START RequestId: 9cc33dafd3-11e6-b919a4e146bf3d Version: $LATEST
103+
2021 11:16:48.838 (+01:00) 9cc33dafd3-11e6-b919a4e146bf3d EMAIL_SERVICE_API_KEY: KEYEXAMPLE1234
104+
END RequestId: 9cc33dafd3-11e6-b919a4e146bf3d
105+
REPORT RequestId: 9cc33dafd3-11e6-b919a4e146bf3d Duration: 3.14 ms Billed Duration: 100 ms Memory Size: 1024 MB Max Memory Used: 15 MB
100106
```
101107

102108
Especially helpful for local development you can also invoke the Lambda locally and see the resulting log via

‎aws-node-fetch-file-and-store-in-s3/README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
<!--
2-
title: AWS Fetch image from URL and upload to S3 example in NodeJS
3-
description: This example display how to fetch an image from remote source (URL) and then upload this image to a S3 bucket.
2+
title: 'AWS Fetch image from URL and upload to S3 example in NodeJS'
3+
description: 'This example display how to fetch an image from remote source (URL) and then upload this image to a S3 bucket.'
44
layout: Doc
5+
framework: v1
6+
platform: AWS
7+
language: nodeJS
8+
authorLink: 'https://github.com/ScottBrenner'
9+
authorName: 'Scott Brenner'
10+
authorAvatar: 'https://avatars2.githubusercontent.com/u/416477?v=4&s=140'
511
-->
612
# Fetch image from URL then upload to s3 Example
713

@@ -89,9 +95,9 @@ The expected result should be similar to:
8995
```bash
9096
"Saved"
9197
--------------------------------------------------------------------
92-
START RequestId: c658859d-bd42-11e6-ac1f-c7a7ee5bd7f3 Version: $LATEST
93-
END RequestId: c658859d-bd42-11e6-ac1f-c7a7ee5bd7f3
94-
REPORT RequestId: c658859d-bd42-11e6-ac1f-c7a7ee5bd7f3 Duration: 436.94 ms Billed Duration: 500 ms Memory Size: 1024 MB Max Memory Used: 29 MB
98+
START RequestId: c658859d-bd11e6-ac1f-c7a7ee5bd7f3 Version: $LATEST
99+
END RequestId: c658859d-bd11e6-ac1f-c7a7ee5bd7f3
100+
REPORT RequestId: c658859d-bd11e6-ac1f-c7a7ee5bd7f3 Duration: 436.94 ms Billed Duration: 500 ms Memory Size: 1024 MB Max Memory Used: 29 MB
95101
```
96102

97103
## Scaling

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy