安装 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 SAM CLI 版本，包括如何升级、卸载或管理夜间版本，请参阅管理Amazon SAM CLI 版本。

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

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

  1. 注册 Amazon 账户。

  2. 创建 IAM 管理用户。

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

  4. 正在安装Amazon CLI.

  5. 配置Amazon凭证。

安装 Amazon SAM CLI

要安装 CAmazon SAM LI，请按照操作系统的说明进行操作。

x86_64 - command line installer

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

  2. 通过以下命令生成哈希值，验证已下载的安装程序文件的完整性和真实性：

    $ sha256sum aws-sam-cli-linux-x86_64.zip

    输出应类似下面的输出，类似下面的示例：

     <64-character SHA256 hash value> aws-sam-cli-linux-x86_64.zip

    将 64 个字符的 SHA-256 哈希值与 CLI 发行说明中所需的Amazon SAM CLI 版本的Amazon SAM哈希值进行比较 GitHub。

  3. 将安装文件解压缩到sam-installation/子目录中。

    注意

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

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

  4. 安装 Amazon SAM CLI。

    $ sudo ./sam-installation/install

  5. 验证安装。

    $ sam --version

    成功安装后，您应该会看到类似下面的输出，类似下面的输出，类似下面的输出：

     SAM CLI, version 1.58.0
ARM - command line installer
注意

我们建议将Amazon SAM CLI 安装到虚拟环境中，以确保故障排除时有一个干净的启动环境和隔离的环境。有关更多信息，请参阅使用以下方法将Amazon SAM CLI 安装到虚拟环境中pip：

  1. pip用于安装Amazon SAM CLI。

    $ pip install aws-sam-cli

  2. 验证安装。

    $ sam --version

    成功安装后，您应该会看到类似下面的输出，类似下面的输出，类似下面的输出：

     SAM CLI, version 1.58.0
Homebrew
重要

你必须已经在你的 Linux 计算机上Homebrew安装了。有关安装instructions，请参阅安装Homebrew以便与Amazon SAM CLI 一起使用。

要通过以下命令来安装Amazon SAM CLIHomebrew，请运行以下命令：

$ brew install aws/tap/aws-sam-cli

验证安装。

$ sam --version

成功安装Amazon SAM CLI 后，您应该会看到类似下面的输出，类似下面的输出，类似下面的输出：

SAM CLI, version 1.58.0

使用其软件包安装程序或通过安装Amazon SAM CLIHomebrew。我们建议使用软件包安装程序。

使用软件包安装程序

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

  1. GUI

  2. Command line

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

安装步骤

使用以下任一选项安装Amazon SAM CLI。

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

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

  1. 要开始安装，请将 macOS 下载pkg到您选择的目录中：

  2. 通过以下命令生成哈希值，验证已下载的安装程序的完整性和真实性：

    $ shasum -a 256 path-to-pkg-installer/name-of-pkg-installer

# Examples
$ shasum -a 256 /Users/myUser/Downloads/aws-sam-cli-macos-arm64.pkg
$ shasum -a 256 /Users/myUser/Downloads/aws-sam-cli-macos-x86_64.pkg

    将您的 64 个字符的 SHA-256 哈希值与 Amazon SAMCLI 发行说明GitHub存储库中的相应值进行比较。

安装Amazon SAM命令行界面

  1. 运行下载的文件并按照屏幕上的说明继续完成简介、自述和许可证步骤。

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

  3. 对于 “安装类型”，选择Amazon SAM CLI 的安装位置，然后按安装。推荐的默认位置是/usr/local/aws-sam-cli。

    注意

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

  4. CAmazon SAM LI 将安装并显示 “安装成功” 消息。按 “关闭”。

验证安装

  • 运行以下Amazon SAM命令来验证 CLI 是否已正确安装并且您的符号链接已配置：

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

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

  1. 要开始安装，请将 macOS 下载pkg到您选择的目录中：

  2. 通过以下命令生成哈希值，验证已下载的安装程序的完整性和真实性：

    $ shasum -a 256 path-to-pkg-installer/name-of-pkg-installer

# Examples
$ shasum -a 256 /Users/myUser/Downloads/aws-sam-cli-macos-arm64.pkg
$ shasum -a 256 /Users/myUser/Downloads/aws-sam-cli-macos-x86_64.pkg

    将您的 64 个字符的 SHA-256 哈希值与 Amazon SAMCLI 发行说明GitHub存储库中的相应值进行比较。

安装Amazon SAM命令行界面

  1. 运行下载的文件并按照屏幕上的说明继续完成简介、自述和许可证步骤。

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

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

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

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

    3. 按 “安装”。

  4. CAmazon SAM LI 将安装并显示 “安装成功” 消息。按 “关闭”。

创建符号链接

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

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

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

    • 路@@ 径 — 安装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, version 1.66.0
Command line - All users
下载软件包安装程序
注意

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

  1. 要开始安装，请将 macOS 下载pkg到您选择的目录中：

  2. 通过以下命令生成哈希值，验证已下载的安装程序的完整性和真实性：

    $ shasum -a 256 path-to-pkg-installer/name-of-pkg-installer

# Examples
$ shasum -a 256 /Users/myUser/Downloads/aws-sam-cli-macos-arm64.pkg
$ shasum -a 256 /Users/myUser/Downloads/aws-sam-cli-macos-x86_64.pkg

    将您的 64 个字符的 SHA-256 哈希值与 Amazon SAMCLI 发行说明GitHub存储库中的相应值进行比较。

安装Amazon SAM命令行界面

  • 修改并运行安装脚本：

    $ 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, version 1.66.0
Command line - Current user
下载软件包安装程序
注意

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

  1. 要开始安装，请将 macOS 下载pkg到您选择的目录中：

  2. 通过以下命令生成哈希值，验证已下载的安装程序的完整性和真实性：

    $ shasum -a 256 path-to-pkg-installer/name-of-pkg-installer

# Examples
$ shasum -a 256 /Users/myUser/Downloads/aws-sam-cli-macos-arm64.pkg
$ shasum -a 256 /Users/myUser/Downloads/aws-sam-cli-macos-x86_64.pkg

    将您的 64 个字符的 SHA-256 哈希值与 Amazon SAMCLI 发行说明GitHub存储库中的相应值进行比较。

安装Amazon SAM命令行界面

  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 SAM CLI 程序的首选项。

  3. 运行以下命令来安装Amazon SAM CLI：

    $ 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，必须在 CAmazon SAM LI 程序和您的之间手动创建符号链接$PATH。通过修改并运行以下命令来创建符号链接：

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

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

    • 路@@ 径 — 安装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, version 1.66.0
Homebrew
重要

您必须已在计算机上Homebrew安装。有关安装说明，请参阅安装Homebrew以便与Amazon SAM CLI 一起使用。

按照以下步骤使用以下方法安装Amazon SAM CLIHomebrew：

$ brew install aws/tap/aws-sam-cli

验证安装：

$ sam --version

成功安装Amazon SAM CLI 后，您应该会看到类似下面的输出，类似下面的输出，类似下面的输出：

SAM CLI, version 1.58.0

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

按照以下步骤使用 MSAmazon SAM I 文件安装 CLI。

  1. 安装 64 位Amazon SAM命令行界面。

    注意

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

  2. 验证安装。

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

    sam --version

    成功安装Amazon SAM CLI 后，您应该会看到类似下面的输出，类似下面的输出，类似下面的输出：

    SAM CLI, version 1.58.0

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

    重要

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

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

  4. 安装 Git。

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

问题排查

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

后续步骤

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