AWS SAM CLI バージョンの管理 - AWS Serverless Application Model
AWS SAM CLI のアップグレードAWS SAM CLI のアンインストールHomebrew から移行するAWS SAM CLI ナイトリービルドを管理するpip を使用した仮想環境への AWS SAM CLI のインストールHomebrew で AWS SAM CLI を管理するトラブルシューティング

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

AWS SAM CLI バージョンの管理

アップグレード、ダウングレード、アンインストールを通じて、AWS Serverless Application Model コマンドラインインターフェイス (AWS SAM CLI) のバージョンを管理します。オプションで、AWS SAM CLI のナイトリービルドをダウンロードしてインストールできます。

AWS SAM CLI のアップグレード

Linux で AWS SAM CLI をアップグレードするには、「AWS SAM CLIのインストール」のインストール手順に従ってください。ただし、次のように install コマンドに --update オプションを追加します。

sudo ./sam-installation/install --update

AWS SAM CLI は、インストールしたときと同じ方法でアップグレードする必要があります。AWS SAM CLI のインストールとアップグレードには、パッケージインストーラーの使用をおすすめします。

パッケージインストーラを使用して AWS SAM CLI をアップグレードするには、最新のパッケージバージョンをインストールします。手順については、「AWS SAM CLIのインストール」を参照してください。

AWS SAM CLI をアップグレードするには、Windows のインストール手順を AWS SAM CLIのインストール でもう一度繰り返します。

AWS SAM CLI のアンインストール

AWS SAM CLI を Linux でアンインストールするには、以下のコマンドを実行して、シンボリックリンクとインストールディレクトリを削除する必要があります。

  1. シンボリックリンクとインストールパスを見つけます。

    • which コマンドを使用して、シンボリックリンクを検索します。

      which sam

      出力には、AWS SAM バイナリがある場所のパスが表示されます。以下はその例です。

       /usr/local/bin/sam

    • ls コマンドを使用して、シンボリックリンクがポイントするディレクトリを検索します。

      ls -l /usr/local/bin/sam

      以下の例では、インストールディレクトリが /usr/local/aws-sam-cli になっています。

       lrwxrwxrwx 1 ec2-user ec2-user 49 Oct 22 09:49 /usr/local/bin/sam -> /usr/local/aws-sam-cli/current/bin/sam

  2. シンボリックリンクを削除します。

    sudo rm /usr/local/bin/sam

  3. インストールディレクトリを削除します。

    sudo rm -rf /usr/local/aws-sam-cli

AWS SAM CLI をインストールしたときと同じ方法でアンインストールします。AWS SAM CLI のインストールには、パッケージインストーラーの使用をおすすめします。

パッケージインストーラーを使用して AWS SAM CLI をインストールした場合は、次の手順でアンインストールします。

AWS SAM CLI をアンインストールするには

  1. 以下を変更および実行して、AWS SAM CLI プログラムを削除します。

    $ sudo rm -rf /path-to/aws-sam-cli

    1. sudo — ユーザーが AWS SAM CLI プログラムがインストールされた場所への書き込み権限を持っている場合、sudo は必須ではありません。それ以外の場合、sudo が必要です。

    2. path-to — AWS SAM CLI プログラムをインストールした場所へのパス。デフォルトの場所は /usr/local です。

  2. 以下を変更および実行して、AWS SAM CLI $PATH を削除します。

    $ sudo rm -rf /path-to-symlink-directory/sam

    1. sudo — ユーザーが $PATH への書き込み権限を持っている場合、sudo は必須ではありません。それ以外の場合、sudo が必要です。

    2. path-to-symlink-directory – $PATH環境変数。デフォルトの場所は /usr/local/bin です。

  3. 以下を実行して AWS SAM CLI がアンインストールされていることを確認します。

    $ sam --version
command not found: sam

Windows の設定を使用して AWS SAM CLI をアンインストールするには、これらの手順を実行してください。

  1. [スタート] メニューから、[プログラムの追加と削除] を検索します。

  2. [AWS SAM Command Line Interface] という名前の結果を選択し、[Uninstall] (アンインストール) を選択してアンインストーラを起動します 。

  3. AWS SAM CLI をアンインストールすることを確認します。

Homebrew を使用する AWS SAM CLI の管理から移行する

Homebrew で AWS SAM CLI のインストールとアップグレードを行っている場合、AWS の使用をおすすめします。サポートされている方法に切り替えるには、以下の手順に従ってください。

Homebrew の使用からの移行方法

  1. Homebrew でインストールした AWS SAM CLI をアンインストールする のインストラクションに従い、Homebrew 管理のバージョンをアンインストールします。

  2. AWS SAM CLIのインストール のインストラクションに従い、AWS SAM CLI をサポートされている方法でインストールします。

AWS SAM CLI ナイトリービルドを管理する

AWS SAM CLI ナイトリービルドをダウンロードしてインストールできます。ナイトリービルドには、実稼働バージョンよりも安定性が低い可能性があるプレリリースバージョンの AWS SAM CLI コードが含まれています。インストールされると、sam-nightly コマンドを使用したナイトリービルドを使用できるようになります。AWS SAM CLI の実稼働ビルドとナイトリービルドは、両バージョンを同時にインストールして使用することが可能です。

注記

ナイトリービルドには、プレリリースバージョンのビルドイメージは含まれません。そのため、--use-container オプションを使用してサーバーレスアプリケーションを構築すると、ビルドイメージの最新の実稼働バージョンが使用されます。

AWS SAM CLI ナイトリービルドのインストール

AWS SAM CLI ナイトリービルドをインストールするには、以下の手順に従ってください。

パッケージインストーラーを使用して、Linux x86_64 プラットフォームの AWS SAM CLI ナイトリービルドバージョンをインストールできます。

AWS SAM CLI ナイトリービルドをインストールするには

  1. リポジトリ sam-cli-nightlyの aws-sam-cli GitHub からパッケージインストーラーをダウンロードします。

  2. AWS SAM CLI をインストールするの手順に従い、ナイトリービルドパッケージをインストールします。

ナイトリービルドパッケージインストーラーを使用して、macOS の AWS SAM CLI ナイトリービルドバージョンをインストールできます。

AWS SAM CLI ナイトリービルドをインストールするには

  1. プラットフォームのパッケージインストーラをリポジトリ sam-cli-nightly の aws-sam-cli GitHub からダウンロードします。

  2. AWS SAM CLI をインストールするの手順に従い、ナイトリービルドパッケージをインストールします。

ナイトリービルドバージョンの AWS SAM CLI は、こちらのダウンロードリンクから利用できます: AWS SAM CLI ナイトリービルド。Windows でナイトリービルドをインストールするには、「AWS SAM CLIのインストール」と同じ手順を実行しますが、代わりにナイトリービルドのダウンロードリンクを使用します。

ナイトリービルドバージョンがインストールされていることを確認するには、sam-nightly --version コマンドを実行します。このコマンドの出力は 1.X.Y.dev<YYYYMMDDHHmm> 形式になります。以下はその例です。

SAM CLI, version 1.20.0.dev202103151200

Homebrew からパッケージインストーラーに移行する

Homebrew で AWS SAM CLI ナイトリービルドのインストールとアップグレードを行っていて、パッケージインストーラーの使用に移行する場合は、この手順に従ってください。

Homebrew からパッケージインストーラーに移行するには

  1. Homebrew でインストールした AWS SAM CLI ナイトリービルドをアンインストールします。

    $ brew uninstall aws-sam-cli-nightly

  2. 以下を実行して AWS SAM CLI ナイトリービルドがアンインストールされていることを確認します。

    $ sam-nightly --version
zsh: command not found: sam-nightly

  3. 前のセクションの手順に従って、AWS SAM CLI ナイトリービルドをインストールします。

pip を使用した仮想環境への AWS SAM CLI のインストール

AWS SAM CLI をインストールするには、ネイティブパッケージインストーラーを使用することをお勧めします。pip を使用する必要がある場合は、AWS SAM CLI を仮想環境にインストールすることをお勧めします。これにより、クリーンなインストール環境と、隔離された環境 (エラーが発生した場合) を利用できます。

注記

2023 年 10 月 24 日をもって、AWS SAM CLI は Python 3.7 のサポートを終了します。詳細については、「AWS SAM CLI による Python 3.7 のサポートの終了」を参照してください。

仮想環境に AWS SAM CLI をインストールするには

  1. 任意の開始ディレクトリから仮想環境を作成し、名前を付けます。

    Linux / macOS
    $ mkdir project
$ cd project
$ python3 -m venv venv
    Windows
    > mkdir project
> cd project
> py -3 -m venv venv

  2. 仮想環境をアクティブ化する

    Linux / macOS
    $ . venv/bin/activate

    プロンプトが変わり、仮想環境がアクティブであることが示されます。

    (venv) $
    Windows
    > venv\Scripts\activate

    プロンプトが変わり、仮想環境がアクティブであることが示されます。

    (venv) >

  3. 仮想環境に AWS SAM CLI をインストールします。

    (venv) $ pip install --upgrade aws-sam-cli

  4. AWS SAM CLI が正しくインストールされたことを確認します。

    (venv) $ sam --version
SAM CLI, version 1.94.0

  5. deactivate コマンドを使用して、仮想環境を終了できます。新しいセッションを開始するたびに、環境を再度アクティブ化する必要があります。

Homebrew で AWS SAM CLI を管理する

注記

2023 年 9 月以降、AWS では AWS で管理される AWS SAM CLI (aws/tap/aws-sam-cli) 用 Homebrew インストーラーのメンテナンスを行いません。Homebrew を引き続き使用するには、コミュニティ管理のインストーラーを使用します (aws-sam-cli)。2023 年 9 月以降、aws/tap/aws-sam-cli を参照する Homebrew は aws-sam-cli にリダイレクトします。

私たちがサポートしているインストールとアップグレードの使用をおすすめします。

Homebrew を使用した AWS SAM CLI のインストール

注記

このインストラクションでは、コミュニティが管理する AWS SAM CLI Homebrew インストーラーを使用します。より詳細なサポートについては、homebrew-core リポジトリをご覧ください。

AWS SAM CLI をインストールするには

  1. 下記を実行します。

    $ brew install aws-sam-cli

  2. インストールを確認します。

    $ sam --version

    AWS SAM CLI が正常にインストールされると、以下のような出力が表示されます。

    SAM CLI, version 1.94.0

Homebrew を使用した AWS SAM CLI のアップグレード

Homebrew を使用して AWS SAM CLI をアップグレードするには、以下のコマンドを実行します。

$ brew upgrade aws-sam-cli

Homebrew でインストールした AWS SAM CLI をアンインストールする

AWS SAM CLI を Homebrew でインストールしていた場合は、次の手順に従ってアンインストールします。

AWS SAM CLI をアンインストールするには

  1. 下記を実行します。

    $ brew uninstall aws-sam-cli

  2. 以下を実行して AWS SAM CLI がアンインストールされていることを確認します。

    $ sam --version
command not found: sam

コミュニティ管理の Homebrew インストーラーに移行する

AWS 管理の Homebrew インストーラー (aws/tap/aws-sam-cli) を使用していて、Homebrew を引き続き使用する場合は、コミュニティ管理の Homebrew インストーラー (aws-sam-cli) への移行をおすすめします。

1 つのコマンドで切り替えるには、以下を実行します。

$ brew uninstall aws-sam-cli && brew untap aws/tap && brew cleanup aws/tap && brew update && brew install aws-sam-cli

以下の手順に従って、各コマンドを個別に実行してください。

コミュニティ管理の Homebrew インストーラーに移行するには

  1. AWS 管理の AWS SAM CLI Homebrew バージョンをアンインストールします:

    $ brew uninstall aws-sam-cli

  2. AWS SAM CLI がアンインストールされたことを確認します。

    $ which sam
sam not found

  3. AWS 管理の AWS SAM CLI を削除します。以下をタップします:

    $ brew untap aws/tap

    次のようなエラーが表示された場合は、--force オプションを選択し、もう一度試してください。

    Error: Refusing to untap aws/tap because it contains the following installed formulae or casks:
aws-sam-cli-nightly

  4. AWS 管理のインストーラーのキャッシュファイルを削除します:

    $ brew cleanup aws/tap

  5. Homebrew およびすべてのフォーミュラを更新します:

    $ brew update

  6. コミュニティ管理の AWS SAM CLI をインストールします:

    $ brew install aws-sam-cli

  7. AWS SAM CLI のインストールに成功したことを確認します。

    $ sam --version
SAM CLI, version 1.94.0

トラブルシューティング

AWS SAM CLI のインストールまたは使用中にエラーが発生した場合は、「AWS SAMCLI トラブルシューティング」を参照してください。