|
| 1 | +--- |
| 2 | +title: AWS SAM CLI |
| 3 | + |
| 4 | +author_primary: Jason Andrews |
| 5 | +minutes_to_complete: 15 |
| 6 | + |
| 7 | +official_docs: https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/what-is-sam.html |
| 8 | + |
| 9 | +additional_search_terms: |
| 10 | +- AWS |
| 11 | +- Lambda |
| 12 | + |
| 13 | +layout: installtoolsall |
| 14 | +multi_install: false |
| 15 | +multitool_install_part: false |
| 16 | +test_maintenance: false |
| 17 | +tool_install: true |
| 18 | +weight: 1 |
| 19 | +--- |
| 20 | + |
| 21 | +The Amazon Web Services (AWS) Serverless Application Model (SAM) CLI is an open-source command-line tool that you can use to build, test, and deploy serverless applications. The SAM CLI provides a Lambda-like execution environment that lets you locally build, test and debug applications defined by AWS SAM templates. It is available for a variety of operating systems and Linux distributions, and supports the Arm architecture. |
| 22 | + |
| 23 | +## Before you begin |
| 24 | + |
| 25 | +Follow the instructions below to install and try the latest version of the AWS SAM CLI for Ubuntu on Arm. |
| 26 | + |
| 27 | +Confirm you are using an Arm machine by running: |
| 28 | + |
| 29 | +```bash { target="ubuntu:latest" } |
| 30 | +uname -m |
| 31 | +``` |
| 32 | + |
| 33 | +The output should be: |
| 34 | + |
| 35 | +```output |
| 36 | +aarch64 |
| 37 | +``` |
| 38 | + |
| 39 | +If you see a different result, you are not using an Arm-based computer running 64-bit Linux. |
| 40 | + |
| 41 | +Running the AWS SAM CLI requires Docker. Refer to the [Docker](/install-guides/docker/) Install Guide for installation instructions. Confirm Docker is running before installing the SAM CLI. |
| 42 | + |
| 43 | +Python and Python pip are also required to run the SAM CLI example. |
| 44 | + |
| 45 | +To install, run the following command: |
| 46 | + |
| 47 | +```console |
| 48 | +sudo apt install python-is-python3 python3-pip -y |
| 49 | +``` |
| 50 | + |
| 51 | +## Download and install the AWS SAM CLI |
| 52 | + |
| 53 | +There are two options to install the SAM CLI, you can select your preferred method: |
| 54 | + |
| 55 | +* From a zip file. |
| 56 | +* Using the Python `pip` command. |
| 57 | + |
| 58 | +### Download and install from zip file |
| 59 | + |
| 60 | +Use `wget`: |
| 61 | + |
| 62 | +```bash |
| 63 | +wget https://github.com/aws/aws-sam-cli/releases/latest/download/aws-sam-cli-linux-arm64.zip |
| 64 | +unzip aws-sam-cli-linux-arm64.zip -d sam-install |
| 65 | +sudo ./sam-install/install |
| 66 | +``` |
| 67 | + |
| 68 | +### Install the SAM CLI using Python pip |
| 69 | + |
| 70 | +``` |
| 71 | +sudo apt install python3-venv -y |
| 72 | +python -m venv .venv |
| 73 | +source .venv/bin/activate |
| 74 | +pip install aws-sam-cli |
| 75 | +``` |
| 76 | + |
| 77 | +### Confirm that the SAM CLI has been installed |
| 78 | + |
| 79 | +```bash |
| 80 | +sam --version |
| 81 | +``` |
| 82 | + |
| 83 | +The version should be printed on screen: |
| 84 | + |
| 85 | +```output |
| 86 | +SAM CLI, version 1.125.0 |
| 87 | +``` |
| 88 | + |
| 89 | +## Example application |
| 90 | + |
| 91 | +You can use the AWS SAM CLI to build and deploy a simple "Hello World" serverless application that includes the line `uname -m` to check the platform it is running on, by following these steps. |
| 92 | + |
| 93 | +1. Create the project |
| 94 | + |
| 95 | +Use the code below, adjusting the runtime argument if you have a different version of Python: |
| 96 | + |
| 97 | +```console |
| 98 | +sam init --runtime python3.12 --architecture arm64 --dependency-manager pip --app-template hello-world --name uname-app --no-interactive |
| 99 | +``` |
| 100 | + |
| 101 | +2. Change to the new directory: |
| 102 | + |
| 103 | +```console |
| 104 | +cd uname-app |
| 105 | +``` |
| 106 | + |
| 107 | +3. Modify the `hello_world/app.py` file to include the command `uname -m` |
| 108 | + |
| 109 | +Use a text editor to replace the contents of the `hello_world/app.py` file with the code below: |
| 110 | + |
| 111 | +```python |
| 112 | +import json |
| 113 | +import os |
| 114 | + |
| 115 | +def lambda_handler(event, context): |
| 116 | + """Sample pure Lambda function |
| 117 | +
|
| 118 | + Parameters |
| 119 | + ---------- |
| 120 | + event: dict, required |
| 121 | + API Gateway Lambda Proxy Input Format |
| 122 | +
|
| 123 | + Event doc: https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html#api-gateway-simple-proxy-for-lambda-input-format |
| 124 | +
|
| 125 | + context: object, required |
| 126 | + Lambda Context runtime methods and attributes |
| 127 | +
|
| 128 | + Context doc: https://docs.aws.amazon.com/lambda/latest/dg/python-context-object.html |
| 129 | +
|
| 130 | + Returns |
| 131 | + ------ |
| 132 | + API Gateway Lambda Proxy Output Format: dict |
| 133 | +
|
| 134 | + Return doc: https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html |
| 135 | + """ |
| 136 | + |
| 137 | + ret = os.popen('uname -m').read() |
| 138 | + |
| 139 | + return { |
| 140 | + "statusCode": 200, |
| 141 | + "body": json.dumps({ |
| 142 | + "message": ret, |
| 143 | + # "location": ip.text.replace("\n", "") |
| 144 | + }), |
| 145 | + } |
| 146 | +``` |
| 147 | + |
| 148 | +4. Build the application: |
| 149 | + |
| 150 | +```console |
| 151 | +sam build |
| 152 | +``` |
| 153 | + |
| 154 | +5. Test the deployed application: |
| 155 | + |
| 156 | +```console |
| 157 | +sam local invoke "HelloWorldFunction" -e events/event.json |
| 158 | +``` |
| 159 | + |
| 160 | +The output below shows the results from the command `uname -m` and the value of `aarch64` confirms an Arm Linux computer: |
| 161 | + |
| 162 | +```output |
| 163 | +Invoking app.lambda_handler (python3.12) |
| 164 | +Local image was not found. |
| 165 | +Removing rapid images for repo public.ecr.aws/sam/emulation-python3.12 |
| 166 | +Building image........................................................................................................................ |
| 167 | +Using local image: public.ecr.aws/lambda/python:3.12-rapid-arm64. |
| 168 | + |
| 169 | +Mounting /home/ubuntu/uname-app/.aws-sam/build/HelloWorldFunction as /var/task:ro,delegated, inside runtime container |
| 170 | +START RequestId: 7221da4d-346d-4e2e-831e-dcde1cb47b5b Version: $LATEST |
| 171 | +END RequestId: 513dbd6f-7fc0-4212-ae13-a9a4ce2f21f4 |
| 172 | +REPORT RequestId: 513dbd6f-7fc0-4212-ae13-a9a4ce2f21f4 Init Duration: 0.26 ms Duration: 84.22 ms Billed Duration: 85 ms Memory Size: 128 MB Max Memory Used: 128 MB |
| 173 | +{"statusCode": 200, "body": "{\"message\": \"aarch64\\n\"}"} |
| 174 | +``` |
| 175 | + |
| 176 | +You are ready to use the AWS SAM CLI to build more complex functions and deploy them into AWS. Make sure to select `arm64` as the architecture for your Lambda functions. |
| 177 | + |
0 commit comments