安装 Amazon SAM CLI - Amazon Serverless Application Model
安装 Amazon SAM CLI排查 安装错误后续步骤
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

安装 Amazon SAM CLI

在支持的操作系统上安装最新版本的 Amazon Serverless Application Model 命令行界面 (Amazon SAMCLI)。

有关管理当前安装版本的信息 Amazon SAMCLI，包括如何升级、卸载或管理夜间版本，请参阅管理 Amazon SAM CLI 版本。

这是您第一次安装 Amazon SAM CLI？

在继续操作之前，请完成上一节中的所有先决条件。这包括：

  1. 注册一个 Amazon 账户。

  2. 创建管理 IAM 用户。

  3. 创建访问密钥 ID 和秘密访问密钥。

  4. 正在安装 Amazon CLI.

  5. 配置 Amazon 凭证。

主题

安装 Amazon SAM CLI

注意

从 2023 年 9 月起， Amazon 将不再维护 Amazon SAMCLI (aws/tap/aws-sam-cli) 的 Amazon 托管Homebrew安装程序。如果您Homebrew使用安装和管理 Amazon SAMCLI，请参阅以下选项：

要安装 Amazon SAMCLI，请按照操作系统的说明进行操作。

arm64 - command line installer

  1. 将 Amazon SAM CLI .zip 文件下载到所选目录。

  2. （可选）您可以在安装前验证安装程序的完整性。有关说明，请参阅可选：验证 Amazon SAMCLI安装程序的完整性。

  3. 将安装文件解压缩到您选择的目录中。以下是使用 sam-installation 子目录的示例。

    注意

    如果您的操作系统没有内置的 unzip 命令，请使用等效命令。

    $ unzip aws-sam-cli-linux-arm64.zip -d sam-installation

  4. 通过运行 install 可执行文件安装 Amazon SAM CLI。该可执行文件位于上一步骤中使用的目录中。以下是使用 sam-installation 子目录的示例：

    $ sudo ./sam-installation/install

  5. 验证安装。

    $ sam --version

    要确认安装成功，您应该会看到如下所示的输出，但其中用最新的 SAM CLI 版本替换了方括号内的文本：

     SAM CLI, <latest version>
x86_64 - command line installer

  1. 将 Amazon SAM CLI .zip 文件下载到所选目录。

  2. （可选）您可以在安装前验证安装程序的完整性。有关说明，请参阅可选：验证 Amazon SAMCLI安装程序的完整性。

  3. 将安装文件解压缩到您选择的目录中。以下是使用 sam-installation 子目录的示例。

    注意

    如果您的操作系统没有内置的 unzip 命令，请使用等效命令。

    $ unzip aws-sam-cli-linux-x86_64.zip -d sam-installation

  4. 通过运行 install 可执行文件安装 Amazon SAM CLI。该可执行文件位于上一步骤中使用的目录中。以下是使用 sam-installation 子目录的示例：

    $ sudo ./sam-installation/install

  5. 验证安装。

    $ sam --version

    要确认安装成功，您应该会看到一个输出，该输出将以下方括号内的文本替换为最新的可用版本：

     SAM CLI, <latest version>

安装步骤

使用软件包安装程序安装 Amazon SAMCLI。此外，软件包安装程序有两种安装方法可供选择：GUI 和命令行。您可以为所有用户安装，也可以只为当前用户安装。要为所有用户安装，需要获得超级用户授权。

GUI - All users
要下载软件包安装程序并安装 Amazon SAMCLI
注意

如果您之前通过 Homebrew 或 pip 安装了 Amazon SAM CLI，则需要先将其卸载。有关说明，请参阅卸载 Amazon SAM CLI。

  1. 将 macOS 下载pkg到你选择的目录中：

    注意

    在安装之前，您可以选择验证安装程序的完整性。有关说明，请参阅可选：验证 Amazon SAMCLI安装程序的完整性。

  2. 运行您下载的文件，然后按照屏幕上的说明继续完成简介、自述和许可步骤。

  3. 在目标选择中，选择为这台计算机的所有用户安装。

  4. 在安装类型中，选择 Amazon SAM CLI 要安装的位置，然后按下安装。推荐的默认位置是 /usr/local/aws-sam-cli。

    注意

    要使用 sam 命令调用 Amazon SAM CLI，安装程序会自动在 /usr/local/bin/sam 和 /usr/local/aws-sam-cli/sam 或您选择的安装文件夹之间创建符号链接。

  5. Amazon SAM CLI 将进行安装，系统将显示安装成功消息。按下关闭。

验证安装是否成功

  • 通过运行以下命令验证 Amazon SAM CLI 是否已正确安装以及符号链接是否已配置：

    $ which sam
/usr/local/bin/sam
$ sam --version
SAM CLI, <latest version>
GUI - Current user
要下载并安装 Amazon SAMCLI
注意

如果您之前通过 Homebrew 或 pip 安装了 Amazon SAM CLI，则需要先将其卸载。有关说明，请参阅卸载 Amazon SAM CLI。

  1. 将 macOS 下载pkg到你选择的目录中：

    注意

    在安装之前，您可以选择验证安装程序的完整性。有关说明，请参阅可选：验证 Amazon SAMCLI安装程序的完整性。

  2. 运行您下载的文件，然后按照屏幕上的说明继续完成简介、自述和许可步骤。

  3. 对于目标选择，选择仅为我安装。如果没有看到此选项，请转到下一步。

  4. 对于安装类型，请执行以下操作：

    1. 选择 Amazon SAM CLI 要安装的位置。默认位置是 /usr/local/aws-sam-cli。选择您拥有写入权限的位置。要更改安装位置，请选择本地并选择您的位置。完成后按下继续。

    2. 如果您在上一步中没有看到仅为我安装的选项，请选择更改安装位置 > 仅为我安装，然后按下继续。

    3. 按下安装。

  5. Amazon SAM CLI 将进行安装，系统将显示安装成功消息。按下关闭。

要创建符号链接

  • 要使用 sam 命令调用 Amazon SAM CLI，您必须在 Amazon SAM CLI 程序和您的 $PATH 之间手动创建符号链接。通过修改并运行以下命令来创建符号链接：

    $ sudo ln -s /path-to/aws-sam-cli/sam /path-to-symlink-directory/sam

    • sudo – 如果您的用户具有 $PATH 写入权限，则无需 sudo。否则，sudo 是必需的。

    • path-to – Amazon SAM CLI 程序安装位置的路径。例如，/Users/myUser/Desktop。

    • path-to-symlink-directory— 您的$PATH环境变量。默认位置是 /usr/local/bin。

验证安装是否成功

  • 通过运行以下命令验证 Amazon SAM CLI 是否已正确安装以及符号链接是否已配置：

    $ which sam
/usr/local/bin/sam
$ sam --version
SAM CLI, <latest version>
Command line - All users
要下载并安装 Amazon SAMCLI
注意

如果您之前通过 Homebrew 或 pip 安装了 Amazon SAM CLI，则需要先将其卸载。有关说明，请参阅卸载 Amazon SAM CLI。

  1. 将 macOS 下载pkg到你选择的目录中：

    注意

    在安装之前，您可以选择验证安装程序的完整性。有关说明，请参阅可选：验证 Amazon SAMCLI安装程序的完整性。

  2. 修改并运行安装脚本：

    $ sudo installer -pkg path-to-pkg-installer/name-of-pkg-installer -target /
installer: Package name is AWS SAM CLI
installer: Upgrading at base path /
installer: The upgrade was successful.
    注意

    要使用 sam 命令调用 Amazon SAM CLI，安装程序会自动在 /usr/local/bin/sam 和 /usr/local/aws-sam-cli/sam 之间创建符号链接。

验证安装是否成功

  • 通过运行以下命令验证 Amazon SAM CLI 是否已正确安装以及符号链接是否已配置：

    $ which sam
/usr/local/bin/sam
$ sam --version
SAM CLI, <latest version>
Command line - Current user
要下载并安装 Amazon SAMCLI
注意

如果您之前通过 Homebrew 或 pip 安装了 Amazon SAM CLI，则需要先将其卸载。有关说明，请参阅卸载 Amazon SAM CLI。

  1. 将 macOS 下载pkg到你选择的目录中：

    注意

    在安装之前，您可以选择验证安装程序的完整性。有关说明，请参阅可选：验证 Amazon SAMCLI安装程序的完整性。

  2. 确定您有写入权限的安装目录。然后，使用模板创建 xml 文件并对其进行修改以反映您的安装目录。目录必须已经存在。

    例如，如果path-to-my-directory替换为/Users/myUser/Desktop，则aws-sam-cli程序文件夹将安装在那里。

    <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
  <array>
    <dict>
      <key>choiceAttribute</key>
      <string>customLocation</string>
      <key>attributeSetting</key>
      <string>path-to-my-directory</string>
      <key>choiceIdentifier</key>
      <string>default</string>
    </dict>
  </array>
</plist>

  3. 保存 xml 文件并通过运行以下命令验证其是否有效：

    $ installer -pkg path-to-pkg-installer \
-target CurrentUserHomeDirectory \
-showChoicesAfterApplyingChangesXML path-to-your-xml-file

    输出应显示将应用于 Amazon SAM CLI 程序的首选项。

  4. 运行以下命令来安装 Amazon SAMCLI：

    $ installer -pkg path-to-pkg-installer \
-target CurrentUserHomeDirectory \
-applyChoiceChangesXML path-to-your-xml-file

# Example output
installer: Package name is AWS SAM CLI
installer: choices changes file 'path-to-your-xml-file' applied
installer: Upgrading at base path base-path-of-xml-file
installer: The upgrade was successful.
要创建符号链接

  • 要使用 sam 命令调用 Amazon SAM CLI，您必须在 Amazon SAM CLI 程序和您的 $PATH 之间手动创建符号链接。通过修改并运行以下命令来创建符号链接：

    $ sudo ln -s /path-to/aws-sam-cli/sam /path-to-symlink-directory/sam

    • sudo – 如果您的用户具有 $PATH 写入权限，则无需 sudo。否则，sudo 是必需的。

    • path-to – Amazon SAM CLI 程序安装位置的路径。例如，/Users/myUser/Desktop。

    • path-to-symlink-directory— 您的$PATH环境变量。默认位置是 /usr/local/bin。

验证安装是否成功

  • 通过运行以下命令验证 Amazon SAM CLI 是否已正确安装以及符号链接是否已配置：

    $ which sam
/usr/local/bin/sam
$ sam --version
SAM CLI, <latest version>

Windows 安装程序 (MSI) 文件是 Windows 操作系统的软件包安装程序文件。

按照以下步骤使用 MSI 文件安装 Amazon SAM CLI。

  1. 下载 Amazon SAM CLI 64 位版本。

    注意

    如果您使用的是 32 位版本的 Windows，请参阅 在 32 位 Windows 上安装 Amazon SAM CLI。

  2. （可选）您可以在安装前验证安装程序的完整性。有关说明，请参阅可选：验证 Amazon SAMCLI安装程序的完整性。

  3. 验证安装。

    安装完成后，打开新的命令提示符或 PowerShell 提示符进行验证。您应该能够从命令行调用 sam。

    sam --version

    成功安装后 Amazon SAMCLI，您应该会看到如下输出：

    SAM CLI, <latest version>

  4. 启用长路径（仅限 Windows 10 及更高版本）。

    重要

    Amazon SAMCLI可能会与超过 Windows 最大路径限制的文件路径进行交互。sam init由于 Windows 10 的MAX_PATH限制，这可能会在运行时导致错误。若要解决此问题，必须配置新的长路径行为。

    要启用长路径，请参阅 Microsoft Windows 应用程序开发文档中的在 Windows 10 版本 1607 及更高版本中启用长路径。

  5. 安装 Git。

    要使用 sam init 命令下载示例应用程序，还必须安装 Git。有关说明，请参见安装 Git。

排查 安装错误

Linux

Docker 错误：“无法连接到 Docker 进程守护程序。Docker 进程守护程序是否在此主机上运行？”

在某些情况下，要为 ec2-user 提供访问 Docker 进程守护程序的权限，您可能需要重新启动实例。如果您收到此错误，请尝试重启实例。

Shell 错误：“找不到命令”

如果您收到此错误，则表示 Shell 无法在路径中找到 Amazon SAM CLI 可执行文件。验证 Amazon SAM CLI 可执行文件安装目录的位置，然后验证该目录是否位于路径中。

Amazon SAMCLI错误：“/lib64/libc.so.6：找不到 `GLIBC_2.14'版本（/usr/local/ /dist/libz.so.1 要求）” aws-sam-cli

如果您收到此错误，则表示您使用的是不受支持的 Linux 版本，并且内置的 glibc 版本已过时。请尝试以下任一方法：

  • 将您的 Linux 主机升级到最新的 64 位 CentOS、Fedora、Ubuntu 或 Amazon Linux 2 发行版。

  • 按照 安装 Amazon SAM CLI 的说明进行操作。

macOS

安装失败

Amazon SAM CLI 安装程序的映像，其中显示安装失败消息

如果您是在为用户安装 Amazon SAM CLI，并且选择了您没有写入权限的安装目录，则可能会出现此错误。请尝试以下任一方法：

  1. 选择您具有写入权限的其他安装目录。

  2. 删除安装程序。然后重新下载并运行安装程序。

后续步骤

要了解有关 Amazon SAM CLI 的更多信息并开始构建自己的无服务器应用程序，请参阅以下内容：