Skip to content

Commit 6645b65

Browse files
committed
Fix typos, add author
1 parent 7fbc426 commit 6645b65

File tree

2 files changed

+35
-33
lines changed

2 files changed

+35
-33
lines changed

apigw-rest-api-lambda-python/README.md

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This project contains source code and supporting files for a serverless applicat
66
- events - Invocation events that you can use to invoke the function.
77
- template.yaml - A template that defines the application's AWS resources.
88

9-
The application uses several AWS resources, including Lambda functions and an API Gateway API. These resources are defined in the `template.yaml` file in this project. You can update the template to add AWS resources through the same deployment process that updates your application code.
9+
The application uses several AWS resources. These resources are defined in the `template.yaml` file in this project. You can update the template to add AWS resources through the same deployment process that updates your application code. This application will deploy a Lambda function, as well as an API Gateway REST API that will be automatically created based on the Lambda function's Event mapping.
1010

1111
If you prefer to use an integrated development environment (IDE) to build and test your application, you can use the AWS Toolkit.
1212
The AWS Toolkit is an open source plug-in for popular IDEs that uses the AWS SAM CLI to build and deploy serverless applications on AWS. The AWS Toolkit also adds a simplified step-through debugging experience for Lambda function code. See the following links to get started.
@@ -29,38 +29,36 @@ The Serverless Application Model Command Line Interface (SAM CLI) is an extensio
2929

3030
To use the AWS SAM CLI, you need the following tools.
3131

32+
### Requirements
33+
3234
* AWS SAM CLI - [Install the SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html)
3335
* [Python 3 installed](https://www.python.org/downloads/)
3436
* Docker - [Install Docker community edition](https://hub.docker.com/search/?type=edition&offering=community)
3537

3638
To build and deploy your application for the first time, run the following in your shell:
3739

3840
```bash
39-
sam build --use-container
40-
sam deploy --guided
41+
$ cd apig-rest-api-lambda-python
42+
$ sam build --use-container
43+
$ sam deploy --guided
4144
```
4245

4346
The first command will build the source of your application. The second command will package and deploy your application to AWS, with a series of prompts:
4447

4548
* **Stack Name**: The name of the stack to deploy to CloudFormation. This should be unique to your account and region, and a good starting point would be something matching your project name.
4649
* **AWS Region**: The AWS region you want to deploy your app to.
4750
* **Confirm changes before deploy**: If set to yes, any change sets will be shown to you before execution for manual review. If set to no, the AWS SAM CLI will automatically deploy application changes.
51+
* **HelloWorldFunction has no authentication. Is this okay? [y/N]:**: Select `y` for the purposes of this sample application. As a result, anyone will be able to call this example REST API without any form of authentication. For production applications, you should [enable authentication for the API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-control-access-to-api.html) using one of several available options and [follow the API Gateway security best practices](https://docs.aws.amazon.com/apigateway/latest/developerguide/security-best-practices.html). If `N` is selected for this question, this deployment will not succeed.
4852
* **Allow AWS SAM CLI IAM role creation**: Many AWS SAM templates, including this example, create AWS IAM roles required for the AWS Lambda function(s) included to access AWS services. By default, these are scoped down to minimum required permissions. To deploy an AWS CloudFormation stack which creates or modifies IAM roles, the `CAPABILITY_IAM` value for `capabilities` must be provided. If permission isn't provided through this prompt, to deploy this example you must explicitly pass `--capabilities CAPABILITY_IAM` to the `sam deploy` command.
4953
* **Save arguments to samconfig.toml**: If set to yes, your choices will be saved to a configuration file inside the project, so that in the future you can just re-run `sam deploy` without parameters to deploy changes to your application.
5054

5155
You can find your API Gateway Endpoint URL in the output values displayed after deployment.
5256

53-
## Use the AWS SAM CLI to build and test locally
54-
55-
Build your application with the `sam build --use-container` command.
56-
57-
```bash
58-
$ sam build --use-container
59-
```
57+
## Use the AWS SAM CLI to test locally
6058

61-
The SAM CLI installs dependencies defined in `hello_world/requirements.txt`, creates a deployment package, and saves it in the `.aws-sam/build` folder.
59+
The SAM CLI installs dependencies defined in `hello_world/package.json`, creates a deployment package, and saves it in the `.aws-sam/build` folder.
6260

63-
Test a single function by invoking it directly with a test event. An event is a JSON document that represents the input that the function receives from the event source. Test events are included in the `events` folder in this project.
61+
Ypu can test a single function by invoking it directly with a test event. An event is a JSON document that represents the input that the function receives from the event source. Test events are included in the `events` folder in this project.
6462

6563
Run functions locally and invoke them with the `sam local invoke` command.
6664

@@ -75,7 +73,7 @@ $ sam local start-api
7573
$ curl http://localhost:3000/
7674
```
7775

78-
The AWS SAM CLI reads the application template to determine the API's routes and the functions that they invoke. The `Events` property on each function's definition includes the route and method for each path.
76+
The AWS SAM CLI reads the application template to determine the API's routes and the functions they invoke. The `Events` property on each function's definition includes the route and method for each path.
7977

8078
```yaml
8179
Events:
@@ -86,11 +84,18 @@ The AWS SAM CLI reads the application template to determine the API's routes and
8684
Method: get
8785
```
8886
89-
## Add a resource to your application
90-
The application template uses AWS Serverless Application Model (AWS SAM) to define application resources. AWS SAM is an extension of AWS CloudFormation with a simpler syntax for configuring common serverless application resources such as functions, triggers, and APIs. For resources not included in [the AWS SAM specification](https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md), you can use standard [AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) resource types.
87+
## Use the AWS SAM CLI to test remotely
88+
After you have deployed your application, you can remotely invoke your Lambda function to test it in the cloud.
9189
92-
## Fetch, tail, and filter Lambda function logs
90+
Invoke functions remotely with the `sam remote invoke` command.
91+
92+
```bash
93+
$ sam remote invoke HelloWorldFunction --event-file events/event.json
94+
```
9395

96+
You can also go to the API Gateway endpoint URL that was output after the deployment of your application, which will similarly invoke your deployed Lambda function.
97+
98+
## Fetch, tail, and filter Lambda function logs
9499
To simplify troubleshooting, AWS SAM CLI has a command called `sam logs`. `sam logs` lets you fetch logs generated by your deployed Lambda function from the command line. In addition to printing the logs on the terminal, this command has several nifty features to help you quickly find the bug.
95100

96101
`NOTE`: This command works for all AWS Lambda functions; not just the ones you deploy using AWS SAM.
@@ -107,11 +112,9 @@ You can find more information and examples about filtering Lambda function logs
107112
To delete the sample application that you created, use the AWS CLI. Assuming you used your project name for the stack name, you can run the following:
108113

109114
```bash
110-
sam delete --stack-name "YOUR_STACK_NAME_HERE"
115+
$ sam delete
111116
```
112117

113118
## Resources
114119

115-
See the [AWS SAM developer guide](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/what-is-sam.html) for an introduction to SAM specification, the SAM CLI, and serverless application concepts.
116-
117-
Next, you can use AWS Serverless Application Repository to deploy ready to use Apps that go beyond hello world samples and learn how authors developed their applications: [AWS Serverless Application Repository main page](https://aws.amazon.com/serverless/serverlessrepo/)
120+
See the [AWS SAM developer guide](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/what-is-sam.html) for an introduction to SAM specification, the SAM CLI, and serverless application concepts.

apigw-rest-api-lambda-python/example-pattern.json

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@
1313
},
1414
"gitHub": {
1515
"template": {
16-
"repoURL": "https://github.com/aws-samples/serverless-patterns/tree/main/apig-rest-api-lambda-python",
17-
"templateURL": "serverless-patterns/apig-rest-api-lambda-python",
18-
"projectFolder": "apig-rest-api-lambda-python",
16+
"repoURL": "https://github.com/aws-samples/serverless-patterns/tree/main/apigw-rest-api-lambda-python",
17+
"templateURL": "serverless-patterns/apigw-rest-api-lambda-python",
18+
"projectFolder": "apigw-rest-api-lambda-python",
1919
"templateFile": "template.yaml"
2020
}
2121
},
@@ -46,13 +46,12 @@
4646
"Delete the application: <code>sam delete</code>."
4747
]
4848
},
49-
"authors": [
50-
{
51-
"name": "Your name",
52-
"image": "link-to-your-photo.jpg",
53-
"bio": "Your bio.",
54-
"linkedin": "linked-in-ID",
55-
"twitter": "twitter-handle"
56-
}
57-
]
58-
}
49+
"authors": [
50+
{
51+
"name": "Seshu Brahma",
52+
"image": "https://i.postimg.cc/ZR0MyrTN/seshub-photo.jpg",
53+
"bio": "SDE II, Lambda, AWS",
54+
"linkedin": "seshu-brahma"
55+
}
56+
]
57+
}

0 commit comments

Comments
 (0)