Installation de la CLI AWS SAM Résolution des problèmes Étapes suivantes

Installation de la CLI AWS SAM

Installez la dernière version de l'interface de ligne de commande AWS Serverless Application Model (CLI AWS SAM) sur les systèmes d'exploitation pris en charge.

Pour savoir comment gérer une version actuellement installée de la CLI AWS SAM, notamment comment mettre à niveau, désinstaller ou gérer les compilations nocturnes, consultez Gestion des versions de la CLI AWS SAM.

Important

Avant de continuer, remplissez l'ensemble des conditions préalables de la section précédente.

Rubriques

Installation de la CLI AWS SAM
Résolution des problèmes
Étapes suivantes

Installation de la CLI AWS SAM

Pour installer la CLI AWS SAM, suivez les instructions relatives à votre système d'exploitation.

x86_64 - command line installer

Téléchargez le fichier .zip de la CLI AWS SAM dans un répertoire de votre choix.
Vérifiez l'intégrité et l'authenticité des fichiers d'installation téléchargés en générant une valeur de hachage à l'aide de la commande suivante :
```
$ sha256sum aws-sam-cli-linux-x86_64.zip
```
Le résultat doit ressembler à l'exemple qui suit :
```
 <64-character SHA256 hash value> aws-sam-cli-linux-x86_64.zip
```
Comparez la valeur de hachage SHA-256 64 caractères avec celle de la version de CLI AWS SAM de votre choix dans les Notes de mise à jour pour CLI AWS SAM sur GitHub.
Décompressez les fichiers d'installation dans le sous-répertoire sam-installation/.

Note
Si votre système d'exploitation ne dispose pas de la commande unzip intégrée, utilisez un équivalent.
```
$ unzip aws-sam-cli-linux-x86_64.zip -d sam-installation
```
Installez la CLI AWS SAM.
```
$ sudo ./sam-installation/install
```
Vérifiez l'installation.
```
$ sam --version
```
En cas d'installation réussie, vous devriez voir une sortie semblable à la suivante :
```
 SAM CLI, version 1.58.0
```

ARM - command line installer

Utilisez pip pour installer la CLI AWS SAM.
```
$ pip install aws-sam-cli
```
Vérifiez l'installation.
```
$ sam --version
```
En cas d'installation réussie, vous devriez voir une sortie semblable à la suivante :
```
 SAM CLI, version 1.58.0
```

Homebrew

Important

Homebrew doit être installé sur votre machine Linux. Pour obtenir des instructions d'installation, veuillez consulter Installation de Homebrew pour une utilisation avec la CLI AWS SAM.

Pour installer la CLI AWS SAM à l'aide de Homebrew, utilisez les commandes suivantes :


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

Note

À partir de la version 1.70.1 de la CLI AWS SAM, l'exécution de la commande aws/tap n'est plus nécessaire en raison d'une modification apportée à la bibliothèque homebrew-core. Pour installer la CLI AWS SAM v1.70.1 ou une version plus récente, nous vous recommandons d'exécuter brew install aws/tap/aws-sam-cli à la place.

Vérifiez l'installation.


$ sam --version

Lors de l'installation réussie de la CLI AWS SAM, vous devriez voir une sortie semblable à la suivante :

SAM CLI, version 1.58.0

Installez la CLI AWS SAM à l'aide du package d'installation ou via Homebrew.

Utilisation du package d'installation

Le package d'installation vous propose de choisir entre deux méthodes d'installation :

GUI
Ligne de commande

Vous pouvez effectuer l'installation pour tous les utilisateurs ou uniquement pour votre utilisateur actuel. Pour effectuer l'installation pour tous les utilisateurs, l'autorisation de superutilisateur est requise.

Étapes d'installation

Installez la CLI AWS SAM à l'aide de l'une des options suivantes.

GUI - All users

Télécharger le package d'installation

Note

Si vous avez déjà installé la CLI AWS SAM via Homebrew ou pip, vous devez d'abord la désinstaller. Pour obtenir des instructions, consultez Désinstallation de la CLI AWS SAM.

Pour commencer l'installation, téléchargez le pkg macOS dans un répertoire de votre choix :
- x86_64 : aws-sam-cli-macos-x86_64.pkg
- arm64 : aws-sam-cli-macos-arm64.pkg
Vérifiez l'intégrité et l'authenticité du programme d'installation téléchargé en générant une valeur de hachage à l'aide de la commande suivante :
```
$ 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
```
Comparez votre valeur de hachage SHA-256 à 64 caractères avec la valeur correspondante dans le référentiel GitHub des notes de mise à jour de la CLI AWS SAM.

Installer la CLI AWS SAM

Exécutez le fichier téléchargé et suivez les instructions qui s'affichent à l'écran pour suivre les étapes Introduction, Read Me (Lisez-moi) et License (Licence).
Pour Destination Select (Sélection de destination), sélectionnez Install for all users of this computer (Installer pour tous les utilisateurs de cet ordinateur).
Dans Installation Type (Type d'installation), choisissez l'emplacement d'installation de la CLI AWS SAM et appuyez sur Install (Installer). L'emplacement par défaut recommandé est /usr/local/aws-sam-cli.

Note
Pour appeler la CLI AWS SAM avec la commande sam, le programme d'installation crée automatiquement un lien symbolique entre /usr/local/bin/sam et /usr/local/aws-sam-cli/sam ou le dossier d'installation que vous avez choisi.
La CLI AWS SAM va s'installer et le message The installation was successful (L'installation s'est déroulée avec succès) s'affichera. Appuyez sur Close (Fermer).

Vérifier l'installation

Vérifiez que la CLI AWS SAM est correctement installée et que votre lien symbolique est configuré en exécutant :
```
$ which sam
/usr/local/bin/sam
$ sam --version
SAM CLI, version 1.66.0
```

GUI - Current user

Télécharger le package d'installation

Note

Si vous avez déjà installé la CLI AWS SAM via Homebrew ou pip, vous devez d'abord la désinstaller. Pour obtenir des instructions, consultez Désinstallation de la CLI AWS SAM.

Pour commencer l'installation, téléchargez le pkg macOS dans un répertoire de votre choix :
- x86_64 : aws-sam-cli-macos-x86_64.pkg
- arm64 : aws-sam-cli-macos-arm64.pkg
Vérifiez l'intégrité et l'authenticité du programme d'installation téléchargé en générant une valeur de hachage à l'aide de la commande suivante :
```
$ 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
```
Comparez votre valeur de hachage SHA-256 à 64 caractères avec la valeur correspondante dans le référentiel GitHub des notes de mise à jour de la CLI AWS SAM.

Installer la CLI AWS SAM

Exécutez le fichier téléchargé et suivez les instructions qui s'affichent à l'écran pour suivre les étapes Introduction, Read Me (Lisez-moi) et License (Licence).
Pour Destination Select (Sélection de destination), sélectionnez Install for me only (Installer pour moi uniquement). Si vous ne voyez pas cette option, passez à l'étape suivante.
Pour Installation Type (Type d'installation), procédez comme suit :
1. Choisissez l'emplacement d'installation de la CLI AWS SAM. L'emplacement par défaut est /usr/local/aws-sam-cli. Sélectionnez un emplacement pour lequel vous disposez d'autorisations d'écriture. Pour modifier l'emplacement d'installation, sélectionnez local et choisissez votre emplacement. Appuyez sur Continue (Continuer) lorsque vous avez terminé.
2. Si vous n'avez pas eu la possibilité de choisir Install for me only (Installer pour moi uniquement) à l'étape précédente, sélectionnez Change Install Location (Modifier l'emplacement d'installation) > Install for me only et appuyez sur Continue (Continuer).
3. Appuyez sur Install (Installer).
La CLI AWS SAM va s'installer et le message The installation was successful (L'installation s'est déroulée avec succès) s'affichera. Appuyez sur Close (Fermer).

Créer un lien symbolique

Pour appeler la CLI AWS SAM à l'aide de la commande sam, vous devez créer manuellement un lien symbolique entre le programme CLI AWS SAM et votre $PATH. Créez votre lien symbolique en modifiant et en exécutant la commande suivante :
```
$ sudo ln -s /path-to/aws-sam-cli/sam /path-to-symlink-directory/sam
```
- sudo : si votre utilisateur dispose d'autorisations d'écriture pour $PATH, sudo n'est pas obligatoire. Dans le cas contraire, la valeur sudo est obligatoire.
- path-to : chemin d'accès vers l'emplacement d'installation du programme CLI AWS SAM. Par exemple, /Users/myUser/Desktop.
- path-to-symlink-directory : votre variable d'environnement $PATH. L'emplacement par défaut est /usr/local/bin.

Vérifier l'installation

Vérifiez que la CLI AWS SAM est correctement installée et que votre lien symbolique est configuré en exécutant :
```
$ which sam
/usr/local/bin/sam
$ sam --version
SAM CLI, version 1.66.0
```

Command line - All users

Télécharger le package d'installation

Note

Si vous avez déjà installé la CLI AWS SAM via Homebrew ou pip, vous devez d'abord la désinstaller. Pour obtenir des instructions, consultez Désinstallation de la CLI AWS SAM.

Pour commencer l'installation, téléchargez le pkg macOS dans un répertoire de votre choix :
- x86_64 : aws-sam-cli-macos-x86_64.pkg
- arm64 : aws-sam-cli-macos-arm64.pkg
Vérifiez l'intégrité et l'authenticité du programme d'installation téléchargé en générant une valeur de hachage à l'aide de la commande suivante :
```
$ 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
```
Comparez votre valeur de hachage SHA-256 à 64 caractères avec la valeur correspondante dans le référentiel GitHub des notes de mise à jour de la CLI AWS SAM.

Installer la CLI AWS SAM

Modifiez et exécutez le script d'installation :
```
$ 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.
```
Note
Pour appeler la CLI AWS SAM avec la commande sam, le programme d'installation crée automatiquement un lien symbolique entre /usr/local/bin/sam et /usr/local/aws-sam-cli/sam.

Vérifier l'installation

Vérifiez que la CLI AWS SAM est correctement installée et que votre lien symbolique est configuré en exécutant :
```
$ which sam
/usr/local/bin/sam
$ sam --version
SAM CLI, version 1.66.0
```

Command line - Current user

Télécharger le package d'installation

Note

Si vous avez déjà installé la CLI AWS SAM via Homebrew ou pip, vous devez d'abord la désinstaller. Pour obtenir des instructions, consultez Désinstallation de la CLI AWS SAM.

Pour commencer l'installation, téléchargez le pkg macOS dans un répertoire de votre choix :
- x86_64 : aws-sam-cli-macos-x86_64.pkg
- arm64 : aws-sam-cli-macos-arm64.pkg
Vérifiez l'intégrité et l'authenticité du programme d'installation téléchargé en générant une valeur de hachage à l'aide de la commande suivante :
```
$ 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
```
Comparez votre valeur de hachage SHA-256 à 64 caractères avec la valeur correspondante dans le référentiel GitHub des notes de mise à jour de la CLI AWS SAM.

Installer la CLI AWS SAM

Déterminez le répertoire d'installation pour lequel vous disposez d'autorisations d'écriture. Créez ensuite un fichier xml à l'aide du modèle et modifiez-le pour qu'il reflète votre répertoire d'installation. Le répertoire doit déjà exister.

Par exemple, si vous remplacez path-to-my-directory par /Users/myUser/Desktop, le dossier du programme aws-sam-cli y sera installé.


<?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>

Enregistrez le fichier xml et vérifiez sa validité en procédant ainsi :
```
$ installer -pkg path-to-pkg-installer \
-target CurrentUserHomeDirectory \
-showChoicesAfterApplyingChangesXML path-to-your-xml-file
```
La sortie doit afficher les préférences qui seront appliquées au programme CLI AWS SAM.

Procédez comme suit pour installer la CLI AWS SAM :


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

Créer un lien symbolique

Pour appeler la CLI AWS SAM à l'aide de la commande sam, vous devez créer manuellement un lien symbolique entre le programme CLI AWS SAM et votre $PATH. Créez votre lien symbolique en modifiant et en exécutant la commande suivante :
```
$ sudo ln -s /path-to/aws-sam-cli/sam /path-to-symlink-directory/sam
```
- sudo : si votre utilisateur dispose d'autorisations d'écriture pour $PATH, sudo n'est pas obligatoire. Dans le cas contraire, la valeur sudo est obligatoire.
- path-to : chemin d'accès vers l'emplacement d'installation du programme CLI AWS SAM. Par exemple, /Users/myUser/Desktop.
- path-to-symlink-directory : votre variable d'environnement $PATH. L'emplacement par défaut est /usr/local/bin.

Vérifier l'installation

Vérifiez que la CLI AWS SAM est correctement installée et que votre lien symbolique est configuré en exécutant :
```
$ which sam
/usr/local/bin/sam
$ sam --version
SAM CLI, version 1.66.0
```

Homebrew

Important

Homebrew doit être installé sur votre machine. Pour obtenir des instructions d'installation, consultez Installation de Homebrew pour une utilisation avec la CLI AWS SAM.

Suivez ces étapes pour installer la CLI AWS SAM à l'aide de Homebrew :


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

Note

Vérifier l'installation :


$ sam --version

Après l'installation réussie de la CLI AWS SAM, vous devriez voir une sortie semblable à la suivante :

SAM CLI, version 1.58.0

Les fichiers Windows Installer (MSI) sont les fichiers du programme d'installation du package pour le système d'exploitation Windows.

Procédez comme suit pour installer la CLI AWS SAM à l'aide du fichier MSI.

Installez la CLI AWS SAM 64 bits.

Note
Si vous utilisez une version 32 bits de Windows, consultez Installation de la CLI AWS SAM sur Windows 32 bits.
Vérifiez l'installation.

Une fois l'installation terminée, vérifiez-la en ouvrant une nouvelle invite de commandes ou une invite PowerShell. Vous devriez être en mesure d'appeler sam à partir de la ligne de commande.
```
sam --version
```
Après l'installation réussie de la CLI AWS SAM, vous devriez voir une sortie semblable à la suivante :
```
SAM CLI, version 1.58.0
```
Activez les chemins d'accès longs (Windows 10 et versions ultérieures uniquement).

Important
Le référentiel de modèles d'applications CLI AWS SAM contient des chemins d'accès au fichier longs qui peuvent entraîner des erreurs lors de l'exécution de sam init en raison des limitations MAX_PATH de Windows 10. Pour résoudre ce problème, vous devez configurer le comportement des nouveaux chemins d'accès longs.

Pour activer les chemins d'accès longs, veuillez consulter la rubrique Activer les chemins longs dans Windows 10, version 1607 et ultérieures dans la documentation de développement d'applications Microsoft Windows.
Installez Git.

Pour télécharger des exemples d'applications à l'aide de la commande sam init, vous devez également installer Git. Pour obtenir des instructions, veuillez consulter Installation de Git.

Résolution des problèmes

Si vous rencontrez des problèmes lors de l'installation de la CLI AWS SAM, consultez Résolution des erreurs d'installation.

Étapes suivantes

Pour en savoir plus sur la CLI AWS SAM et pour commencer à créer vos propres applications sans serveur, veuillez consulter les ressources suivantes :

Tutoriel : déploiement d'une application Hello World : instructions étape par étape pour télécharger, créer et déployer une application sans serveur de base.
The Complete AWS SAM Workshop : atelier destiné à vous enseigner un bon nombre des principales fonctionnalités d'AWS SAM.
Exemples d'applications et de modèles AWS SAM – exemples d'applications et de modèles d'auteurs de la communauté avec lesquels vous pouvez expérimenter davantage.

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Prérequis

Tutoriel : application Hello World