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

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

正在安装 Amazon SAMCLI

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

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

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

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

  1. 注册 Amazon 账户。

  2. 创建管理 IAM 用户。

  3. 创建访问密钥 ID 和私有访问密钥。

  4. 正在安装Amazon CLI.

  5. 配置Amazon凭证。

正在安装 Amazon SAMCLI

注意

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

  • 要继续使用Homebrew，您可以使用社区管理的安装程序。有关更多信息，请参阅管理 wit Amazon SAMCLI h Homebrew：

  • 我们建议使用本页中记录的第一方安装方法之一。在使用其中一种方法之前，请参阅切换自 Homebrew。

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

x86_64 - command line installer

  1. 将 Amazon SAMCLI.zip 文件下载到您选择的目录中。

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

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

    注意

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

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

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

    $ sudo ./sam-installation/install

  5. 验证安装。

    $ sam --version

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

     SAM CLI, version 1.94.0
ARM - command line installer
要安装 Amazon SAMCLI

我们建议将安装Amazon SAMCLI到虚拟环境中。这样可以确保故障排除时有一个干净的启动环境和隔离的环境。

安装完成后 Amazon SAMCLI，您可以为创建别名Amazon SAMCLI。这样，您就可以在虚拟环境之Amazon SAMCLI外使用虚拟环境。

为配置别名 Amazon SAMCLI

  1. 获取您安装的虚拟环境的完整路径。Amazon SAM CLI以下是示例：

    (venv)$ pwd
/home/ec2-user/sam-cli

  2. 创建您的别名。

    $ echo 'alias sam="virtual-environment-directory/venv/bin/sam"' >> ~/.bashrc
$ source ~/.bashrc

    以下是示例：

    $ echo 'alias sam="/home/ec2-user/sam-cli/venv/bin/sam"' >> ~/.bashrc
$ source ~/.bashrc

  3. 验证您的别名。

    $ sam --version
SAM CLI, version 1.94.0
$ which sam
alias sam='/home/ec2-user/sam-cli/venv/bin/sam'
        ~/sam-cli/venv/bin/sam

Amazon SAMCLI使用其软件包安装程序进行安装。

使用软件包安装程序

软件包安装程序有两种安装方法可供选择：

  1. GUI

  2. Command line

您可以为所有用户安装，也可以只为当前用户安装。要为所有用户安装，需要获得超级用户授权。

安装步骤

Amazon SAMCLI使用以下任一选项进行安装。

GUI - All users
下载软件包安装程序
注意

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

验证软件包安装程序（可选）
要安装 Amazon SAMCLI

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

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

  3. 在 “安装类型” 中，选择Amazon SAMCLI要安装的位置，然后按 “安装”。推荐的默认位置是/usr/local/aws-sam-cli。

    注意

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

  4. Amazon SAMCLI将显示 “将安装” 和 “安装成功” 消息。按关闭。

验证安装是否成功

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

    $ which sam
/usr/local/bin/sam
$ sam --version
SAM CLI, version 1.94.0
GUI - Current user
下载软件包安装程序
注意

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

验证软件包安装程序（可选）
要安装 Amazon SAMCLI

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

  2. 在 “目标选择” 中，选择 “仅为我安装”。如果您没有看到此选项，请转到下一步。

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

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

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

    3. 按安装。

  4. Amazon SAMCLI将显示 “将安装” 和 “安装成功” 消息。按关闭。

创建符号链接

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

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

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

    • path-t o — 程序安装位置的Amazon SAMCLI路径。例如，/Users/myUser/Desktop。

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

验证安装是否成功

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

    $ which sam
/usr/local/bin/sam
$ sam --version
SAM CLI, version 1.94.0
Command line - All users
下载软件包安装程序
注意

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

验证软件包安装程序（可选）
要安装 Amazon SAMCLI

  • 修改并运行安装脚本：

    $ 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.
    注意

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

验证安装是否成功

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

    $ which sam
/usr/local/bin/sam
$ sam --version
SAM CLI, version 1.94.0
Command line - Current user
下载软件包安装程序
注意

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

验证软件包安装程序（可选）
要安装 Amazon SAMCLI

  1. 确定您有写入权限的安装目录。然后，使用模板创建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>

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

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

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

  3. 运行以下命令来安装 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.
创建符号链接

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

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

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

    • path-t o — 程序安装位置的Amazon SAMCLI路径。例如，/Users/myUser/Desktop。

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

验证安装是否成功

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

    $ which sam
/usr/local/bin/sam
$ sam --version
SAM CLI, version 1.94.0

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

按照以下步骤Amazon SAMCLI使用 MSI 文件进行安装。

  1. 下载 Amazon SAM CLI 64 位。

    注意

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

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

  3. 验证安装。

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

    sam --version

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

    SAM CLI, version 1.94.0

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

    重要

    Amazon SAMCLI应用程序模板存储库包含一些长文件路径，sam init由于Windows 10的MAX_PATH限制，这些路径在运行时可能会导致错误。要解决此问题，必须配置新的长路径行为。

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

  5. 安装 Git。

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

问题排查

如果您在安装时遇到问题 Amazon SAMCLI，请参阅安装错误。

后续步骤

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