Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra. # Référence des commandes CLI AWS SAM Cette section inclut des informations de référence sur AWS SAMCLI les commandes. Cela inclut des détails sur l'utilisation, une liste complète des différentes options disponibles pour chaque commande et des informations supplémentaires. Le cas échéant, les informations supplémentaires incluent des détails tels que les arguments, les variables d'environnement et les événements. Consultez chaque commande pour plus de détails. Pour obtenir des instructions sur l'installation du AWS SAMCLI, voir[Installer la CLI  AWS SAM](install-sam-cli.md). **Topics** + [sam build](sam-cli-command-reference-sam-build.md) + [sam delete](sam-cli-command-reference-sam-delete.md) + [sam deploy](sam-cli-command-reference-sam-deploy.md) + [sam init](sam-cli-command-reference-sam-init.md) + [sam list](sam-cli-command-reference-sam-list.md) + [sam local callback](sam-cli-command-reference-sam-local-callback.md) + [sam local execution](sam-cli-command-reference-sam-local-execution.md) + [sam local generate-event](sam-cli-command-reference-sam-local-generate-event.md) + [sam local invoke](sam-cli-command-reference-sam-local-invoke.md) + [sam local start-api](sam-cli-command-reference-sam-local-start-api.md) + [sam local start-lambda](sam-cli-command-reference-sam-local-start-lambda.md) + [sam logs](sam-cli-command-reference-sam-logs.md) + [sam package](sam-cli-command-reference-sam-package.md) + [sam pipeline bootstrap](sam-cli-command-reference-sam-pipeline-bootstrap.md) + [sam pipeline init](sam-cli-command-reference-sam-pipeline-init.md) + [sam publish](sam-cli-command-reference-sam-publish.md) + [sam remote callback](sam-cli-command-reference-sam-remote-callback.md) + [sam remote execution](sam-cli-command-reference-sam-remote-execution.md) + [sam remote invoke](sam-cli-command-reference-remote-invoke.md) + [sam remote test-event](sam-cli-command-reference-remote-test-event.md) + [sam sync](sam-cli-command-reference-sam-sync.md) + [sam traces](sam-cli-command-reference-sam-traces.md) + [sam validate](sam-cli-command-reference-sam-validate.md) # sam build Cette page fournit des informations de référence pour la AWS Serverless Application Model commande Command Line Interface (AWS SAMCLI)`sam build`. + Pour une introduction à la AWS SAMCLI, voir [Qu'est-ce que c'est AWS SAMCLI ?](what-is-sam-overview.md#what-is-sam-cli) + Pour obtenir de la documentation sur l'utilisation de la AWS SAMCLI `sam build` commande, consultez[Initiation à la construction avec AWS SAM](using-sam-cli-build.md). La commande `sam build` prépare une application pour les étapes suivantes du flux de travail du développeur, telles que le test local ou le déploiement sur AWS Cloud. ## Usage ``` $ sam build ``` ## Arguments **ID de ressource** Facultatif. Indique AWS SAM de créer une seule ressource déclarée dans un [AWS SAM modèle](what-is-sam-overview.md#what-is-sam-template). Les artefacts de création pour la ressource spécifiée sont les seuls disponibles pour les commandes suivantes du flux de travail ; c’est-à-dire `sam package` et `sam deploy`. ## Options `--base-dir, -s DIRECTORY` Résout les chemins relatifs au code source de la fonction ou de la couche par rapport à ce répertoire. Utilisez cette option si vous souhaitez modifier la façon dont les chemins d’accès relatifs aux dossiers de code source sont résolus. Par défaut, les chemins relatifs sont résolus selon l’emplacement du modèle AWS SAM . Outre les ressources de l’application racine ou de la pile que vous créez, cette option applique également des applications ou des piles imbriquées. Cette option s’applique aux types de ressources et propriétés suivants : + Type de ressource : propriété `AWS::Serverless::Function` : `CodeUri` + Type de ressource : attribut de ressource `AWS::Serverless::Function` : entrée `Metadata` : `DockerContext` + Type de ressource : propriété `AWS::Serverless::LayerVersion` : `ContentUri` + Type de ressource : propriété `AWS::Lambda::Function` : `Code` + Type de ressource : propriété `AWS::Lambda::LayerVersion` : `Content` `--beta-features | --no-beta-features` Autorisez ou refusez les fonctionnalités bêta. `--build-dir, -b DIRECTORY` Le chemin d’accès à un répertoire dans lequel les artefacts créés sont stockés. Ce répertoire et tout son contenu sont supprimés avec cette option. `--build-image TEXT` L’URI de l’image de conteneur que vous souhaitez extraire pour la création. Par défaut, AWS SAM extrait l’image de conteneur depuis Amazon ECR Public. Utilisez cette option pour extraire l’image à partir d’un autre emplacement. Vous pouvez spécifier cette option plusieurs fois. Chaque instance de cette option peut prendre une chaîne ou une paire valeur clé. Si vous spécifiez une chaîne, il s’agit de l’URI de l’image de conteneur à utiliser pour toutes les ressources de l’application. Par exemple, `sam build --use-container --build-image amazon/aws-sam-cli-build-image-python3.8`. Si vous spécifiez une paire valeur clé, la clé est le nom de la ressource et la valeur est l’URI de l’image de conteneur à utiliser pour cette ressource. Par exemple `sam build --use-container --build-image Function1=amazon/aws-sam-cli-build-image-python3.8`. Avec les paires valeur clé, vous pouvez spécifier différentes images de conteneur pour différentes ressources. Cette option ne s'applique que si l'option `--use-container` est spécifiée, dans le cas contraire, une erreur se produit. `--build-in-source | --no-build-in-source` Procurez-vous `--build-in-source` pour créer votre projet directement dans le dossier source. L'option `--build-in-source` prend en charge les systèmes d’exécution ainsi que les méthodes de création suivantes : + **exécutions** : toute méthode d’exécution Node.js prise en charge par l'option `sam init --runtime`. + **Méthodes de construction** : `Makefile`, `esbuild`. L'option `--build-in-source` n'est pas compatible avec celles suivantes : + `--hook-name` + `--use-container ` *Par défaut* : `--no-build-in-source` `--cached | --no-cached` Activez ou désactivez les créations mises en cache. Utilisez cette option pour réutiliser les artefacts de build qui n'ont pas changé par rapport aux versions précédentes. AWS SAM évalue si vous avez modifié des fichiers dans le répertoire de votre projet. Par défaut, les créations ne sont pas mises en cache. Si l'`--no-cached`option est invoquée, elle remplace le `cached = true` paramètre défini dans samconfig.toml. AWS SAM n’évalue pas si vous avez modifié des modules tiers dont le projet dépend, si vous n’avez pas fourni de version spécifique. Par exemple, si votre fonction Python inclut un `requirements.txt` fichier contenant l'entrée `requests=1.x` et que la dernière version du module de requête passe de `1.1` à`1.2`, AWS SAM elle n'extrait pas la dernière version tant que vous n'avez pas exécuté une version non mise en cache. `--cache-dir` Le répertoire dans lequel les artefacts mis en cache sont stockés lorsque `--cached` est spécifié. Le répertoire mis en caché par défaut est `.aws-sam/cache`. `--config-env TEXT` Le nom d’environnement spécifiant les valeurs de paramètre par défaut dans le fichier de configuration à utiliser. La valeur par défaut est « par défaut ». Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--config-file PATH` Le chemin d’accès et le nom du fichier de configuration contenant les valeurs de paramètres par défaut à utiliser. La valeur par défaut est « `samconfig.toml` » dans la racine du répertoire du projet. Pour plus d’informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--container-env-var, -e TEXT` Variables d’environnement à transmettre au conteneur de création. Vous pouvez spécifier cette option plusieurs fois. Chaque instance de cette option prend une paire clé-valeur, où la clé est la variable de ressource et d’environnement et la valeur est la valeur de la variable d’environnement. Par exemple : `--container-env-var Function1.GITHUB_TOKEN=TOKEN1 --container-env-var Function2.GITHUB_TOKEN=TOKEN2`. Cette option ne s’applique que si l’option `--use-container` est spécifiée, dans le cas contraire, une erreur se produit. `--container-env-var-file, -ef PATH` Le chemin d’accès et le nom d’un fichier JSON contenant les valeurs des variables d’environnement de conteneur. Pour plus d’informations sur les fichier des variables d’environnement de conteneur, consultez [Fichier de variables d'environnement du conteneur.](serverless-sam-cli-using-build.md#serverless-sam-cli-using-container-environment-file). Cette option ne s'applique que si l'option `--use-container` est spécifiée, dans le cas contraire, une erreur se produit. `--debug` Active la journalisation de débogage pour imprimer les messages de débogage générés par la CLI  AWS SAM et pour afficher les horodatages. `--docker-network TEXT` Spécifie le nom ou l’identifiant d’un réseau Docker existant auquel les conteneurs Docker Lambda doivent se connecter, avec le réseau de pont par défaut. Si cela n’est pas spécifié, les conteneurs Lambda se connectent uniquement au réseau Docker de pont par défaut. `--exclude, -x` Le nom de la ou des ressource(s) à exclure de `sam build`. Par exemple, si votre modèle contient `Function1`, `Function2` et `Function3` et vous exécutez `sam build --exclude Function2`, uniquement `Function1` et `Function3` seront créés. `--help` Affiche ce message, puis se ferme. `--hook-name TEXT` Nom du hook utilisé pour étendre la fonctionnalité de la CLI  AWS SAM. Valeurs acceptées : `terraform`. `--manifest , -m PATH` Le chemin d’accès à un fichier manifeste de dépendance personnalisé (par exemple, package.json) à utiliser à la place du fichier par défaut. `--mount-symlinks` Garantit le AWS SAMCLI montage permanent des liens symboliques présents dans les fichiers à créer ou à invoquer. Cela s'applique uniquement aux liens symboliques du répertoire de niveau supérieur (c'est-à-dire aux liens symboliques situés directement à la racine de la fonction). Par défaut, les liens symboliques ne sont pas montés, à l'exception de ceux nécessaires pour être utilisés `node_modules` dans `build-in-source` NodeJS. `--no-use-container` Option qui vous permet d'utiliser le kit d'outils IDE pour définir le comportement par défaut. Vous pouvez également l'utiliser `sam build --no-use-container` pour exécuter un build sur votre machine locale au lieu d'un conteneur docker. `--parallel` Active les builds parallèles. Utilisez cette option pour créer les fonctions et les couches de votre AWS SAM modèle en parallèle. Par défaut, les fonctions et les couches sont créées en séquence. `--parameter-overrides` (Facultatif) Chaîne contenant des remplacements de CloudFormation paramètres codés sous forme de paires clé-valeur. Utilise le même format que le AWS Command Line Interface (AWS CLI). Par exemple : « `ParameterKey`=`KeyPairName`, `ParameterValue`=`MyKey` `ParameterKey`=`InstanceType`, `ParameterValue`=`t1.micro` ». Cette option n'est pas compatible avec `--hook-name`. `--profile TEXT` Le profil spécifique de votre fichier d'informations d'identification qui obtient les AWS informations d'identification. `--region TEXT` Le Région AWS vers lequel déployer. Par exemple, us-east-1. `--save-params` Enregistrez les paramètres que vous fournissez sur la ligne de commande dans le fichier AWS SAM de configuration. `--skip-prepare-infra` Ignore l'étape de préparation si aucune modification d'infrastructure n'a été apportée. À utiliser avec l'option `--hook-name`. `--skip-pull-image` Spécifie si la commande doit ignorer la dernière image Docker pour l’exécution Lambda. `--template-file, --template, -t PATH` Le chemin et le nom du fichier AWS SAM modèle`[default: template.[yaml|yml]]`. Cette option n'est pas compatible avec `--hook-name`. `--terraform-project-root-path` Le chemin relatif ou absolu vers le répertoire de premier niveau contenant vos fichiers de configuration Terraform ou le code source de vos fonctions. Si ces fichiers se trouvent en dehors du répertoire contenant votre module racine Terraform, utilisez cette option pour spécifier son chemin absolu ou relatif. Cette option nécessite que `--hook-name` soit défini sur `terraform`. `--use-container`, `-u` Si les fonctions dépendent de packages avec des dépendances compilées nativement, utilisez cette option pour créer la fonction dans un conteneur Docker de type Lambda. ## Exemple Pour un exemple détaillé et une présentation détaillée de l'utilisation de la `sam build` sous-commande, reportez-vous à. [Initiation à la construction avec AWS SAM](using-sam-cli-build.md) # sam delete Cette page fournit des informations de référence pour la AWS Serverless Application Model commande Command Line Interface (AWS SAMCLI)`sam delete`. Pour une introduction à la AWS SAMCLI, voir [Qu'est-ce que c'est AWS SAMCLI ?](what-is-sam-overview.md#what-is-sam-cli) La `sam delete` commande supprime une AWS SAM application en supprimant la CloudFormation pile, les artefacts empaquetés et déployés sur Amazon S3 et Amazon ECR, ainsi que le AWS SAM fichier modèle. Cette commande vérifie également si une pile complémentaire Amazon ECR est déployée et, dans l'affirmative, invite l'utilisateur à supprimer cette pile et les référentiels Amazon ECR. Si `--no-prompts` est spécifié, alors les piles compagnons et les répertoires Amazon ECR sont supprimés par défaut. ## Usage ``` $ sam delete ``` ## Options `--config-env TEXT` Le nom d'environnement spécifiant les valeurs de paramètre par défaut dans le fichier de configuration à utiliser. La valeur par défaut est `default`. Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--config-file PATH` Le chemin d'accès et le nom du fichier de configuration contenant les valeurs de paramètres par défaut à utiliser. La valeur par défaut est `samconfig.toml` à la racine du répertoire du projet. Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--debug` Active la journalisation de débogage pour imprimer le message de débogage généré par la CLI  AWS SAM et pour afficher les horodatages. `--help` Affiche ce message, puis se ferme. `--no-prompts` Spécifiez cette option pour AWS SAM fonctionner en mode non interactif. Le nom de la pile doit être fourni, soit avec l’option `--stack-name`, soit dans le fichier de configuration `toml`. `--profile TEXT` Le profil spécifique de votre fichier d'informations d'identification qui obtient les AWS informations d'identification. `--region TEXT` La AWS région dans laquelle le déploiement doit être effectué. Par exemple, us-east-1. `--s3-bucket` Le chemin du compartiment Amazon S3 que vous voulez supprimer. `--s3-prefix` Le préfixe du compartiment Amazon S3 que vous voulez supprimer. `--save-params` Enregistrez les paramètres que vous fournissez sur la ligne de commande dans le fichier AWS SAM de configuration. `--stack-name TEXT` Nom de la CloudFormation pile que vous souhaitez supprimer. ## Exemples La commande suivante supprime la pile`MY-STACK`. ``` $ sam delete --stack-name MY-STACK ``` La commande suivante supprime la pile `MY-STACK` et le compartiment `sam-s3-demo-bucket` S3 : ``` $ sam delete \ --stack-name MyStack \ --s3-bucket MySAMBucket ``` # sam deploy Cette page fournit des informations de référence pour la AWS Serverless Application Model commande Command Line Interface (AWS SAMCLI)`sam deploy`. + Pour une introduction à la AWS SAMCLI, voir [Qu'est-ce que c'est AWS SAMCLI ?](what-is-sam-overview.md#what-is-sam-cli) + Pour obtenir de la documentation sur l'utilisation de la AWS SAMCLI `sam deploy` commande, consultez[Présentation du déploiement avec AWS SAM](using-sam-cli-deploy.md). La `sam deploy` commande déploie une application auprès de l'utilisateur AWS Cloud . AWS CloudFormation ## Usage ``` $ sam deploy ``` ## Variables d’environnement `SAM_CLI_POLL_DELAY` Définissez la variable d'`SAM_CLI_POLL_DELAY`environnement avec une valeur de secondes dans votre shell pour configurer la fréquence à laquelle la CLI AWS SAM vérifie l'état de la CloudFormation pile, ce qui est utile lorsque vous constatez une limitation provenant de. CloudFormation Cette variable d'environnement est utilisée pour interroger les appels `describe_stack` d'API, qui sont effectués pendant l'exécution`sam deploy`. Voici un exemple de cette variable : ``` $ SAM_CLI_POLL_DELAY=5 sam deploy ``` ## Options `--capabilities LIST` Liste des fonctionnalités que vous devez spécifier pour autoriser la création CloudFormation de certaines piles. Certains modèles de pile peuvent inclure des ressources qui affectent les autorisations de votre compte Compte AWS, par exemple en créant de nouveaux utilisateurs Gestion des identités et des accès AWS (IAM). Pour ces piles, vous devez explicitement reconnaître leurs capacités en spécifiant cette option. Les seules valeurs valides sont `CAPABILITY_IAM` et `CAPABILITY_NAMED_IAM`. Si vous disposez de ressources IAM, vous pouvez spécifier l'une ou l'autre de ces capacités. Si vous disposez de ressources IAM avec des noms personnalisés, vous devez spécifier `CAPABILITY_NAMED_IAM`. Si vous ne spécifiez pas cette option, l'opération renvoie une erreur `InsufficientCapabilities`. Lorsque vous déployez une application contenant des applications imbriquées, vous devez utiliser `CAPABILITY_AUTO_EXPAND` pour confirmer que l'application contient des applications imbriquées. Pour de plus amples informations, veuillez consulter [Déploiement d'applications imbriquées](serverless-sam-template-nested-applications.md#serverless-sam-templates-nested-applications-deploying). `--config-env TEXT` Le nom d'environnement spécifiant les valeurs de paramètre par défaut dans le fichier de configuration à utiliser. La valeur par défaut est `default`. Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--config-file PATH` Le chemin d'accès et le nom du fichier de configuration contenant les valeurs de paramètres par défaut à utiliser. La valeur par défaut est `samconfig.toml` à la racine du répertoire du projet. Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--confirm-changeset | --no-confirm-changeset` Invite à confirmer si la CLI  AWS SAM déploie le jeu de modifications calculé. `--debug` Activez la journalisation de débogage pour imprimer le message de débogage généré par la CLI  AWS SAM et pour afficher les horodatages. `--disable-rollback | --no-disable-rollback` Spécifiez si vous souhaitez annuler votre CloudFormation pile en cas d'erreur lors d'un déploiement. Par défaut, en cas d'erreur lors d'un déploiement, votre CloudFormation pile revient à son dernier état stable. Si vous spécifiez `--disable-rollback` et une erreur se produit pendant un déploiement, les ressources créées ou mises à jour avant l'erreur ne sont pas restaurées. `--fail-on-empty-changeset | --no-fail-on-empty-changeset` Indiquez s'il faut renvoyer un code de sortie différent de zéro s'il n'existe aucune modification à apporter à la pile. Le comportement par défaut consiste à renvoyer un code de sortie autre que zéro. `--force-upload` Spécifiez cette option pour télécharger des artefacts, même s’ils correspondent à des artefacts existants dans le compartiment Amazon S3. Les artefacts correspondants sont remplacés. `--guided, -g` Spécifiez cette option pour que la CLI  AWS SAM utilise des invites pour vous guider tout au long du déploiement. `--help` Affichez ce message et quittez. `--image-repositories TEXT` Un mappage des fonctions vers l'URI de leur référentiel Amazon ECR. Référencez les fonctions par leur identifiant logique. Voici un exemple : ``` $ sam deploy --image-repositories Function1=123456789012.dkr.ecr.us-east-1.amazonaws.com/my-repo ``` Vous pouvez spécifier cette option plusieurs fois au sein d'une même commande. `--image-repository TEXT` Le nom du référentiel Amazon ECR vers lequel cette commande charge l'image de la fonction. Cette option est requise pour les fonctions déclarées avec le type de package `Image`. `--kms-key-id TEXT` L'ID d'une clé AWS Key Management Service (AWS KMS) utilisée pour chiffrer les artefacts inactifs dans le compartiment Amazon S3. Si vous ne spécifiez pas cette option, AWS SAM utilise les clés de chiffrement gérées par Amazon S3. `--metadata` Une carte de métadonnées à attacher à tous les artefacts référencés dans le modèle. `--no-execute-changeset` Indique s'il faut appliquer le jeu de modifications. Spécifiez cette option si vous voulez afficher les modifications de la pile avant d'appliquer le jeu de modifications. Cette commande crée un jeu de modifications CloudFormation puis se termine sans appliquer le jeu de modifications. Pour appliquer le jeu de modifications, exécutez la même commande sans cette option. `--no-progressbar` N’affichez pas de barre de progression lors du téléchargement d’artefacts sur Amazon S3. `--notification-arns LIST` Liste des rubriques Amazon Simple Notification Service (Amazon SNS) ARNs associées à la CloudFormation pile. `--on-failure [ROLLBACK | DELETE | DO_NOTHING]` Spécifiez l'action à entreprendre lorsqu'une pile ne peut pas être créée. Les options suivantes sont disponibles : + `ROLLBACK` – Récupère la pile à un état antérieur connu et valide. + `DELETE` – Récupère la pile à un état antérieur connu et valide, s'il en existe un. Sinon, supprime la pile. + `DO_NOTHING` – Ne récupère ni ne supprime la pile. L'effet est le même que celui de `--disable-rollback`. Le comportement par défaut est `ROLLBACK`. Vous pouvez spécifier l'`--disable-rollback`option ou l'`--on-failure`option, mais pas les deux. `--parameter-overrides LIST` Chaîne contenant des remplacements de CloudFormation paramètres codés sous forme de paires clé-valeur. Chaque remplacement utilise le format. `ParameterKey=name,ParameterValue=value` Les remplacements multiples sont séparés par des espaces. Voici deux exemples : ``` $ sam deploy --parameter-overrides ParameterKey=value1,ParameterValue=value2 ``` ``` $ sam deploy --parameter-overrides ParameterKey=value1,ParameterValue=value2 ParameterKey=hello,ParameterValue=world ParameterKey=apple,ParameterValue=banana ``` `--profile TEXT` Le profil spécifique de votre fichier d'informations d'identification qui obtient les AWS informations d'identification. `--region TEXT` Le Région AWS vers lequel déployer. Par exemple, us-east-1. `--resolve-image-repos` Créez automatiquement des référentiels Amazon ECR à utiliser pour l’empaquetage et le déploiement de déploiements non guidés. Cette option s’applique uniquement aux fonctions et aux couches avec un `PackageType: Image` spécifié. Si vous spécifiez l'option `--guided`, la CLI  AWS SAM ignore `--resolve-image-repos`. Si vous créez AWS SAM automatiquement des référentiels Amazon ECR pour des fonctions ou des couches avec cette option, et que vous supprimez ultérieurement ces fonctions ou couches de votre AWS SAM modèle, les référentiels Amazon ECR correspondants sont automatiquement supprimés. `--resolve-s3` Créez automatiquement un compartiment Amazon S3 à utiliser pour l’empaquetage et le déploiement de déploiements non guidés. Si vous spécifiez l'option `--guided`, l'interface CLI AWS SAM ignore `--resolve-s3`. Si vous spécifiez les deux options `--s3-bucket` et `--resolve-s3`, une erreur se produit. `--role-arn TEXT` Nom de ressource Amazon (ARN) d'un rôle IAM CloudFormation assumé lors de l'application de l'ensemble de modifications. `--s3-bucket TEXT` Le nom du compartiment Amazon S3 dans lequel cette commande télécharge votre CloudFormation modèle. Si le modèle a une taille supérieure à 51 200 octets, l'option `--s3-bucket` ou l'option `--resolve-s3` est obligatoire. Si vous spécifiez les deux options `--s3-bucket` et `--resolve-s3`, une erreur se produit. `--s3-prefix TEXT` Le préfixe ajouté aux noms des artefacts téléchargés vers le compartiment Amazon S3. Le nom du préfixe est un nom de chemin d'accès (nom de dossier) pour le compartiment Amazon S3. `--save-params` Enregistrez les paramètres que vous fournissez sur la ligne de commande dans le fichier AWS SAM de configuration. `--signing-profiles LIST` Liste des profils de signature pour signer les packages de déploiement. Cette option prend une liste de paires valeur clé, où la clé est le nom de la fonction ou de la couche à signer et la valeur est le profil de signature, avec un propriétaire de profil optionnel délimité par `:`. Par exemple, `FunctionNameToSign=SigningProfileName1 LayerNameToSign=SigningProfileName2:SigningProfileOwner`. `--stack-name TEXT` (Obligatoire) Le nom de la CloudFormation pile sur laquelle vous effectuez le déploiement. Si vous spécifiez une pile existante, la commande met à jour la pile. Si vous spécifiez une nouvelle pile, celle-ci est créée par la commande. `--tags LIST` Liste de balises à associer à la pile créée ou mise à jour. CloudFormation propage également ces balises aux ressources de la pile qui les supportent. `--template-file, --template, -t PATH` Le chemin et le nom du fichier où se trouve votre AWS SAM modèle. Si vous spécifiez cette option, AWS SAM déploie uniquement le modèle et les ressources locales vers lesquels il pointe. `--use-json` Sortie JSON pour le CloudFormation modèle. La sortie par défaut est YAML. ## Exemple Pour un exemple détaillé et une présentation détaillée de l'utilisation de la `sam deploy` sous-commande, reportez-vous à. [Présentation du déploiement avec AWS SAM](using-sam-cli-deploy.md) # sam init Cette page fournit des informations de référence pour la AWS Serverless Application Model commande Command Line Interface (AWS SAMCLI)`sam init`. + Pour une introduction à la AWS SAMCLI, voir [Qu'est-ce que c'est AWS SAMCLI ?](what-is-sam-overview.md#what-is-sam-cli) + Pour obtenir de la documentation sur l'utilisation de la AWS SAMCLI `sam init` commande, consultez[Créez votre application dans AWS SAM](using-sam-cli-init.md). La commande `sam init` fournit des options pour initialiser une nouvelle application sans serveur. ## Usage ``` $ sam init ``` ## Options `--app-template TEXT` L’identificateur du modèle d’application gérée que vous souhaitez utiliser. En cas de doute, appelez `sam init` sans options pour un flux interactif. Ce paramètre est obligatoire si `--no-interactive` est spécifié et que `--location` n'est pas fourni. Ce paramètre est uniquement disponible dans la version 0.30.0 et ultérieures de la CLI  AWS SAM. La spécification de ce paramètre avec une version antérieure une erreur se produit. `--application-insights | --no-application-insights` Activez la surveillance Amazon CloudWatch Application Insights pour votre application. Pour en savoir plus, veuillez consulter la section [Utilisation d' CloudWatch Application Insights pour surveiller vos applications AWS SAM sans serveur](monitor-app-insights.md). L'option par défaut est `--no-application-insights`. `--architecture, -a [ x86_64 | arm64 ]` Architecture du jeu d’instructions pour les fonctions Lambda de l’application. Spécifiez l’un des `x86_64` ou `arm64`. `--base-image [ amazon/dotnet8-base | amazon/dotnet6-base | amazon/java25-base | amazon/java21-base | amazon/java17-base | amazon/java11-base | amazon/nodejs24.x-base | amazon/nodejs22.x-base | amazon/nodejs20.x-base | amazon/nodejs18.x-base | amazon/nodejs16.x-base | amazon/python3.14-base | amazon/python3.13-base | amazon/python3.12-base | amazon/python3.11-base | amazon/python3.10-base | amazon/python3.9-base | amazon/python3.8-base | amazon/ruby3.4-base | amazon/ruby3.3-base | amazon/ruby3.2-base ]` L’image de base de l’application. Cette option s'applique uniquement lorsque le type de package est `Image`. Ce paramètre est obligatoire si `--no-interactive` est spécifié, `--package-type` est spécifié comme `Image` et `--location` n’est pas spécifié. `--config-env TEXT` Le nom d’environnement spécifiant les valeurs de paramètre par défaut dans le fichier de configuration à utiliser. La valeur par défaut est « par défaut ». Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--config-file PATH` Le chemin d'accès et le nom du fichier de configuration contenant les valeurs de paramètres par défaut à utiliser. La valeur par défaut est « samconfig.toml » dans la racine du répertoire du projet. Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--debug` Active la journalisation de débogage pour imprimer les messages de débogage générés par la CLI  AWS SAM et pour afficher les horodatages. `--dependency-manager, -d [ gradle | mod | maven | bundler | npm | cli-package | pip ]` Le gestionnaire de dépendances de l’exécution Lambda. `--extra-content` Remplacez tous les paramètres personnalisés dans la configuration du modèle `cookiecutter.json`, par exemple, `{"customParam1": "customValue1", "customParam2":"customValue2"}` `--help, -h` Affiche ce message, puis se ferme. `--location, -l TEXT` Le modèle ou l’emplacement de l’application (Git, Mercurial, HTTP/HTTPS, fichier .zip, chemin d’accès). Ce paramètre est obligatoire si `--no-interactive` est spécifié et `--runtime`, `--name` et `--app-template` ne sont pas fournis. Pour les référentiels Git, vous devez utiliser l’emplacement de la racine du référentiel. Pour les chemins d’accès locaux, le modèle doit être dans un fichier .zip ou en format [Cookiecutter](https://cookiecutter.readthedocs.io/en/latest/README.html). `--name, -n TEXT` Le nom du projet à générer en tant que répertoire. Ce paramètre est obligatoire si `--no-interactive` est spécifié et `--location` n’est pas fourni. `--no-input` Désactive l’invite Cookiecutter et accepte les valeurs vcfdefault définies dans la configuration du modèle. `--no-interactive` Désactivez l’invite interactive pour les paramètres de démarrage et attendez si des valeurs requises sont manquantes. `--output-dir, -o PATH` L’emplacement où l’application initialisée est sortie. `--package-type [ Zip | Image ]` Le type de package de l’exemple d’application. `Zip` crée une archive de fichiers .zip, puis `Image` crée une image de conteneur. `--runtime, -r [ dotnet8 | dotnet6 | java25 | java21 | java17 | java11 | nodejs24.x | nodejs22.x | nodejs20.x | nodejs18.x | nodejs16.x | python3.14 | python3.13 | python3.12 | python3.11 | python3.10 | python3.9 | python3.8 | ruby3.4 | ruby3.3 | ruby3.2 ]` L’exécution Lambda de l’application. Cette option s’applique uniquement lorsque le type de package est `Zip`. Ce paramètre est obligatoire si `--no-interactive` est spécifié, `--package-type` est spécifié comme `Zip` et `--location` n’est pas spécifié. `--save-params` Enregistrez les paramètres que vous fournissez sur la ligne de commande dans le fichier AWS SAM de configuration. `--tracing | --no-tracing` Activez le AWS X-Ray suivi pour vos fonctions Lambda. ## Exemple Pour un exemple détaillé et une présentation détaillée de l'utilisation de la `sam init` sous-commande, reportez-vous à. [Créez votre application dans AWS SAM](using-sam-cli-init.md) # sam list Cette page fournit des informations de référence pour la AWS Serverless Application Model commande Command Line Interface (AWS SAMCLI)`sam list`. Pour une introduction à la AWS SAMCLI, voir [Qu'est-ce que c'est AWS SAMCLI ?](what-is-sam-overview.md#what-is-sam-cli) La `sam list` commande génère des informations importantes sur les ressources de votre application sans serveur et sur son état. Utiliser **sam list** avant et après le déploiement pour faciliter le développement local et dans le cloud. ## Usage ``` $ sam list ``` ## Options `--help, -h` Affichez ce message et quittez. ## Sous-commandes `endpoints` Affiche la liste des points de terminaison cloud et locaux de votre CloudFormation stack. Pour de plus amples informations, veuillez consulter [sam list endpoints](sam-cli-command-reference-sam-list-endpoints.md). `resources` Affiche les ressources de votre modèle AWS Serverless Application Model (AWS SAM) créées AWS CloudFormation lors du déploiement. Pour de plus amples informations, veuillez consulter [sam list resources](sam-cli-command-reference-sam-list-resources.md). `stack-outputs` Affiche les sorties de votre CloudFormation pile à partir d'un CloudFormation modèle AWS SAM or. Pour de plus amples informations, veuillez consulter [sam list stack-outputs](sam-cli-command-reference-sam-list-stack-outputs.md). # sam list endpoints Cette page fournit des informations de référence pour la AWS Serverless Application Model `sam list endpoints` sous-commande Command Line Interface (AWS SAMCLI). Pour une introduction à la AWS SAMCLI, voir [Qu'est-ce que c'est AWS SAMCLI ?](what-is-sam-overview.md#what-is-sam-cli) La `sam list endpoints` sous-commande affiche une liste des points de terminaison cloud et locaux de votre CloudFormation stack. Vous pouvez interagir avec ces ressources à l'aide des commandes **sam local** et **sam sync**. AWS Lambda et les types de ressources Amazon API Gateway sont pris en charge par cette commande. **Note** Les domaines personnalisés sont pris en charge lorsqu'ils sont configurés pour vos ressources Amazon API Gateway. Cette commande affichera le domaine personnalisé au lieu du point de terminaison par défaut. ## Usage ``` $ sam list endpoints ``` ## Options `--config-env TEXT` Le nom d’environnement spécifiant les valeurs de paramètre par défaut dans le fichier de configuration à utiliser. *Valeur par défaut* : `default` Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--config-file TEXT` Le chemin d’accès et le nom du fichier de configuration contenant les valeurs de paramètres par défaut à utiliser. *Valeur par défaut* : `samconfig.toml` dans le répertoire de travail actuel. Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--debug` Active la journalisation de débogage pour imprimer le message de débogage généré par la CLI  AWS SAM avec les horodatages. `--help, -h` Affichez ce message et quittez. `--output [json|table]` Spécifiez le format de sortie des résultats. *Valeur par défaut* : `table` `--profile TEXT` Sélectionnez un profil spécifique dans votre fichier d'informations d'identification pour obtenir des AWS informations d'identification. `--region TEXT` Définissez la AWS région du service. Par exemple, `us-east-1`. `--save-params` Enregistrez les paramètres que vous fournissez sur la ligne de commande dans le fichier AWS SAM de configuration. `--stack-name TEXT` Nom de la CloudFormation pile déployée. Le nom de la pile se trouve dans le fichier `samconfig.toml` de votre application ou dans le fichier de configuration désigné. Lorsque cette option n'est pas spécifiée, les ressources locales définies dans votre modèle s'affichent. `--template-file, --template, -t PATH` AWS SAM fichier modèle. *Valeur par défaut* : `template.[yaml|yml|json]` ## Exemples Affichez une sortie, au format json, des points de terminaison des ressources déployées à partir de votre CloudFormation pile nommée`test-stack`. ``` $ sam list endpoints --stack-name test-stack --output json [ { "LogicalResourceId": "HelloWorldFunction", "PhysicalResourceId": "sam-app-test-list-HelloWorldFunction-H85Y7yIV7ZLq", "CloudEndpoint": "https://zt55oi7kbljxjmcoahsj3cknwu0rposq.lambda-url.us-east-1.on.aws/", "Methods": "-" }, { "LogicalResourceId": "ServerlessRestApi", "PhysicalResourceId": "uj80uoe2o2", "CloudEndpoint": [ "https://uj80uoe2o2.execute-api.us-east-1.amazonaws.com/Prod", "https://uj80uoe2o2.execute-api.us-east-1.amazonaws.com/Stage" ], "Methods": [ "/hello['get']" ] } ] ``` # sam list resources Cette page fournit des informations de référence pour la AWS Serverless Application Model `sam list resources` sous-commande Command Line Interface (AWS SAMCLI). Pour une introduction à la AWS SAMCLI, voir [Qu'est-ce que c'est AWS SAMCLI ?](what-is-sam-overview.md#what-is-sam-cli) La `sam list resources` sous-commande affiche les ressources de votre modèle AWS Serverless Application Model (AWS SAM) créées AWS CloudFormation par la AWS SAM transformation lors du déploiement. **sam list resources**À utiliser avec un AWS SAM modèle avant le déploiement pour voir les ressources qui seront créées. Entrez un nom de CloudFormation pile pour afficher une liste consolidée incluant les ressources déployées. **Note** Pour générer une liste de ressources à partir de votre AWS SAM modèle, une transformation locale de votre modèle est effectuée. Les ressources qui seront déployées sous certaines conditions, par exemple dans une région spécifique, sont incluses dans cette liste. ## Usage ``` $ sam list resources ``` ## Options `--config-env TEXT` Le nom d’environnement spécifiant les valeurs de paramètre par défaut dans le fichier de configuration à utiliser. *Valeur par défaut* : `default` Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--config-file TEXT` Le chemin d’accès et le nom du fichier de configuration contenant les valeurs de paramètres par défaut à utiliser. *Valeur par défaut* : `samconfig.toml` dans le répertoire de travail actuel. Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--debug` Active la journalisation de débogage pour imprimer le message de débogage généré par la CLI  AWS SAM avec les horodatages. `--help, -h` Affichez ce message et quittez. `--output [json|table]` Spécifiez le format de sortie des résultats. *Valeur par défaut* : `table` `--profile TEXT` Sélectionnez un profil spécifique dans votre fichier d'informations d'identification pour obtenir des AWS informations d'identification. `--region TEXT` Définissez la AWS région du service. Par exemple, `us-east-1`. `--save-params` Enregistrez les paramètres que vous fournissez sur la ligne de commande dans le fichier AWS SAM de configuration. `--stack-name TEXT` Nom de la CloudFormation pile déployée. Le nom de la pile se trouve dans le fichier `samconfig.toml` de votre application ou dans le fichier de configuration désigné. Lorsqu'elle est fournie, la logique IDs des ressources de votre modèle sera mappée à leur entrée physique IDs correspondante. CloudFormation Pour en savoir plus sur les ressources physiques IDs, consultez la section [Champs de ressources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-resource-fields) dans le *guide de AWS CloudFormation l'utilisateur*. Lorsque cette option n'est pas spécifiée, les ressources locales définies dans votre modèle s'affichent. `--template-file, --template, -t PATH` AWS SAM fichier modèle. *Valeur par défaut* : `template.[yaml|yml|json]` ## Exemples Affichez une sortie, sous forme de tableau, des ressources locales de votre AWS SAM modèle et des ressources déployées à partir de votre CloudFormation pile nommée`test-stack`. Exécuter à partir du même répertoire que votre fichier local. ``` $ sam list resources --stack-name test-stack --output table ------------------------------------------------------------------------------------------------------------------------- Logical ID Physical ID ------------------------------------------------------------------------------------------------------------------------- HelloWorldFunction sam-app-test-list-HelloWorldFunction-H85Y7yIV7ZLq HelloWorldFunctionHelloWorldPermissionProd sam-app-test-list- HelloWorldFunctionHelloWorldPermissionProd-1QH7CPOCBL2IK HelloWorldFunctionRole sam-app-test-list-HelloWorldFunctionRole-SRJDMJ6F7F41 ServerlessRestApi uj80uoe2o2 ServerlessRestApiDeployment47fc2d5f9d pncw5f ServerlessRestApiProdStage Prod ServerlessRestApiDeploymentf5716dc08b - ------------------------------------------------------------------------------------------------------------------------- ``` # sam list stack-outputs Cette page fournit des informations de référence pour la AWS Serverless Application Model `sam list stack-outputs` sous-commande Command Line Interface (AWS SAMCLI). Pour une introduction à la AWS SAMCLI, voir [Qu'est-ce que c'est AWS SAMCLI ?](what-is-sam-overview.md#what-is-sam-cli) La `sam list stack-outputs` sous-commande affiche les sorties de votre AWS CloudFormation pile à partir d'un AWS Serverless Application Model (AWS SAM) ou d'un CloudFormation modèle. Pour plus d'informations sur `Outputs`, consultez [Sorties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/outputs-section-structure.html) dans le *Guide de l'utilisateur AWS CloudFormation *. ## Usage ``` $ sam list stack-outputs ``` ## Options `--config-env TEXT` Le nom d’environnement spécifiant les valeurs de paramètre par défaut dans le fichier de configuration à utiliser. *Valeur par défaut* : `default` Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--config-file TEXT` Le chemin d’accès et le nom du fichier de configuration contenant les valeurs de paramètres par défaut à utiliser. *Valeur par défaut* : `samconfig.toml` dans le répertoire de travail actuel. Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--debug` Active la journalisation de débogage pour imprimer le message de débogage généré par la CLI  AWS SAM avec les horodatages. `--help, -h` Affichez ce message et quittez. `--output [json|table]` Spécifiez le format de sortie des résultats. *Valeur par défaut* : `table` `--profile TEXT` Sélectionnez un profil spécifique dans votre fichier d'informations d'identification pour obtenir des AWS informations d'identification. `--region TEXT` Définissez la AWS région du service. Par exemple, `us-east-1`. `--save-params` Enregistrez les paramètres que vous fournissez sur la ligne de commande dans le fichier AWS SAM de configuration. `--stack-name TEXT` Nom de la CloudFormation pile déployée. Le nom de la pile se trouve dans le fichier `samconfig.toml` de votre application ou dans le fichier de configuration désigné. Cette option est obligatoire. ## Exemples Affiche les sorties, sous forme de tableau, des ressources de votre CloudFormation pile nommée`test-stack`. ``` $ sam list stack-outputs --stack-name test-stack --output table ------------------------------------------------------------------------------------------------------------------------ OutputKey OutputValue Description ------------------------------------------------------------------------------------------------------------------------ HelloWorldFunctionIamRole arn:aws:iam::account-number:role/sam- Implicit IAM Role created for Hello app-test-list-HelloWorldFunctionRole- World function SRJDMJ6F7F41 HelloWorldApi https://uj80uoe2o2.execute-api.us- API Gateway endpoint URL for Prod east-1.amazonaws.com/Prod/hello/ stage for Hello World function HelloWorldFunction arn:aws:lambda:us- Hello World Lambda Function ARN east-1:account-number:function:sam-app- test-list- HelloWorldFunction-H85Y7yIV7ZLq ------------------------------------------------------------------------------------------------------------------------ ``` # sam local callback Cette page fournit des informations de référence pour la AWS Serverless Application Model commande Command Line Interface (AWS SAMCLI)`sam local callback`. Pour une introduction à la AWS SAMCLI, voir [Qu'est-ce que c'est AWS SAMCLI ?](what-is-sam-overview.md#what-is-sam-cli) La `sam local callback` commande vous permet d'envoyer des rappels aux exécutions de fonctions durables locales pendant le développement et les tests. ## Usage ``` $ sam local callback ``` ## Options `--help, -h` Affichez ce message et quittez. ## Sous-commandes `succeed` Envoyez un rappel de réussite à l'exécution d'une fonction durable. Pour de plus amples informations, veuillez consulter [sam local callback succeed](sam-cli-command-reference-sam-local-callback-succeed.md). `fail` Envoyez un rappel d'échec à une exécution de fonction durable. Pour de plus amples informations, veuillez consulter [sam local callback fail](sam-cli-command-reference-sam-local-callback-fail.md). `heartbeat` Envoyez un rappel du rythme cardiaque à une exécution de fonction durable. Pour de plus amples informations, veuillez consulter [sam local callback heartbeat](sam-cli-command-reference-sam-local-callback-heartbeat.md). # sam local callback succeed Envoyez un rappel de réussite à l'exécution d'une fonction durable. ## Usage ``` $ sam local callback succeed CALLBACK_ID [OPTIONS] ``` ## Arguments obligatoires `CALLBACK_ID` Identifiant unique du rappel auquel envoyer une réponse positive. ## Options `-r, --result TEXT` Charge utile du résultat de réussite sous forme de chaîne. `--region TEXT` Définissez la AWS région du service (par exemple,`us-east-1`). `--profile TEXT` Sélectionnez un profil spécifique dans votre fichier d'informations d'identification pour obtenir des AWS informations d'identification. `--config-env TEXT` Nom de l'environnement spécifiant les valeurs des paramètres par défaut dans le fichier de configuration. Valeur par défaut : `default` `--config-file TEXT` Fichier de configuration contenant les valeurs des paramètres par défaut. Valeur par défaut : `samconfig.toml` `--save-params` Enregistrez les paramètres fournis via la ligne de commande dans le fichier de configuration. `--beta-features / --no-beta-features` Activer/désactiver les fonctionnalités bêta. `--debug` Activez la journalisation du débogage pour imprimer les messages de débogage générés par la AWS SAM CLI et afficher les horodatages. `-h, --help` Affiche ce message, puis se ferme. ## Exemples Envoyer un rappel de réussite sans résultat : ``` $ sam local callback succeed my-callback-id ``` Envoyer un rappel de réussite avec le résultat : ``` $ sam local callback succeed my-callback-id --result 'Task completed successfully' ``` Envoyer un rappel de réussite avec une option courte : ``` $ sam local callback succeed my-callback-id -r 'Success result' ``` # sam local callback fail Envoyez un rappel d'échec à une exécution de fonction durable. ## Usage ``` $ sam local callback fail CALLBACK_ID [OPTIONS] ``` ## Arguments obligatoires `CALLBACK_ID` Identifiant unique du rappel auquel envoyer une réponse d'échec. ## Options `--error-data TEXT` Données d'erreur supplémentaires. `--stack-trace TEXT` Empilez les entrées de suivi. Cette option peut être spécifiée plusieurs fois. `--error-type TEXT` Type d'erreur. `--error-message TEXT` Message d'erreur détaillé. `--region TEXT` Définissez la AWS région du service (par exemple,`us-east-1`). `--profile TEXT` Sélectionnez un profil spécifique dans votre fichier d'informations d'identification pour obtenir des AWS informations d'identification. `--config-env TEXT` Nom de l'environnement spécifiant les valeurs des paramètres par défaut dans le fichier de configuration. Valeur par défaut : `default` `--config-file TEXT` Fichier de configuration contenant les valeurs des paramètres par défaut. Valeur par défaut : `samconfig.toml` `--save-params` Enregistrez les paramètres fournis via la ligne de commande dans le fichier de configuration. `--beta-features / --no-beta-features` Activer/désactiver les fonctionnalités bêta. `--debug` Activez la journalisation du débogage pour imprimer les messages de débogage générés par la AWS SAM CLI et afficher les horodatages. `-h, --help` Affiche ce message, puis se ferme. ## Exemples Envoyer un rappel en cas d'échec sans paramètres : ``` $ sam local callback fail my-callback-id ``` Envoyer un rappel d'échec avec un message d'erreur : ``` $ sam local callback fail my-callback-id --error-message 'Task failed' ``` Envoyer un rappel en cas d'échec avec tous les paramètres : ``` $ sam local callback fail my-callback-id --error-message 'Task failed' --error-type 'ValidationError' --stack-trace 'at line 42' --error-data '{"code": 500}' ``` # sam local callback heartbeat Envoyez un rappel du rythme cardiaque à une exécution de fonction durable. ## Usage ``` $ sam local callback heartbeat CALLBACK_ID [OPTIONS] ``` ## Arguments obligatoires `CALLBACK_ID` Identifiant unique du rappel auquel envoyer un battement de cœur. ## Options `--region TEXT` Définissez la AWS région du service (par exemple,`us-east-1`). `--profile TEXT` Sélectionnez un profil spécifique dans votre fichier d'informations d'identification pour obtenir des AWS informations d'identification. `--config-env TEXT` Nom de l'environnement spécifiant les valeurs des paramètres par défaut dans le fichier de configuration. Valeur par défaut : `default` `--config-file TEXT` Fichier de configuration contenant les valeurs des paramètres par défaut. Valeur par défaut : `samconfig.toml` `--save-params` Enregistrez les paramètres fournis via la ligne de commande dans le fichier de configuration. `--beta-features / --no-beta-features` Activer/désactiver les fonctionnalités bêta. `--debug` Activez la journalisation du débogage pour imprimer les messages de débogage générés par la AWS SAM CLI et afficher les horodatages. `-h, --help` Affiche ce message, puis se ferme. ## Exemples Envoyer un rappel du rythme cardiaque : ``` $ sam local callback heartbeat my-callback-id ``` # sam local execution Cette page fournit des informations de référence pour la AWS Serverless Application Model commande Command Line Interface (AWS SAMCLI)`sam local execution`. Pour une introduction à la AWS SAMCLI, voir [Qu'est-ce que c'est AWS SAMCLI ?](what-is-sam-overview.md#what-is-sam-cli) La `sam local execution` commande vous permet de gérer et d'inspecter les exécutions de fonctions durables locales pendant le développement et les tests. **Note** Il est possible que ces commandes ne nécessitent pas l'accès aux AWS informations d'identification. ## Usage ``` $ sam local execution ``` ## Options `--help, -h` Affichez ce message et quittez. ## Sous-commandes `get` Obtenez des informations sur l'exécution durable d'une fonction. Pour de plus amples informations, veuillez consulter [sam local execution get](sam-cli-command-reference-sam-local-execution-get.md). `history` Obtenez l'historique d'exécution d'une fonction durable. Pour de plus amples informations, veuillez consulter [sam local execution history](sam-cli-command-reference-sam-local-execution-history.md). `stop` Arrêtez l'exécution d'une fonction durable. Pour de plus amples informations, veuillez consulter [sam local execution stop](sam-cli-command-reference-sam-local-execution-stop.md). # sam local execution get Récupérez les détails de l'exécution d'une fonction durable spécifique. **Note** Il est possible que cette commande ne nécessite pas d'accès aux AWS informations d'identification. ## Usage ``` $ sam local execution get DURABLE_EXECUTION_ARN [OPTIONS] ``` ## Arguments obligatoires `DURABLE_EXECUTION_ARN` Le nom de ressource Amazon (ARN) de la fonction durable à exécuter pour laquelle vous souhaitez obtenir des informations. ## Options `--format [summary|json]` Format de la sortie. Valeur par défaut : `summary` `--region TEXT` Définissez la AWS région du service (par exemple,`us-east-1`). `--profile TEXT` Sélectionnez un profil spécifique dans votre fichier d'informations d'identification pour obtenir des AWS informations d'identification. `--config-env TEXT` Nom de l'environnement spécifiant les valeurs des paramètres par défaut dans le fichier de configuration. Valeur par défaut : `default` `--config-file TEXT` Fichier de configuration contenant les valeurs des paramètres par défaut. Valeur par défaut : `samconfig.toml` `--save-params` Enregistrez les paramètres fournis via la ligne de commande dans le fichier de configuration. `--beta-features / --no-beta-features` Activer/désactiver les fonctionnalités bêta. `--debug` Activez la journalisation du débogage pour imprimer les messages de débogage générés par la AWS SAM CLI et afficher les horodatages. `-h, --help` Affiche ce message, puis se ferme. ## Exemples Obtenez les détails de l'exécution avec le format de résumé par défaut : ``` $ sam local execution get arn:aws:lambda:us-east-1:123456789012:function:MyFunction:$LATEST/durable-execution/my-execution-name/my-execution-id ``` Obtenez les détails de l'exécution au format JSON : ``` $ sam local execution get arn:aws:lambda:us-east-1:123456789012:function:MyFunction:$LATEST/durable-execution/my-execution-name/my-execution-id --format json ``` # sam local execution history Obtenez l'historique d'exécution d'une fonction durable. ## Usage ``` $ sam local execution history EXECUTION_ID [OPTIONS] ``` ## Arguments obligatoires `EXECUTION_ID` Identifiant unique de l'exécution de la fonction durable pour laquelle il faut récupérer l'historique. ## Options `--format [table|json]` Format de la sortie. Valeur par défaut : `table` `--region TEXT` Définissez la AWS région du service (par exemple,`us-east-1`). `--profile TEXT` Sélectionnez un profil spécifique dans votre fichier d'informations d'identification pour obtenir des AWS informations d'identification. `--config-env TEXT` Nom de l'environnement spécifiant les valeurs des paramètres par défaut dans le fichier de configuration. Valeur par défaut : `default` `--config-file TEXT` Fichier de configuration contenant les valeurs des paramètres par défaut. Valeur par défaut : `samconfig.toml` `--save-params` Enregistrez les paramètres fournis via la ligne de commande dans le fichier de configuration. `--beta-features / --no-beta-features` Activer/désactiver les fonctionnalités bêta. `--debug` Activez la journalisation du débogage pour imprimer les messages de débogage générés par la AWS SAM CLI et afficher les horodatages. `-h, --help` Affiche ce message, puis se ferme. ## Exemples Obtenez l'historique des exécutions sous forme de tableau : ``` $ sam local execution history my-execution-id ``` Obtenez l'historique des exécutions au format JSON : ``` $ sam local execution history my-execution-id --format json ``` # sam local execution stop Arrêtez l'exécution d'une fonction durable en cours d'exécution. **Note** Il est possible que cette commande ne nécessite pas d'accès aux AWS informations d'identification. ## Usage ``` $ sam local execution stop DURABLE_EXECUTION_ARN [OPTIONS] ``` ## Arguments obligatoires `DURABLE_EXECUTION_ARN` L'Amazon Resource Name (ARN) de l'exécution de la fonction durable à arrêter. ## Options `--error-message TEXT` Message d'erreur à associer à l'arrêt de l'exécution. `--error-type TEXT` Type d'erreur à associer à l'arrêt de l'exécution. `--error-data TEXT` Données d'erreur à associer à l'arrêt de l'exécution. `--stack-trace TEXT` Empilez les entrées de suivi. Cette option peut être spécifiée plusieurs fois. `--region TEXT` Définissez la AWS région du service (par exemple,`us-east-1`). `--profile TEXT` Sélectionnez un profil spécifique dans votre fichier d'informations d'identification pour obtenir des AWS informations d'identification. `--config-env TEXT` Nom de l'environnement spécifiant les valeurs des paramètres par défaut dans le fichier de configuration. Valeur par défaut : `default` `--config-file TEXT` Fichier de configuration contenant les valeurs des paramètres par défaut. Valeur par défaut : `samconfig.toml` `--save-params` Enregistrez les paramètres fournis via la ligne de commande dans le fichier de configuration. `--beta-features / --no-beta-features` Activer/désactiver les fonctionnalités bêta. `--debug` Activez la journalisation du débogage pour imprimer les messages de débogage générés par la AWS SAM CLI et afficher les horodatages. `-h, --help` Affiche ce message, puis se ferme. ## Exemples Arrêtez l'exécution sans informations détaillées sur l'erreur : ``` $ sam local execution stop arn:aws:lambda:us-east-1:123456789012:function:MyFunction:$LATEST/durable-execution/my-execution-name/my-execution-id ``` Arrêtez l'exécution avec un message d'erreur et tapez : ``` $ sam local execution stop arn:aws:lambda:us-east-1:123456789012:function:MyFunction:$LATEST/durable-execution/my-execution-name/my-execution-id --error-message "Execution cancelled" --error-type "UserCancellation" ``` Arrêtez l'exécution en indiquant tous les détails de l'erreur et en enregistrant la trace : ``` $ sam local execution stop arn:aws:lambda:us-east-1:123456789012:function:MyFunction:$LATEST/durable-execution/my-execution-name/my-execution-id --error-message "Task failed" --error-type "TaskFailure" --error-data '{"reason":"timeout"}' --stack-trace "at function1()" --stack-trace "at function2()" ``` # sam local generate-event Cette page fournit des informations de référence pour la AWS Serverless Application Model `sam local generate-event` sous-commande Command Line Interface (AWS SAMCLI). + Pour une introduction à la AWS SAMCLI, voir [Qu'est-ce que c'est AWS SAMCLI ?](what-is-sam-overview.md#what-is-sam-cli) + Pour obtenir de la documentation sur l'utilisation de la AWS SAMCLI `sam local generate-event` commande, consultez[Présentation des tests avec sam local generate-event](using-sam-cli-local-generate-event.md). La sous-commande `sam local generate-event` génère des échantillons d’évènement de charge utile pour Services AWS prise en charge. ## Usage ``` $ sam local generate-event ``` ## Options `--config-env TEXT` Le nom d’environnement spécifiant les valeurs de paramètre par défaut dans le fichier de configuration à utiliser. La valeur par défaut est « par défaut ». Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--config-file PATH` Le chemin d'accès et le nom du fichier de configuration contenant les valeurs de paramètres par défaut à utiliser. La valeur par défaut est `samconfig.toml` à la racine du répertoire du projet. Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--help` Affiche ce message, puis se ferme. ## Service Pour obtenir la liste des services pris en charge, exécutez la procédure suivante : ``` $ sam local generate-event ``` ## Événement Pour obtenir la liste des événements pris en charge pouvant être générés pour chaque service, exécutez la procédure suivante : ``` $ sam local generate-event ``` ## Options d'événement Pour obtenir une liste des options d'événement prises en charge que vous pouvez modifier, exécutez la procédure suivante : ``` $ sam local generate-event --help ``` ## Exemples Pour des exemples d'utilisation de la `sam local generate-event` sous-commande, reportez-vous à[Générer des exemples d'événements](using-sam-cli-local-generate-event.md#using-sam-cli-local-generate-event-generate). # sam local invoke Cette page fournit des informations de référence pour la AWS Serverless Application Model `sam local invoke` sous-commande Command Line Interface (AWS SAMCLI). + Pour une introduction à la AWS SAMCLI, voir [Qu'est-ce que c'est AWS SAMCLI ?](what-is-sam-overview.md#what-is-sam-cli) + Pour obtenir de la documentation sur l'utilisation de la AWS SAMCLI `sam local invoke` sous-commande, consultez[Présentation des tests avec sam local invoke](using-sam-cli-local-invoke.md). La `sam local invoke` sous-commande lance un appel unique d'une fonction localement. AWS Lambda **Note** Il n'est pas recommandé d'utiliser les fonctionnalités d'appel local de la SAM CLI dans du code non fiable. Pour vous isoler complètement de votre environnement local, exécutez le code directement dans le service Lambda. **Note** Pour des fonctions durables, `sam local invoke` prend en charge l'exécution dynamique avec pointage automatique et rediffusion. Le conteneur continue de fonctionner pendant l'exécution d'une fonction durable afin de gérer la persistance et la reprise de l'état. ## Usage ``` $ sam local invoke ``` **Note** Si plusieurs fonctions sont définies dans votre AWS SAM modèle, indiquez l'ID logique de la fonction que vous souhaitez invoquer. ## Arguments **ID de ressource** ID de la fonction Lambda à appeler. Cet argument est facultatif. Si votre application contient une seule fonction Lambda, la AWS SAM CLI l'invoquera. Si votre application contient plusieurs fonctions, indiquez l'ID de la fonction à invoquer. *Valeurs valides* : ID logique ou ARN de la ressource. ## Options `--add-host LIST` Transmet un mappage de nom d'hôte à adresse IP au fichier hôte du conteneur Docker. Ce paramètre peut être transmis plusieurs fois. **Example** Exemple : `--add-host example.com:127.0.0.1` `--beta-features | --no-beta-features` Autorisez ou refusez les fonctionnalités bêta. `--config-env TEXT` Le nom d’environnement spécifiant les valeurs de paramètre par défaut dans le fichier de configuration à utiliser. La valeur par défaut est « par défaut ». Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--config-file PATH` Le chemin d’accès et le nom du fichier de configuration contenant les valeurs de paramètres par défaut à utiliser. La valeur par défaut est « `samconfig.toml` » dans la racine du répertoire du projet. Pour plus d’informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--container-env-vars` (Facultatif) Transmettez les variables d’environnement au conteneur d’images de la fonction Lambda lors du débogage local. `--container-host TEXT` Hôte du conteneur Lambda émulé localement. La valeur par défaut est `localhost`. Si vous voulez exécuter la CLI  AWS SAM dans un conteneur Docker sous macOS, vous pouvez spécifier `host.docker.internal`. Si vous souhaitez exécuter le conteneur sur un autre hôte AWS SAMCLI, vous pouvez spécifier l'adresse IP de l'hôte distant. `--container-host-interface TEXT` L’adresse IP de l’interface de réseau hôte à laquelle les ports de conteneur doivent se relier. La valeur par défaut est `127.0.0.1`. Utiliser `0.0.0.0` pour se lier à toutes les interfaces. `--debug` Active la journalisation de débogage pour imprimer les messages de débogage générés par la CLI  AWS SAM et pour afficher les horodatages. `--debug-args TEXT` Arguments facultatifs à transmettre au débogueur. `--debug-port, -d TEXT` Si spécifié, cela démarre le conteneur de la fonction Lambda en mode débogage et expose ce port sur l’hôte local. `--debugger-path TEXT` Chemin d’accès de l’hôte vers un débogueur monté dans le conteneur Lambda. `--docker-network TEXT` Le nom ou l’identifiant d’un réseau Docker existant auquel les conteneurs Docker Lambda doivent se connecter, avec le réseau de pont par défaut. Si cela n’est pas spécifié, les conteneurs Lambda se connectent uniquement au réseau Docker de pont par défaut. `--docker-volume-basedir, -v TEXT` Emplacement du répertoire de base dans lequel se trouve le AWS SAM fichier. Si Docker est exécuté sur une machine distante, vous devez monter le chemin où se trouve le AWS SAM fichier sur la machine Docker et modifier cette valeur pour qu'elle corresponde à la machine distante. `--durable-execution-name TEXT` Nom de l'exécution durable (pour les fonctions durables uniquement) `--env-vars, -n PATH` Le `.env` fichier JSON ou contenant les valeurs des variables d'environnement de la fonction Lambda. Le format de fichier est automatiquement détecté. Pour plus d’informations sur les fichiers de variables d’environnement, consultez [Fichier de variable d'environnement](serverless-sam-cli-using-invoke.md#serverless-sam-cli-using-invoke-environment-file). `--event, -e PATH` Le fichier JSON qui contient les données d’événement transmises à la fonction Lambda lorsqu’elle est appelée. Si vous ne spécifiez pas cette option, aucun événement n’est assumé. Pour entrer JSON à partir de `stdin`, vous devez transmettre la valeur ’-’. Pour plus d'informations sur les formats de messages d'événements provenant de différents AWS services, consultez la section [Utilisation d'autres services](https://docs.aws.amazon.com/lambda/latest/dg/lambda-services.html) dans le *Guide du AWS Lambda développeur*. `--force-image-build` Spécifie si la CLI  AWS SAM doit recréer l'image utilisée pour invoquer les fonctions Lambda avec des couches. `--help` Affiche ce message, puis se ferme. `--hook-name TEXT` Nom du hook utilisé pour étendre la fonctionnalité de la CLI  AWS SAM. Valeurs acceptées : `terraform`. `--invoke-image TEXT` L’URI de l’image de conteneur que vous souhaitez utiliser pour l’appel de la fonction locale. Par défaut, AWS SAM extrait l'image du conteneur d'Amazon ECR Public (répertoriée dans[Référentiels d'images pour AWS SAM](serverless-image-repositories.md)). Utilisez cette option pour extraire l’image à partir d’un autre emplacement. Par exemple, `sam local invoke MyFunction --invoke-image amazon/aws-sam-cli-emulation-image-python3.8`. `--layer-cache-basedir DIRECTORY` Spécifie l’emplacement du répertoire de base dans lequel les couches utilisées par le modèle sont téléchargées. `--log-file, -l TEXT` Le fichier journal vers lequel envoyer les journaux d’exécution. `--mount-symlinks` Garantit le AWS SAMCLI montage permanent des liens symboliques présents dans les fichiers à créer ou à invoquer. Cela s'applique uniquement aux liens symboliques du répertoire de niveau supérieur (c'est-à-dire aux liens symboliques situés directement à la racine de la fonction). Par défaut, les liens symboliques ne sont pas montés, à l'exception de ceux nécessaires pour être utilisés `node_modules` dans `build-in-source` NodeJS. `--no-event` Appelle la fonction avec un événement vide. `--no-memory-limit` Supprime la limite de mémoire dans le conteneur lors de l'appel local, même lorsque la mémoire est configurée dans le AWS SAM modèle. `--parameter-overrides` Chaîne contenant des remplacements de CloudFormation paramètres codés sous forme de paires clé-valeur. Utilisez le même format que le AWS Command Line Interface (AWS CLI). Le AWS SAMCLI format est basé sur des mots clés et valeurs explicites, chaque remplacement étant séparé par un espace. Voici deux exemples : + `--parameter-overrides ParameterKey=hello,ParameterValue=world` + `--parameter-overrides ParameterKey=hello,ParameterValue=world ParameterKey=example1,ParameterValue=example2 ParameterKey=apple,ParameterValue=banana` `--profile TEXT` Le profil spécifique de votre fichier d'informations d'identification qui obtient les AWS informations d'identification. `--region TEXT` La AWS région dans laquelle le déploiement doit être effectué. Par exemple, us-east-1. `--runtime TEXT` Utilise le runtime spécifié pour appeler une fonction Lambda localement. Cela remplace le temps d'exécution défini dans le `template.yml` fichier. Cela permet également de tester les fonctions Lambda avec différents temps d'exécution sans modifier la configuration de la fonction d'origine. `--save-params` Enregistrez les paramètres que vous fournissez sur la ligne de commande dans le fichier AWS SAM de configuration. `--shutdown` Imite un événement d’arrêt une fois l’appel terminé, afin de tester la gestion des extensions du comportement d’arrêt. `--skip-prepare-infra` Ignore l'étape de préparation si aucune modification d'infrastructure n'a été apportée. À utiliser avec l'option `--hook-name`. `--skip-pull-image` Par défaut, la CLI  AWS SAM vérifie le dernier environnement d'exécution à distance de Lambda et met automatiquement à jour votre image locale pour rester synchronisée. Spécifiez cette option pour ne pas extraire la dernière image Docker de votre environnement d'exécution Lambda. `--template, -t PATH` Le fichier AWS SAM modèle. Cette option n'est pas compatible avec `--hook-name`. Si vous spécifiez cette option, AWS SAM charge uniquement le modèle et les ressources locales vers lesquels il pointe. `--tenant-id TEXT` L'ID de locataire pour les fonctions Lambda à locataires multiples. Utilisé pour garantir l'isolation informatique entre les différents locataires. Obligatoire lors de l'appel de fonctions configurées avec le mode d'isolation des locataires. `--terraform-plan-file` Le chemin relatif ou absolu vers votre fichier de plan Terraform local lorsque vous utilisez la CLI  AWS SAM avec Terraform Cloud. Cette option nécessite que `--hook-name` soit défini sur `terraform`. ## Exemples L'exemple suivant utilise un événement généré à des fins de test local en utilisant un `s3.json` événement pour appeler une fonction Lambda localement. ``` $ sam local invoke --event events/s3.json S3JsonLoggerFunction ``` L'exemple suivant teste la fonction à l'` HelloWorldFunction`aide de l'environnement d'exécution Python 3.11 ``` $ sam local invoke --runtime python3.11 HelloWorldFunction ``` L'exemple suivant teste la fonction ` HelloWorldFunction` avec un nom d'exécution durable ``` $ sam local invoke HelloWorldFunction --durable-execution-name my-execution ``` # sam local start-api Cette page fournit des informations de référence pour la AWS Serverless Application Model `sam local start-api` sous-commande Command Line Interface (AWS SAMCLI). + Pour une introduction à la AWS SAMCLI, voir [Qu'est-ce que c'est AWS SAMCLI ?](what-is-sam-overview.md#what-is-sam-cli) + Pour obtenir de la documentation sur l'utilisation de la AWS SAMCLI `sam local start-api` sous-commande, consultez[Présentation des tests avec sam local start-api](using-sam-cli-local-start-api.md). La `sam local start-api` sous-commande exécute vos AWS Lambda fonctions localement pour les tester via un hôte de serveur HTTP local. ## Usage ``` $ sam local start-api ``` ## Options `--add-host LIST` Transmet un mappage de nom d'hôte à adresse IP au fichier hôte du conteneur Docker. Ce paramètre peut être transmis plusieurs fois. **Example** Exemple : `--add-host example.com:127.0.0.1` `--beta-features | --no-beta-features` Autorisez ou refusez les fonctionnalités bêta. `--config-env TEXT` Le nom d’environnement spécifiant les valeurs de paramètre par défaut dans le fichier de configuration à utiliser. La valeur par défaut est « par défaut ». Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--config-file PATH` Le chemin d'accès et le nom du fichier de configuration contenant les valeurs de paramètres par défaut à utiliser. La valeur par défaut est « samconfig.toml » dans la racine du répertoire du projet. Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--container-env-vars` Facultatif. Transmettez les variables d’environnement au conteneur d’images lors du débogage local. `--container-host TEXT` Hôte du conteneur Lambda émulé localement. La valeur par défaut est `localhost`. Si vous voulez exécuter la CLI  AWS SAM dans un conteneur Docker sous macOS, vous pouvez spécifier `host.docker.internal`. Si vous souhaitez exécuter le conteneur sur un autre hôte AWS SAMCLI, vous pouvez spécifier l'adresse IP de l'hôte distant. `--container-host-interface TEXT` L’adresse IP de l’interface de réseau hôte à laquelle les ports de conteneur doivent se relier. La valeur par défaut est `127.0.0.1`. Utiliser `0.0.0.0` pour se lier à toutes les interfaces. `--debug` Active la journalisation de débogage pour imprimer le message de débogage généré par la CLI  AWS SAM et pour afficher les horodatages. `--debug-args TEXT` Arguments facultatifs à transmettre au débogueur. `--debug-function` Facultatif. Spécifie la fonction Lambda pour appliquer les options de débogage lorsque `--warm-containers`est spécifié. Ce paramètre s’applique à `--debug-port`, `--debugger-path` et `--debug-args`. `--debug-port, -d TEXT` Lorsque spécifié, démarre le conteneur de fonction Lambda en mode débogage et expose ce port sur l'hôte local. `--debugger-path TEXT` Le chemin d’accès de l’hôte vers un débogueur qui sera monté dans le conteneur Lambda. `--docker-network TEXT` Nom ou identifiant d’un réseau Docker existant auquel les conteneurs Docker Lambda devraient se connecter, avec le réseau de pont par défaut. Si cela n’est pas spécifié, les conteneurs Lambda se connectent uniquement au réseau Docker de pont par défaut. ` --docker-volume-basedir, -v TEXT` Emplacement du répertoire de base où se trouve le AWS SAM fichier. Si Docker est exécuté sur une machine distante, vous devez monter le chemin où se trouve le AWS SAM fichier sur la machine Docker et modifier cette valeur pour qu'elle corresponde à la machine distante. `--env-vars, -n PATH` Le `.env` fichier JSON ou contenant les valeurs des variables d'environnement de la fonction Lambda. Le format de fichier est automatiquement détecté. `--force-image-build` Spécifie s'il AWS SAM CLI faut reconstruire l'image utilisée pour appeler des fonctions avec des couches. `--help` Affiche ce message, puis se ferme. `--hook-name TEXT` Nom du hook utilisé pour étendre la fonctionnalité de la CLI  AWS SAM. Valeurs acceptées : `terraform`. `--host TEXT` Le nom d’hôte local ou adresse IP à relier (par défaut : '127.0.0.1'). `--invoke-image TEXT` L’URI de l’image de conteneur que vous souhaitez utiliser pour les fonctions Lambda. Par défaut, AWS SAM extrait l'image du conteneur depuis Amazon ECR Public. Utilisez cette option pour extraire l’image à partir d’un autre emplacement. Vous pouvez spécifier cette option plusieurs fois. Chaque instance de cette option peut prendre une chaîne ou une paire valeur clé. Si vous spécifiez une chaîne, il s’agit de l’URI de l’image de conteneur à utiliser pour toutes les fonctions de l’application. Par exemple, `sam local start-api --invoke-image public.ecr.aws/sam/emu-python3.8`. Si vous spécifiez une paire valeur clé, la clé est le nom de la ressource et la valeur est l’URI de l’image de conteneur à utiliser pour cette ressource. Par exemple `sam local start-api --invoke-image public.ecr.aws/sam/emu-python3.8 --invoke-image Function1=amazon/aws-sam-cli-emulation-image-python3.8 `. Avec les paires valeur clé, vous pouvez spécifier différentes images de conteneur pour différentes ressources. `--layer-cache-basedir DIRECTORY` Spécifie l’emplacement basedir dans lequel les couches utilisées par le modèle sont téléchargées. `--log-file, -l TEXT` Le fichier journal vers lequel envoyer les journaux d’exécution. `--no-memory-limit` Supprime la limite de mémoire dans le conteneur lors de l'appel local, même lorsque la mémoire est configurée dans le AWS SAM modèle. `--parameter-overrides` Chaîne contenant des remplacements de CloudFormation paramètres codés sous forme de paires clé-valeur. Utilisez le même format que le AWS Command Line Interface (AWS CLI). Le AWS SAMCLI format est constitué de mots clés et valeurs explicites, chaque remplacement étant séparé par un espace. Voici deux exemples : + `--parameter-overrides ParameterKey=hello,ParameterValue=world` + `--parameter-overrides ParameterKey=hello,ParameterValue=world ParameterKey=example1,ParameterValue=example2 ParameterKey=apple,ParameterValue=banana` `--port, -p INTEGER` Le numéro de port local à écouter (par défaut : '3000'). `--profile TEXT` Le profil spécifique de votre fichier d'informations d'identification qui obtient les AWS informations d'identification. `--region TEXT` AWS Région dans laquelle déployer. Par exemple, us-east-1. `--save-params` Enregistrez les paramètres que vous fournissez sur la ligne de commande dans le fichier AWS SAM de configuration. `--shutdown` Imite un événement d’arrêt une fois l’appel terminé, afin de tester la gestion des extensions du comportement d’arrêt. `--skip-prepare-infra` Ignore l'étape de préparation si aucune modification d'infrastructure n'a été apportée. À utiliser avec l'option `--hook-name`. `--skip-pull-image` Spécifie si l’interface de ligne de commande (CLI) doit ignorer la dernière image Docker pour l’exécution Lambda. `--ssl-cert-file PATH` Chemin d'accès au fichier de certificat SSL (par défaut : aucun). Lorsque vous utilisez cette option, elle doit également être utilisée. `--ssl-key-file` `--ssl-key-file PATH` Chemin d'accès au fichier clé SSL (par défaut : aucun). Lorsque vous utilisez cette option, elle doit également être utilisée. `--ssl-cert-file` `--static-dir, -s TEXT` Tous les fichiers d'actifs statiques (par exempleCSS/JavaScript/HTML) situés dans ce répertoire sont présentés à l'adresse`/`. `--template, -t PATH` Le fichier AWS SAM modèle. Si vous spécifiez cette option, AWS SAM charge uniquement le modèle et les ressources locales vers lesquels il pointe. `--terraform-plan-file` Le chemin relatif ou absolu vers votre fichier de plan Terraform local lorsque vous utilisez la CLI  AWS SAM avec Terraform Cloud. Cette option nécessite que `--hook-name` soit défini sur `terraform`. `--warm-containers [EAGER | LAZY]` Facultatif. Spécifie comment la CLI  AWS SAM gère les conteneurs pour chaque fonction. Deux options sont disponibles :    `EAGER` : Les conteneurs pour toutes les fonctions sont chargés au démarrage et persistent entre les appels.    `LAZY` : Les conteneurs ne sont chargés que lorsque chaque fonction est appelée pour la première fois. Ces conteneurs persistent pour des appels supplémentaires. ## Exemple L'exemple suivant démarre un serveur local, ce qui vous permet de tester votre application via une API. Pour que cette commande fonctionne, l'application doit être installée et Docker doit être en cours d'exécution. ``` $ sam local start-api --port 3000 ``` # sam local start-lambda Cette page fournit des informations de référence pour la AWS Serverless Application Model `sam local start-lambda` sous-commande Command Line Interface (AWS SAMCLI). + Pour une introduction à la AWS SAMCLI, voir [Qu'est-ce que c'est AWS SAMCLI ?](what-is-sam-overview.md#what-is-sam-cli) + Pour obtenir de la documentation sur l'utilisation de la AWS SAMCLI `sam local start-lambda` sous-commande, consultez[Présentation des tests avec sam local start-lambda](using-sam-cli-local-start-lambda.md). La `sam local start-lambda` sous-commande démarre un point de terminaison local à AWS Lambdaémuler. ## Usage ``` $ sam local start-lambda ``` ## Options `--add-host LIST` Transmet un mappage de nom d'hôte à adresse IP au fichier hôte du conteneur Docker. Ce paramètre peut être transmis plusieurs fois. **Example** Exemple : `--add-host example.com:127.0.0.1` `--beta-features | --no-beta-features` Autorisez ou refusez les fonctionnalités bêta. `--config-env TEXT` Le nom d’environnement spécifiant les valeurs de paramètre par défaut dans le fichier de configuration à utiliser. La valeur par défaut est « par défaut ». Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--config-file PATH` Le chemin d'accès et le nom du fichier de configuration contenant les valeurs de paramètres par défaut à utiliser. La valeur par défaut est « samconfig.toml » dans la racine du répertoire du projet. Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--container-env-vars` Facultatif. Transmettez les variables d’environnement au conteneur d’images lors du débogage local. `--container-host TEXT` Hôte du conteneur Lambda émulé localement. La valeur par défaut est `localhost`. Si vous voulez exécuter la CLI  AWS SAM dans un conteneur Docker sous macOS, vous pouvez spécifier `host.docker.internal`. Si vous souhaitez exécuter le conteneur sur un autre hôte AWS SAMCLI, vous pouvez spécifier l'adresse IP de l'hôte distant. `--container-host-interface TEXT` L’adresse IP de l’interface de réseau hôte à laquelle les ports de conteneur doivent se relier. La valeur par défaut est `127.0.0.1`. Utiliser `0.0.0.0` pour se lier à toutes les interfaces. `--debug` Active la journalisation de débogage pour imprimer le message de débogage généré par la CLI  AWS SAM et pour afficher les horodatages. `--debug-args TEXT` Arguments facultatifs à transmettre au débogueur. `--debug-function` Facultatif. Spécifie la fonction Lambda pour appliquer les options de débogage lorsque `--warm-containers`est spécifié. Ce paramètre s’applique à `--debug-port`, `--debugger-path` et `--debug-args`. `--debug-port, -d TEXT` Si spécifié, il démarre le conteneur de fonction Lambda en mode débogage et expose ce port sur l’hôte local. `--debugger-path TEXT` Le chemin d’accès de l’hôte vers un débogueur à monter dans le conteneur Lambda. `--docker-network TEXT` Le nom ou l’identifiant d’un réseau Docker existant auquel les conteneurs Docker Lambda doivent se connecter, avec le réseau de pont par défaut. Si ceci est spécifié, les conteneurs Lambda se connectent uniquement au réseau Docker de pont par défaut. `--docker-volume-basedir, -v TEXT` Emplacement du répertoire de base où se trouve le AWS SAM fichier. Si Docker est exécuté sur une machine distante, vous devez monter le chemin où se trouve le AWS SAM fichier sur la machine Docker et modifier cette valeur pour qu'elle corresponde à la machine distante. `--env-vars, -n PATH` Le `.env` fichier JSON ou contenant les valeurs des variables d'environnement de la fonction Lambda. Le format de fichier est automatiquement détecté. `--force-image-build` Spécifiez s'il CLI faut reconstruire l'image utilisée pour appeler des fonctions avec des couches. `--help` Affiche ce message, puis se ferme. `--hook-name TEXT` Nom du hook utilisé pour étendre la fonctionnalité de la CLI  AWS SAM. Valeurs acceptées : `terraform`. `--host TEXT` Le nom d’hôte local ou adresse IP à relier (par défaut : '127.0.0.1'). `--invoke-image TEXT` L’URI de l’image de conteneur que vous souhaitez utiliser pour l’appel de la fonction locale. Par défaut, AWS SAM extrait l'image du conteneur depuis Amazon ECR Public. Utilisez cette option pour extraire l’image à partir d’un autre emplacement. Par exemple, `sam local start-lambda MyFunction --invoke-image amazon/aws-sam-cli-emulation-image-python3.8`. `--layer-cache-basedir DIRECTORY` Spécifie l’emplacement basedir dans lequel les couches utilisées par le modèle sont téléchargées. `--log-file, -l TEXT` Le fichier journal vers lequel envoyer les journaux d’exécution. `--no-memory-limit` Supprime la limite de mémoire dans le conteneur lors de l'appel local, même lorsque la mémoire est configurée dans le AWS SAM modèle. `--parameter-overrides` Chaîne contenant des remplacements de CloudFormation paramètres codés sous forme de paires clé-valeur. Utilisez le même format que le AWS Command Line Interface (AWS CLI). Le AWS SAMCLI format est basé sur des mots clés et valeurs explicites, chaque remplacement étant séparé par un espace. Voici deux exemples : + `--parameter-overrides ParameterKey=hello,ParameterValue=world` + `--parameter-overrides ParameterKey=hello,ParameterValue=world ParameterKey=example1,ParameterValue=example2 ParameterKey=apple,ParameterValue=banana` `--port, -p INTEGER` Numéro de port local à écouter (par défaut : '3001'). `--profile TEXT` Le profil spécifique de votre fichier d'informations d'identification qui obtient les AWS informations d'identification. `--region TEXT` AWS Région dans laquelle le déploiement doit être effectué. Par exemple, us-east-1. `--save-params` Enregistrez les paramètres que vous fournissez sur la ligne de commande dans le fichier AWS SAM de configuration. `--shutdown` Imite un événement d’arrêt une fois l’appel terminé, afin de tester la gestion des extensions du comportement d’arrêt. `--skip-prepare-infra` Ignore l'étape de préparation si aucune modification d'infrastructure n'a été apportée. À utiliser avec l'option `--hook-name`. `--skip-pull-image` Spécifie s'il CLI faut ignorer l'extraction de la dernière image Docker vers le bas pour le runtime Lambda. `--template, -t PATH` Le fichier AWS SAM modèle. Si vous spécifiez cette option, AWS SAM charge uniquement le modèle et les ressources locales vers lesquels il pointe. Cette option n'est pas compatible avec `--hook-name`. `--terraform-plan-file` Le chemin relatif ou absolu vers votre fichier de plan Terraform local lorsque vous utilisez la CLI  AWS SAM avec Terraform Cloud. Cette option nécessite que `--hook-name` soit défini sur `terraform`. `--warm-containers [EAGER | LAZY]` Facultatif. Spécifie comment la CLI  AWS SAM gère les conteneurs pour chaque fonction. Deux options sont disponibles : + `EAGER` : Les conteneurs pour toutes les fonctions sont chargés au démarrage et persistent entre les appels. + `LAZY` : Les conteneurs ne sont chargés que lorsque chaque fonction est appelée pour la première fois. Ces conteneurs persistent pour des appels supplémentaires. ## Exemple Pour un exemple détaillé et une présentation détaillée de l'utilisation de la `sam local start-lambda` sous-commande, reportez-vous à. [Présentation des tests avec sam local start-lambda](using-sam-cli-local-start-lambda.md) # sam logs Cette page fournit des informations de référence pour la AWS Serverless Application Model commande Command Line Interface (AWS SAMCLI)`sam logs`. Pour une introduction à la AWS SAMCLI, voir [Qu'est-ce que c'est AWS SAMCLI ?](what-is-sam-overview.md#what-is-sam-cli) La `sam logs` commande récupère les journaux générés par vos AWS Lambda fonctions. ## Usage ``` $ sam logs ``` ## Options `--config-env TEXT` Le nom d’environnement spécifiant les valeurs de paramètre par défaut dans le fichier de configuration à utiliser. La valeur par défaut est « par défaut ». Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--config-file PATH` Le chemin d'accès et le nom du fichier de configuration contenant les valeurs de paramètres par défaut à utiliser. La valeur par défaut est « samconfig.toml » dans la racine du répertoire du projet. Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--cw-log-group LIST` Inclut les CloudWatch journaux des groupes de journaux que vous spécifiez. Si vous spécifiez cette option avec`name`, AWS SAM inclut les journaux des groupes de journaux spécifiés en plus des journaux des ressources nommées. `--debug` Active la journalisation de débogage pour imprimer le message de débogage généré par la CLI  AWS SAM et pour afficher les horodatages. `---end-time, e TEXT` Récupère les journaux jusqu’à ce moment. L'heure peut être des valeurs relatives comme « il y a 5 minutes », « hier », ou un horodatage formaté comme « 2018-01-01 10:10:10 ». `--filter TEXT` Vous permet de spécifier une expression pour rechercher rapidement des journaux qui correspondent à des termes, des phrases ou des valeurs dans les journaux d’événements. Il peut s'agir d'un simple mot clé (par exemple, « erreur ») ou d'un modèle pris en charge par Amazon CloudWatch Logs. Pour connaître la syntaxe, consultez la [documentation Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html). `--help` Affiche ce message, puis se ferme. `--include-traces` Inclut des traces X-Ray dans la sortie du journal. `--name, -n TEXT` Le nom de la ressource pour laquelle vous souhaitez récupérer des journaux. Si cette ressource fait partie d'une CloudFormation pile, il peut s'agir de l'ID logique de la ressource fonctionnelle dans le AWS SAM modèle CloudFormation/. Plusieurs noms peuvent être fournis en répétant à nouveau le paramètre. Si la ressource se trouve dans une pile imbriquée, le nom peut être précédé du nom de la pile imbriquée pour extraire les journaux de cette ressource (/). NestedStackLogicalId ResourceLogicalId Si le nom de la ressource n'est pas fourni, la pile donnée sera analysée et les informations de journal seront extraites pour toutes les ressources prises en charge. Si vous ne spécifiez pas cette option, AWS SAM extrait les journaux de toutes les ressources de la pile que vous spécifiez. Les types de ressources suivants sont pris en charge : + `AWS::Serverless::Function` + `AWS::Lambda::Function` + `AWS::Serverless::Api` + `AWS::ApiGateway::RestApi` + `AWS::Serverless::HttpApi` + `AWS::ApiGatewayV2::Api` + `AWS::Serverless::StateMachine` + `AWS::StepFunctions::StateMachine` `--output TEXT` Spécifie le format de sortie pour les journaux. Pour imprimer des journaux formatés, spécifiez `text`. Pour imprimer les journaux au format JSON, spécifiez `json`. `--profile TEXT` Le profil spécifique de votre fichier d'informations d'identification qui obtient les AWS informations d'identification. `--region TEXT` AWS Région dans laquelle le déploiement doit être effectué. Par exemple, us-east-1. `--save-params` Enregistrez les paramètres que vous fournissez sur la ligne de commande dans le fichier AWS SAM de configuration. `--stack-name TEXT` Nom de la CloudFormation pile dont fait partie la ressource. `--start-time, -s TEXT` Récupère les journaux à partir de ce moment. L'heure peut être des valeurs relatives comme « il y a 5 minutes », « hier », ou un horodatage formaté comme « 2018-01-01 10:10:10 ». La valeur par défaut est « il y a 10 minutes ». ` --tail, -t` Suit la sortie du journal. Cela ignore l’argument de fin d’heure et continue de récupérer les journaux à mesure qu’ils deviennent disponibles. ## Exemples Lorsque vos fonctions font partie d'une CloudFormation pile, vous pouvez récupérer les journaux en utilisant l'identifiant logique de la fonction lorsque vous spécifiez le nom de la pile. ``` $ sam logs -n HelloWorldFunction --stack-name myStack ``` Consultez les journaux pour une plage de temps spécifique à l'aide des options -s (--start-time) et -e (--end-time). ``` $ sam logs -n HelloWorldFunction --stack-name myStack -s '10min ago' -e '2min ago' ``` Vous pouvez également ajouter la `--tail` possibilité d'attendre les nouveaux journaux et de les voir à leur arrivée. ``` $ sam logs -n HelloWorldFunction --stack-name myStack --tail ``` Utilisez `--filter` cette option pour trouver rapidement les journaux correspondant aux termes, expressions ou valeurs de vos événements de journal. ``` $ sam logs -n HelloWorldFunction --stack-name myStack --filter "error" ``` Consultez les journaux d'une ressource dans une pile enfant. ``` $ sam logs --stack-name myStack -n childStack/HelloWorldFunction ``` Journaux de suivi de toutes les ressources prises en charge dans votre application. ``` $ sam logs --stack-name sam-app --tail ``` Récupérez les journaux d'une fonction Lambda et d'une API API Gateway spécifiques dans votre application. ``` $ sam logs --stack-name sam-app --name HelloWorldFunction --name HelloWorldRestApi ``` Récupérez les journaux de toutes les ressources prises en charge dans votre application, ainsi que des groupes de journaux spécifiés. ``` $ sam logs --cw-log-group /aws/lambda/myfunction-123 --cw-log-group /aws/lambda/myfunction-456 ``` # sam package L'interface de ligne de AWS Serverless Application Model commande (AWS SAM CLI) empaquette une AWS SAM application. Cette commande crée un `.zip` fichier contenant votre code et vos dépendances, et télécharge le fichier sur Amazon Simple Storage Service (Amazon S3). AWS SAM active le chiffrement de tous les fichiers stockés dans Amazon S3. Il renvoie ensuite une copie de votre AWS SAM modèle, en remplaçant les références aux artefacts locaux par l'emplacement Amazon S3 où la commande a chargé les artefacts. Par défaut, lorsque vous utilisez cette commande, la CLI  AWS SAM suppose que le répertoire de travail actuel est le répertoire racine du projet. Le AWS SAMCLI premier essaie de localiser un fichier modèle créé à l'aide de la [sam build](sam-cli-command-reference-sam-build.md) commande, situé dans le `.aws-sam` sous-dossier et nommé`template.yaml`. Ensuite, la CLI  AWS SAM tente de localiser un fichier modèle nommé `template.yaml` ou `template.yml` dans le répertoire de travail actuel. Si vous spécifiez l'`--template`option, AWS SAMCLI le comportement par défaut est remplacé et empaquetera uniquement ce AWS SAM modèle et les ressources locales vers lesquelles il pointe. **Note** [sam deploy](sam-cli-command-reference-sam-deploy.md) exécute maintenant implicitement la fonctionnalité de `sam package`. Vous pouvez utiliser la commande [sam deploy](sam-cli-command-reference-sam-deploy.md) directement pour empaqueter et déployer l’application. ## Usage ``` $ sam package ``` ## Arguments **ID de ressource** ID de la fonction Lambda à empaqueter. Cet argument est facultatif. Si votre application contient une seule fonction Lambda, la AWS SAM CLI l'empaquetera. Si votre application contient plusieurs fonctions, indiquez l'ID de la fonction pour empaqueter une seule fonction. *Valeurs valides* : ID logique ou ARN de la ressource. ## Options `--config-env TEXT` Le nom d’environnement spécifiant les valeurs de paramètre par défaut dans le fichier de configuration à utiliser. La valeur par défaut est « par défaut ». Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--config-file PATH` Le chemin d'accès et le nom du fichier de configuration contenant les valeurs de paramètres par défaut à utiliser. La valeur par défaut est « samconfig.toml » dans la racine du répertoire du projet. Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--debug` Active la journalisation de débogage pour imprimer le message de débogage généré par la CLI  AWS SAM et pour afficher les horodatages. `--force-upload` Remplacer les fichiers existants dans le compartiment Amazon S3. Spécifiez cet indicateur pour télécharger des artefacts, même s’ils correspondent à des artefacts existants dans le compartiment Amazon S3. `--help` Affiche ce message, puis se ferme. `--image-repository TEXT` L’URI du référentiel Amazon Elastic Container Registry (Amazon ECR) vers lequel cette commande télécharge l’image de la fonction. Requis pour les fonctions déclarées avec le type de package `Image`. `--kms-key-id TEXT` L'ID d'une clé AWS Key Management Service (AWS KMS) utilisée pour chiffrer les artefacts inactifs dans le compartiment Amazon S3. Si cette option n'est pas spécifiée, AWS SAM utilise les clés de chiffrement gérées par Amazon S3. `--metadata` (Facultatif) Une carte de métadonnées à attacher à tous les artefacts référencés dans le modèle. `--no-progressbar` N’affichez pas de barre de progression lors du téléchargement d’artefacts sur Amazon S3. `--output-template-file PATH` Chemin d’accès au fichier dans lequel la commande écrit le modèle empaqueté. Si vous ne spécifiez pas de chemin d’accès, la commande écrit le modèle dans la sortie standard. `--profile TEXT` Le profil spécifique de votre fichier d'informations d'identification qui obtient les AWS informations d'identification. `--region TEXT` La AWS région dans laquelle le déploiement doit être effectué. Par exemple, us-east-1. `--resolve-s3` Créez automatiquement un compartiment Amazon S3 à utiliser pour l’empaquetage. Si vous précisez les deux options `--s3-bucket` et `--resolve-s3`, alors une erreur se produira. `--s3-bucket TEXT` Le nom du compartiment Amazon S3 dans lequel cette commande télécharge votre artefact. Si votre artefact est supérieur à 51 200 octets, l'option `--s3-bucket` ou l'`--resolve-s3`option est requise. Si vous précisez les deux options `--s3-bucket` et `--resolve-s3`, alors une erreur se produira. `--s3-prefix TEXT` Le préfixe ajouté aux noms des artefacts téléchargés vers le compartiment Amazon S3. Le nom du préfixe est un nom de chemin d’accès (nom de dossier) pour le compartiment Amazon S3. Cela s’applique uniquement aux fonctions déclarées avec le type de package `Zip`. `--save-params` Enregistrez les paramètres que vous fournissez sur la ligne de commande dans le fichier AWS SAM de configuration. `--signing-profiles LIST` (Facultatif) La liste des profils de signature pour signer les packages de déploiement. Ce paramètre prend une liste de paires valeur clé, où la clé est le nom de la fonction ou de la couche à signer et la valeur est le profil de signature, avec un propriétaire de profil facultatif délimité par `:`. Par exemple, `FunctionNameToSign=SigningProfileName1 LayerNameToSign=SigningProfileName2:SigningProfileOwner`. `--template-file, --template, -t PATH` Le chemin et le nom du fichier où se trouve votre AWS SAM modèle. Si vous spécifiez cette option, AWS SAM empaquette uniquement le modèle et les ressources locales vers lesquels il pointe. `--use-json` Sortie JSON pour le CloudFormation modèle. Par défaut, YAML est utilisé. ## Exemple L'exemple suivant crée et empaquette des artefacts pour une fonction Lambda et des CodeDeploy applications. Les artefacts sont chargés dans un compartiment Amazon S3. La sortie de la commande est un nouveau fichier nommé `package.yml`. ``` $ sam package \ --template-file template.yml \ --output-template-file package.yml \ --s3-bucket amzn-s3-demo-bucket ``` # sam pipeline bootstrap Cette page fournit des informations de référence pour la AWS Serverless Application Model `sam local pipeline bootstrap` sous-commande Command Line Interface (AWS SAMCLI). Pour une introduction à la AWS SAMCLI, voir [Qu'est-ce que c'est AWS SAMCLI ?](what-is-sam-overview.md#what-is-sam-cli) La `sam pipeline bootstrap` sous-commande génère les ressources AWS d'infrastructure requises pour se connecter à votre système CI/CD. Cette étape doit être exécutée pour chaque étape de déploiement du pipeline, avant d'exécuter la commande **sam pipeline init**. Cette sous-commande configure les ressources AWS d'infrastructure suivantes : + Option de configuration des autorisations du pipeline via : + Un utilisateur IAM du pipeline avec un identifiant de clé d'accès et des informations d'identification d'accès par clé secrète à partager avec le CI/CD système. **Note** Nous vous recommandons d'effectuer une rotation régulière des clés d'accès. Pour plus d'informations, consultez [Rotation régulière des clés d'accès pour les cas d'utilisation nécessitant des informations d'identification](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#rotate-credentials) dans le *Guide de l'utilisateur IAM*. + CI/CD Plateformes prises en charge via OIDC. Pour obtenir une présentation de l'utilisation d'OIDC avec un pipeline AWS SAM , consultez [Comment utiliser l'authentification OIDC avec les pipelines AWS SAM](deploying-with-oidc.md). + Rôle IAM d' CloudFormation exécution assumé par CloudFormation pour déployer l' AWS SAM application. + Un compartiment Amazon S3 pour contenir les AWS SAM artefacts. + Le cas échéant, un référentiel d’images Amazon ECR pour contenir des packages de déploiement Lambda de conteneur d’images (si vous disposez d’une ressource avec le type de package `Image`). ## Usage ``` $ sam pipeline bootstrap ``` ## Options `--bitbucket-repo-uuid TEXT` L'UUID du référentiel Bitbucket. Cette option est spécifique à l'utilisation d'OIDC avec Bitbucket pour les autorisations. Cette valeur se trouve à l'adresse https://bitbucket.org/*workspace*/*repository*/admin/addon/admin/pipelines/openid-connect `--bucket TEXT` L'ARN du compartiment Amazon S3 qui contient les AWS SAM artefacts. `--cicd-provider TEXT` La CI/CD plate-forme pour le AWS SAM pipeline. `--cloudformation-execution-role TEXT` L'ARN du rôle IAM à assumer CloudFormation lors du déploiement de la pile de l'application. Fournissez-le uniquement si vous voulez utiliser votre propre rôle. Sinon, la commande crée un nouveau rôle. `--config-env TEXT` Le nom d'environnement spécifiant les valeurs de paramètre par défaut dans le fichier de configuration à utiliser. La valeur par défaut est **default**. Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--config-file PATH` Le chemin d'accès et le nom du fichier de configuration contenant les valeurs de paramètres par défaut à utiliser. La valeur par défaut est `samconfig.toml` à la racine du répertoire du projet. Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--confirm-changeset | --no-confirm-changeset` Invitation à confirmer le déploiement de vos ressources. `--create-image-repository | --no-create-image-repository` Indiquez si vous souhaitez créer un référentiel d’images Amazon ECR si aucun n’est fourni. Le référentiel Amazon ECR contient les images de conteneur des fonctions Lambda ou des couches présentant un type de package `Image`. La valeur par défaut est `--no-create-image-repository`. `--debug` Active la journalisation de débogage, imprime les messages de débogage générés par la CLI  AWS SAM et affiche les horodatages. `--deployment-branch TEXT` Nom de la branche à partir de laquelle les déploiements seront effectués. Cette option est spécifique à l'utilisation d' GitHub Actions OIDC pour les autorisations. `--github-org TEXT` L' GitHub organisation à laquelle appartient le référentiel. Si aucune organisation n'existe, saisissez le nom d'utilisateur du propriétaire du référentiel. Cette option est spécifique à l'utilisation d' GitHubActions OIDC pour les autorisations. `--github-repo TEXT` Nom du GitHub référentiel à partir duquel les déploiements seront effectués. Cette option est spécifique à l'utilisation d' GitHub Actions OIDC pour les autorisations. `--gitlab-group TEXT` Le GitLab groupe auquel appartient le référentiel. Cette option est spécifique à l'utilisation de l' GitLab OIDC pour les autorisations. `--gitlab-project TEXT` Le nom GitLab du projet. Cette option est spécifique à l'utilisation de l' GitLab OIDC pour les autorisations. `--help, -h` Affiche ce message, puis se ferme. `--image-repository TEXT` L'ARN d'un référentiel d'images Amazon ECR contenant les images de conteneur des fonctions Lambda ou des couches avec un type de package `Image`. S’il est fourni, l’option `--create-image-repository` est ignorée. S'il n'est pas fourni et que `--create-image-repository` est spécifié, la commande en crée un. `--interactive | --no-interactive` Désactivez l'invite interactive pour les paramètres d'amorçage et attendez si des paramètres requis sont manquants. La valeur par défaut est `--interactive`. Avec cette commande, `--stage` est le seul paramètre obligatoire. S'il `--no-interactive` est spécifié en même temps que`--use-oidc-provider`, tous les paramètres requis pour votre fournisseur OIDC doivent être inclus. `--oidc-client-id TEXT` L'ID client configuré pour être utilisé avec votre fournisseur OIDC. `--oidc-provider [github-actions | gitlab | bitbucket-pipelines]` Nom du CI/CD fournisseur qui sera utilisé pour les autorisations OIDC. GitLab, GitHub, et Bitbucket sont pris en charge. `--oidc-provider-url TEXT` URL du fournisseur OIDC. La valeur doit commencer par **https://**. `--permissions-provider [oidc | iam]` Choisissez un fournisseur d'autorisations pour assumer le rôle d'exécution du pipeline. La valeur par défaut est **iam**. `--pipeline-execution-role TEXT` L’ARN du rôle IAM devant être assumé par l’utilisateur de pipeline pour fonctionner sur cette étape. Fournissez-le uniquement si vous voulez utiliser votre propre rôle. S'il n'est pas fourni, cette commande crée un nouveau rôle. `--pipeline-user TEXT` Nom de ressource Amazon (ARN) de l'utilisateur IAM dont l'ID de clé d'accès et la clé d'accès secrète sont partagés avec le CI/CD système. Il est utilisé pour accorder à cet utilisateur IAM l'autorisation d'accéder au AWS compte correspondant. S'il n'est pas fourni, la commande crée un utilisateur IAM avec l'identifiant de la clé d'accès et les informations d'identification de clé d'accès secrète. `--profile TEXT` Le profil spécifique de votre fichier d'informations d'identification qui obtient les AWS informations d'identification. `--region TEXT` La AWS région dans laquelle le déploiement doit être effectué. Par exemple, `us-east-1`. `--save-params` Enregistrez les paramètres que vous fournissez sur la ligne de commande dans le fichier AWS SAM de configuration. `--stage TEXT` Le nom de l’étape de déploiement correspondante. Il est utilisé comme suffixe pour les ressources AWS d'infrastructure créées. ## Résolution des problèmes ### Error: Missing required parameter (Erreur : paramètre requis manquant) Quand `--no-interactive` est spécifié avec `--use-oidc-provider` et qu'aucun des paramètres requis n'est fourni, ce message d'erreur s'affiche avec une description des paramètres manquants. ## Exemple L'exemple suivant crée les AWS ressources nécessaires à la création de votre CI/CD système, active la journalisation du débogage et imprime les messages de débogage générés par AWS SAMCLI : utilise un événement généré pour les tests locaux en utilisant un `s3.json` événement pour appeler une fonction Lambda localement ``` $ sam pipeline bootstrap --debug ``` # sam pipeline init Cette page fournit des informations de référence pour la AWS Serverless Application Model `sam pipeline init` sous-commande Command Line Interface (AWS SAMCLI). Pour une introduction à la AWS SAMCLI, voir [Qu'est-ce que c'est AWS SAMCLI ?](what-is-sam-overview.md#what-is-sam-cli) La `sam pipeline init` sous-commande génère un fichier de configuration de pipeline que votre CI/CD système peut utiliser pour déployer des applications sans serveur à l'aide de. AWS SAM Avant d’utiliser **sam pipeline init**, vous devez amorcer les ressources nécessaires pour chaque étape du pipeline. Pour ce faire, exécutez **sam pipeline init --bootstrap** pour être guidé tout au long du processus de génération de fichiers d’installation et de configuration ou référez-vous aux ressources que vous avez précédemment créées à l’aide de la commande **sam pipeline bootstrap**. ## Usage ``` $ sam pipeline init ``` ## Options `--bootstrap` Activez le mode interactif qui guide l'utilisateur tout au long de la création des ressources AWS d'infrastructure nécessaires. `--config-env TEXT` Le nom d'environnement spécifiant les valeurs de paramètre par défaut dans le fichier de configuration à utiliser. La valeur par défaut est `default`. Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--config-file TEXT` Le chemin d'accès et le nom du fichier de configuration contenant les valeurs de paramètres par défaut à utiliser. La valeur par défaut est `samconfig.toml` dans le répertoire racine du projet. Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--debug` Active la journalisation de débogage pour imprimer les messages de débogage générés par la CLI  AWS SAM et pour afficher les horodatages. `--help, -h` Affiche ce message, puis se ferme. `--save-params` Enregistrez les paramètres que vous fournissez sur la ligne de commande dans le fichier AWS SAM de configuration. ## Exemple L'exemple suivant vous montre comment utiliser l'`--bootstrap`option qui vous permet de passer par un mode interactif qui vous guide tout au long de la création des ressources d' AWS infrastructure nécessaires : ``` $ sam pipeline init --bootstrap ``` # sam publish Cette page fournit des informations de référence pour la AWS Serverless Application Model commande Command Line Interface (AWS SAMCLI)`sam publish`. Pour une introduction à la AWS SAMCLI, voir [Qu'est-ce que c'est AWS SAMCLI ?](what-is-sam-overview.md#what-is-sam-cli) La `sam publish` commande publie une AWS SAM application dans le AWS Serverless Application Repository. Cette commande prend un AWS SAM modèle empaqueté et publie l'application dans la AWS région spécifiée. La `sam publish` commande s'attend à ce que le AWS SAM modèle inclue une `Metadata` section contenant les métadonnées d'application requises pour la publication. Dans la section `Metadata`, les propriétés `LicenseUrl` et `ReadmeUrl` doivent faire référence aux compartiments Amazon Simple Storage Service (Amazon S3) et non pas aux fichiers locaux. Pour plus d'informations sur la `Metadata` section du AWS SAM modèle, consultez[Publier votre candidature à l'aide du AWS SAMCLI](serverless-sam-template-publishing-applications.md). Par défaut, `sam publish` crée l’application comme privée. Avant que d’autres comptes AWS soient autorisés à visualiser et à déployer l’application, vous devez la partager. Pour plus d’informations sur le partage de l’application, consultez [Exemples de stratégies basées sur les ressources AWS Serverless Application Repository](https://docs.aws.amazon.com/serverlessrepo/latest/devguide/security_iam_resource-based-policy-examples.html) dans le *Guide du développeur AWS Serverless Application Repository *. **Note** Actuellement `sam publish` ne prend pas en charge la publication d’applications imbriquées qui sont spécifiées localement. Si votre application contient des applications imbriquées, vous devez les publier séparément dans l'application parent AWS Serverless Application Repository avant de publier. ## Usage ``` $ sam publish ``` ## Options `--config-env TEXT` Le nom d’environnement spécifiant les valeurs de paramètre par défaut dans le fichier de configuration à utiliser. La valeur par défaut est « par défaut ». Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--config-file PATH` Le chemin d’accès et le nom du fichier de configuration contenant les valeurs de paramètres par défaut à utiliser. La valeur par défaut est « `samconfig.toml` » dans la racine du répertoire du projet. Pour plus d’informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--debug` Active la journalisation de débogage pour imprimer les messages de débogage générés par la CLI  AWS SAM et pour afficher les horodatages. `--help` Affiche ce message, puis se ferme. `--profile TEXT` Le profil spécifique de votre fichier d'informations d'identification qui obtient les AWS informations d'identification. `--region TEXT` La AWS région dans laquelle le déploiement doit être effectué. Par exemple, us-east-1. `--save-params` Enregistrez les paramètres que vous fournissez sur la ligne de commande dans le fichier AWS SAM de configuration. `--semantic-version TEXT` (Facultatif) Utilisez cette option pour fournir une version sémantique de l’application qui remplace la propriété `SemanticVersion` dans la section `Metadata` du fichier modèle. Pour obtenir la spécification de gestion sémantique des versions, veuillez consulter le site web de la [Gestion sémantique des versions](https://semver.org/). `--template, -t PATH` Le chemin du fichier AWS SAM modèle`[default: template.[yaml|yml]]`. ## Exemples Pour publier une application, procédez comme suit : ``` $ sam publish --template packaged.yaml --region us-east-1 ``` # sam remote callback Cette page fournit des informations de référence pour la AWS Serverless Application Model commande Command Line Interface (AWS SAMCLI)`sam remote callback`. Pour une introduction à la AWS SAMCLI, voir [Qu'est-ce que c'est AWS SAMCLI ?](what-is-sam-overview.md#what-is-sam-cli) La `sam remote callback` commande vous permet d'envoyer des rappels à des exécutions de fonctions durables à distance exécutées dans AWS Lambda. **Note** Ces commandes nécessitent l'accès aux AWS informations d'identification. ## Usage ``` $ sam remote callback ``` ## Options `--help, -h` Affichez ce message et quittez. ## Sous-commandes `succeed` Envoyez un rappel réussi à une exécution de fonction durable à distance. Pour de plus amples informations, veuillez consulter [sam remote callback succeed](sam-cli-command-reference-sam-remote-callback-succeed.md). `fail` Envoie un échec de rappel à l'exécution d'une fonction durable à distance. Pour de plus amples informations, veuillez consulter [sam remote callback fail](sam-cli-command-reference-sam-remote-callback-fail.md). `heartbeat` Envoie un rythme cardiaque de rappel à une exécution de fonction durable à distance. Pour de plus amples informations, veuillez consulter [sam remote callback heartbeat](sam-cli-command-reference-sam-remote-callback-heartbeat.md). # sam remote callback succeed Envoyez un rappel réussi à une exécution de fonction durable à distance. **Note** Cette commande nécessite l'accès aux AWS informations d'identification. ## Usage ``` $ sam remote callback succeed CALLBACK_ID [OPTIONS] ``` ## Arguments obligatoires `CALLBACK_ID` Identifiant unique du rappel auquel envoyer une réponse positive. ## Options `-r, --result TEXT` Charge utile du résultat de réussite sous forme de chaîne. `--region TEXT` Définissez la AWS région du service (par exemple,`us-east-1`). `--profile TEXT` Sélectionnez un profil spécifique dans votre fichier d'informations d'identification pour obtenir des AWS informations d'identification. `--config-env TEXT` Nom de l'environnement spécifiant les valeurs des paramètres par défaut dans le fichier de configuration. Valeur par défaut : `default` `--config-file TEXT` Fichier de configuration contenant les valeurs des paramètres par défaut. Valeur par défaut : `samconfig.toml` `--save-params` Enregistrez les paramètres fournis via la ligne de commande dans le fichier de configuration. `--beta-features / --no-beta-features` Activer/désactiver les fonctionnalités bêta. `--debug` Activez la journalisation du débogage pour imprimer les messages de débogage générés par la AWS SAM CLI et afficher les horodatages. `-h, --help` Affiche ce message, puis se ferme. ## Exemples Envoyer un rappel de réussite sans résultat : ``` $ sam remote callback succeed my-callback-id ``` Envoyer un rappel de réussite avec le résultat : ``` $ sam remote callback succeed my-callback-id --result 'Task completed successfully' ``` # sam remote callback fail Envoie un échec de rappel à l'exécution d'une fonction durable à distance. **Note** Cette commande nécessite l'accès aux AWS informations d'identification. ## Usage ``` $ sam remote callback fail CALLBACK_ID [OPTIONS] ``` ## Arguments obligatoires `CALLBACK_ID` Identifiant unique du rappel auquel envoyer une réponse d'échec. ## Options `--error-data TEXT` Données d'erreur supplémentaires. `--stack-trace TEXT` Empilez les entrées de suivi. Cette option peut être spécifiée plusieurs fois. `--error-type TEXT` Type d'erreur. `--error-message TEXT` Message d'erreur détaillé. `--region TEXT` Définissez la AWS région du service (par exemple,`us-east-1`). `--profile TEXT` Sélectionnez un profil spécifique dans votre fichier d'informations d'identification pour obtenir des AWS informations d'identification. `--config-env TEXT` Nom de l'environnement spécifiant les valeurs des paramètres par défaut dans le fichier de configuration. Valeur par défaut : `default` `--config-file TEXT` Fichier de configuration contenant les valeurs des paramètres par défaut. Valeur par défaut : `samconfig.toml` `--save-params` Enregistrez les paramètres fournis via la ligne de commande dans le fichier de configuration. `--beta-features / --no-beta-features` Activer/désactiver les fonctionnalités bêta. `--debug` Activez la journalisation du débogage pour imprimer les messages de débogage générés par la AWS SAM CLI et afficher les horodatages. `-h, --help` Affiche ce message, puis se ferme. ## Exemples Envoyer un rappel en cas d'échec sans paramètres : ``` $ sam remote callback fail my-callback-id ``` Envoyer un rappel d'échec avec un message d'erreur : ``` $ sam remote callback fail my-callback-id --error-message 'Task failed' ``` Envoyer un rappel en cas d'échec avec tous les paramètres : ``` $ sam remote callback fail my-callback-id --error-message 'Task failed' --error-type 'ValidationError' --stack-trace 'at line 42' --error-data '{"code": 500}' ``` # sam remote callback heartbeat Envoie un rythme cardiaque de rappel à une exécution de fonction durable à distance. **Note** Cette commande nécessite l'accès aux AWS informations d'identification. ## Usage ``` $ sam remote callback heartbeat CALLBACK_ID [OPTIONS] ``` ## Arguments obligatoires `CALLBACK_ID` Identifiant unique du rappel auquel envoyer un battement de cœur. ## Options `--region TEXT` Définissez la AWS région du service (par exemple,`us-east-1`). `--profile TEXT` Sélectionnez un profil spécifique dans votre fichier d'informations d'identification pour obtenir des AWS informations d'identification. `--config-env TEXT` Nom de l'environnement spécifiant les valeurs des paramètres par défaut dans le fichier de configuration. Valeur par défaut : `default` `--config-file TEXT` Fichier de configuration contenant les valeurs des paramètres par défaut. Valeur par défaut : `samconfig.toml` `--save-params` Enregistrez les paramètres fournis via la ligne de commande dans le fichier de configuration. `--beta-features / --no-beta-features` Activer/désactiver les fonctionnalités bêta. `--debug` Activez la journalisation du débogage pour imprimer les messages de débogage générés par la AWS SAM CLI et afficher les horodatages. `-h, --help` Affiche ce message, puis se ferme. ## Exemples Envoyer un rappel du rythme cardiaque : ``` $ sam remote callback heartbeat my-callback-id ``` # sam remote execution Cette page fournit des informations de référence pour la AWS Serverless Application Model commande Command Line Interface (AWS SAMCLI)`sam remote execution`. Pour une introduction à la AWS SAMCLI, voir [Qu'est-ce que c'est AWS SAMCLI ?](what-is-sam-overview.md#what-is-sam-cli) La `sam remote execution` commande vous permet de gérer et d'inspecter les exécutions de fonctions durables à distance exécutées dans AWS Lambda. **Note** Ces commandes nécessitent l'accès aux AWS informations d'identification. ## Usage ``` $ sam remote execution ``` ## Options `--help, -h` Affichez ce message et quittez. ## Sous-commandes `get` Découvrez les détails d'une exécution durable. Pour de plus amples informations, veuillez consulter [sam remote execution get](sam-cli-command-reference-sam-remote-execution-get.md). `history` Obtenez l'historique d'exécution d'une fonction durable. Pour de plus amples informations, veuillez consulter [sam remote execution history](sam-cli-command-reference-sam-remote-execution-history.md). `stop` Arrêtez l'exécution d'une fonction durable. Pour de plus amples informations, veuillez consulter [sam remote execution stop](sam-cli-command-reference-sam-remote-execution-stop.md). # sam remote execution get Récupérez les détails de l'exécution d'une fonction durable spécifique à partir de AWS Lambda. L'ARN d'exécution doit être au format renvoyé par Invoke ou se trouver dans les journaux d'exécution. **Note** Cette commande nécessite l'accès aux AWS informations d'identification. ## Usage ``` $ sam remote execution get DURABLE_EXECUTION_ARN [OPTIONS] ``` ## Arguments obligatoires `DURABLE_EXECUTION_ARN` Le nom de ressource Amazon (ARN) de la fonction durable à exécuter pour laquelle vous souhaitez obtenir des informations. ## Options `--format [summary|json]` Format de la sortie. Valeur par défaut : `summary` `--region TEXT` Définissez la AWS région du service (par exemple,`us-east-1`). `--profile TEXT` Sélectionnez un profil spécifique dans votre fichier d'informations d'identification pour obtenir des AWS informations d'identification. `--config-env TEXT` Nom de l'environnement spécifiant les valeurs des paramètres par défaut dans le fichier de configuration. Valeur par défaut : `default` `--config-file TEXT` Fichier de configuration contenant les valeurs des paramètres par défaut. Valeur par défaut : `samconfig.toml` `--save-params` Enregistrez les paramètres fournis via la ligne de commande dans le fichier de configuration. `--beta-features / --no-beta-features` Activer/désactiver les fonctionnalités bêta. `--debug` Activez la journalisation du débogage pour imprimer les messages de débogage générés par la AWS SAM CLI et afficher les horodatages. `-h, --help` Affiche ce message, puis se ferme. ## Exemples Obtenez les détails de l'exécution avec le format de résumé par défaut : ``` $ sam remote execution get 'arn:aws:lambda:us-east-1:123456789012:function:my-function:$LATEST/durable-execution/c63eec67-3415-4eb4-a495-116aa3a86278/1d454231-a3ad-3694-aa03-c917c175db55' ``` Obtenez les détails de l'exécution au format JSON : ``` $ sam remote execution get 'arn:aws:lambda:us-east-1:123456789012:function:my-function:$LATEST/durable-execution/c63eec67-3415-4eb4-a495-116aa3a86278/1d454231-a3ad-3694-aa03-c917c175db55' --format json ``` **Note** Vous devez vous assurer que les caractères de contrôle de l'ARN d'exécution `$` sont correctement échappés lorsque vous utilisez des commandes shell. # sam remote execution history Récupérez l'historique d'exécution d'une fonction durable spécifique à partir de AWS Lambda. L'ARN d'exécution doit être au format renvoyé par StartDurableExecution ou trouvé dans les journaux d'exécution. **Note** Cette commande nécessite l'accès aux AWS informations d'identification. ## Usage ``` $ sam remote execution history DURABLE_EXECUTION_ARN [OPTIONS] ``` ## Arguments obligatoires `DURABLE_EXECUTION_ARN` Le nom de ressource Amazon (ARN) de la fonction durable dont vous souhaitez récupérer l'historique. ## Options `--format [table|json]` Format de la sortie. Valeur par défaut : `table` `--region TEXT` Définissez la AWS région du service (par exemple,`us-east-1`). `--profile TEXT` Sélectionnez un profil spécifique dans votre fichier d'informations d'identification pour obtenir des AWS informations d'identification. `--config-env TEXT` Nom de l'environnement spécifiant les valeurs des paramètres par défaut dans le fichier de configuration. Valeur par défaut : `default` `--config-file TEXT` Fichier de configuration contenant les valeurs des paramètres par défaut. Valeur par défaut : `samconfig.toml` `--save-params` Enregistrez les paramètres fournis via la ligne de commande dans le fichier de configuration. `--beta-features / --no-beta-features` Activer/désactiver les fonctionnalités bêta. `--debug` Activez la journalisation du débogage pour imprimer les messages de débogage générés par la AWS SAM CLI et afficher les horodatages. `-h, --help` Affiche ce message, puis se ferme. ## Exemples Obtenez l'historique des exécutions avec le format de tableau par défaut : ``` $ sam remote execution history arn:aws:lambda:us-east-1:123456789012:function:MyFunction:$LATEST/durable-execution/my-execution-name/my-execution-id ``` Obtenez l'historique des exécutions au format JSON : ``` $ sam remote execution history arn:aws:lambda:us-east-1:123456789012:function:MyFunction:$LATEST/durable-execution/my-execution-name/my-execution-id --format json ``` # sam remote execution stop Arrêtez l'exécution d'une fonction durable en cours d'exécution dans AWS Lambda. L'ARN d'exécution doit être au format renvoyé StartDurableExecution ou trouvé dans les journaux d'exécution. **Note** Cette commande nécessite l'accès aux AWS informations d'identification. ## Usage ``` $ sam remote execution stop DURABLE_EXECUTION_ARN [OPTIONS] ``` ## Arguments obligatoires `DURABLE_EXECUTION_ARN` L'Amazon Resource Name (ARN) de l'exécution de la fonction durable à arrêter. ## Options `--error-message TEXT` Message d'erreur à associer à l'arrêt de l'exécution. `--error-type TEXT` Type d'erreur à associer à l'arrêt de l'exécution. `--error-data TEXT` Données d'erreur à associer à l'exécution arrêtée. `--stack-trace TEXT` Empilez les entrées de suivi. Cette option peut être spécifiée plusieurs fois. `--region TEXT` Définissez la AWS région du service (par exemple,`us-east-1`). `--profile TEXT` Sélectionnez un profil spécifique dans votre fichier d'informations d'identification pour obtenir des AWS informations d'identification. `--config-env TEXT` Nom de l'environnement spécifiant les valeurs des paramètres par défaut dans le fichier de configuration. Valeur par défaut : `default` `--config-file TEXT` Fichier de configuration contenant les valeurs des paramètres par défaut. Valeur par défaut : `samconfig.toml` `--save-params` Enregistrez les paramètres fournis via la ligne de commande dans le fichier de configuration. `--beta-features / --no-beta-features` Activer/désactiver les fonctionnalités bêta. `--debug` Activez la journalisation du débogage pour imprimer les messages de débogage générés par la AWS SAM CLI et afficher les horodatages. `-h, --help` Affiche ce message, puis se ferme. ## Exemples Arrêtez l'exécution sans détails sur l'erreur : ``` $ sam remote execution stop arn:aws:lambda:us-east-1:123456789012:function:MyFunction:$LATEST/durable-execution/my-execution-name/my-execution-id ``` Arrêtez l'exécution avec un message d'erreur et tapez : ``` $ sam remote execution stop arn:aws:lambda:us-east-1:123456789012:function:MyFunction:$LATEST/durable-execution/my-execution-name/my-execution-id --error-message "Execution cancelled" --error-type "UserCancellation" ``` Arrêtez l'exécution en indiquant tous les détails de l'erreur et en enregistrant la trace : ``` $ sam remote execution stop arn:aws:lambda:us-east-1:123456789012:function:MyFunction:$LATEST/durable-execution/my-execution-name/my-execution-id --error-message "Task failed" --error-type "TaskFailure" --error-data '{"reason":"timeout"}' --stack-trace "at function1()" --stack-trace "at function2()" ``` # sam remote invoke Cette page fournit des informations de référence pour la AWS Serverless Application Model commande Command Line Interface (AWS SAMCLI)`sam remote invoke`. + Pour une introduction à la AWS SAMCLI, voir [Qu'est-ce que c'est AWS SAMCLI ?](what-is-sam-overview.md#what-is-sam-cli) + Pour obtenir de la documentation sur l'utilisation de la AWS SAMCLI `sam remote invoke` commande, consultez[Présentation des tests dans le cloud avec sam remote invoke](using-sam-cli-remote-invoke.md). La `sam remote invoke` commande invoque les ressources prises en charge dans le AWS Cloud. ## Usage ``` $ sam remote invoke ``` ## Arguments **ID de ressource** L'ID de la ressource prise en charge à invoquer. Cet argument accepte les valeurs suivantes : + **Amazon Resource Name (ARN)** — L'ARN de la ressource. **Astuce** `sam list stack-outputs --stack-name `À utiliser pour obtenir l'ARN de vos ressources. + **ID logique** — Identifiant logique de la ressource. Vous devez également fournir le nom de la AWS CloudFormation pile à l'aide de l'`--stack-name`option. + **Identifiant physique** — Identifiant physique de la ressource. Cet ID est créé lorsque vous déployez une ressource à l'aide de CloudFormation. **Astuce** `sam list resources --stack-name `À utiliser pour obtenir l'identifiant physique de vos ressources. **Lorsque vous fournissez un ARN ou un identifiant physique :** Si vous fournissez un ARN ou un identifiant physique, ne fournissez pas de nom de pile. Lorsque le nom de la pile est fourni à l'aide de l'`--stack-name`option, ou lorsque le nom de la pile est défini dans votre fichier de configuration, votre identifiant de ressource AWS SAM CLI sera automatiquement traité comme une valeur d'identifiant logique issue de la CloudFormation pile. **Lorsque vous ne fournissez pas d'ID de ressource :** Si vous ne fournissez pas d'ID de ressource, mais que vous fournissez un nom de pile avec l'`--stack-name`option, la AWS SAM CLI essaiera d'invoquer automatiquement une ressource dans votre CloudFormation pile en utilisant la logique suivante : 1. Ils AWS SAM CLI identifieront les types de ressources dans l'ordre suivant et passeront à l'étape suivante une fois que le type de ressource aura été trouvé dans votre pile : 1. Lambda 1. Step Functions 1. Amazon SQS 1. Kinesis Data Streams 1. Si le type de ressource ne contient qu'une seule ressource dans votre pile, il l' AWS SAM CLIinvoquera. Si plusieurs ressources du type de ressource existent dans votre pile, une erreur AWS SAM CLI sera renvoyée. Voici des exemples de ce qu'ils AWS SAM CLI feront : + **Pile contenant deux fonctions Lambda et une file d'attente Amazon SQS : elle localisera AWS SAM CLI le type de ressource Lambda et renverra une erreur puisque la pile** contient plusieurs fonctions Lambda. + **Pile contenant une fonction Lambda et deux applications Amazon Kinesis Data Streams** : elle AWS SAM CLI localisera la fonction Lambda et l'invoquera, car la pile contient une seule ressource Lambda. + **Pile contenant une seule file d'attente Amazon SQS et deux applications Kinesis Data Streams. Elle AWS SAM CLI localisera la file d'attente Amazon SQS et l'invoquera, car la pile** contient une seule file d'attente Amazon SQS. ## Options `--beta-features | --no-beta-features` Autorisez ou refusez les fonctionnalités bêta. `--config-env TEXT` Spécifiez l'environnement à utiliser à partir de votre fichier de configuration CLI  AWS SAM. *Par défaut* : `default` `--config-file FILENAME` Spécifiez le nom de votre compartiment et le nom du fichier de configuration. Pour plus d'informations sur les fichiers de configuration, consultez [Configuration de la CLI  AWS SAM](using-sam-cli-configure.md). *Par défaut* : `samconfig.toml` à la racine du répertoire de votre projet. `--debug` Activez la journalisation des débogues. Cela imprime les messages de débogage et les horodatages générés par la CLI  AWS SAM. `--event, -e TEXT` L'événement à envoyer à la ressource cible. `--event-file FILENAME` Le chemin d'accès à un fichier contenant l'événement à envoyer à la ressource cible. `--help, -h` Affichez le message d'aide, puis fermez. `--output [ text | json ]` Exportez les résultats de votre invocation dans un format de sortie spécifique. `json`— Les métadonnées de la demande et la réponse aux ressources sont renvoyées dans la structure JSON. La réponse contient la sortie complète du SDK. `text`— Les métadonnées de la demande sont renvoyées sous forme de texte. La réponse à la ressource est renvoyée dans le format de sortie de la ressource invoquée. `--parameter` Paramètres supplémentaires [https://boto3.amazonaws.com/v1/documentation/api/latest/index.html](https://boto3.amazonaws.com/v1/documentation/api/latest/index.html) que vous pouvez transmettre à la ressource invoquée. **Amazon Kinesis Data Streams** Les paramètres supplémentaires suivants peuvent être utilisés pour placer un enregistrement dans le flux de données Kinesis : + `ExplicitHashKey='string'` + `PartitionKey='string'` + `SequenceNumberForOrdering='string'` + `StreamARN='string'` Pour une description de chaque paramètre, consultez [Kinesis.client.PUT\$1RECORD](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/put_record.html). **AWS Lambda** Les paramètres supplémentaires suivants peuvent être utilisés pour appeler une ressource Lambda et recevoir une réponse mise en mémoire tampon : + `ClientContext='base64-encoded string'` + `InvocationType='[ DryRun | Event | RequestResponse ]'` + `LogType='[ None | Tail ]'` + `Qualifier='string'` Les paramètres supplémentaires suivants peuvent être utilisés pour appeler une ressource Lambda avec diffusion des réponses : + `ClientContext='base64-encoded string'` + `InvocationType='[ DryRun | RequestResponse ]'` + `LogType='[ None | Tail ]'` + `Qualifier='string'` Pour obtenir une description de chaque paramètre, consultez les rubriques suivantes : + Lambda avec réponse mise en mémoire tampon — [Lambda.Client.Invoke](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/lambda/client/invoke.html) + Lambda avec diffusion de réponses — [Lambda.Client.Invoke\$1With\$1Response\$1Stream](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/lambda/client/invoke_with_response_stream.html) **Amazon Simple Queue Service (Amazon SQS)** Les paramètres supplémentaires suivants peuvent être utilisés pour envoyer un message à une file d'attente Amazon SQS : + `DelaySeconds=integer` + `MessageAttributes='json string'` + `MessageDeduplicationId='string'` + `MessageGroupId='string'` + `MessageSystemAttributes='json string'` Pour une description de chaque paramètre, consultez [SQS.Client.Send\$1Message](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sqs/client/send_message.html). **AWS Step Functions** Les paramètres supplémentaires suivants peuvent être utilisés pour démarrer l'exécution d'une machine à états : + `name='string'` + `traceHeader='string'` Pour une description de chaque paramètre, consultez [SFN.Client.Start\$1Execution](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/stepfunctions/client/start_execution.html). `--profile TEXT` Le profil spécifique de votre fichier d'informations d'identification pour obtenir des AWS informations d'identification. `--region TEXT` Le Région AWS de la ressource. Par exemple, `us-east-1`. `--stack-name TEXT` Nom de la CloudFormation pile à laquelle appartient la ressource. `--tenant-id TEXT` L'ID de locataire pour les fonctions Lambda à locataires multiples. Utilisé pour garantir l'isolation informatique entre les différents locataires. Obligatoire lors de l'appel de fonctions configurées avec le mode d'isolation des locataires. `--test-event-name NAME` Nom de l'événement de test partageable à transmettre à votre fonction Lambda. Cette option ne prend en charge que les fonctions Lambda. ## Exemple L'exemple suivant invoque les ressources prises en charge dans le AWS Cloud et active la journalisation du débogage, qui imprime les messages de débogage et les horodatages générés par : AWS SAMCLI ``` $ sam remote invoke--debug ``` # sam remote test-event Cette page fournit des informations de référence pour la AWS Serverless Application Model commande Command Line Interface (AWS SAMCLI)`sam remote test-event`. + Pour une introduction à la AWS SAMCLI, voir [Qu'est-ce que c'est AWS SAMCLI ?](what-is-sam-overview.md#what-is-sam-cli) + Pour obtenir de la documentation sur l'utilisation de la AWS SAMCLI `sam remote test-event` commande, consultez[Présentation des tests dans le cloud avec sam remote test-event](using-sam-cli-remote-test-event.md). La `sam remote test-event` commande interagit avec les événements de test partageables dans le registre des EventBridge schémas Amazon. ## Usage ``` $ sam remote test-event ``` ## Options `--help, -h` Affichez le message d'aide, puis fermez. ## Sous-commandes `delete` Supprimez un événement de test partageable du registre des EventBridge schémas. Pour plus d'informations de référence, consultez [sam remote test-event delete](sam-cli-command-reference-remote-test-event-delete.md). `get` Obtenez un événement de test partageable à partir du registre des EventBridge schémas. Pour plus d'informations de référence, consultez [sam remote test-event get](sam-cli-command-reference-remote-test-event-get.md). `list` Répertoriez les événements de test partageables existants pour une AWS Lambda fonction. Pour plus d'informations de référence, consultez [sam remote test-event list](sam-cli-command-reference-remote-test-event-list.md). `put` Enregistrez un événement depuis un fichier local dans le registre des EventBridge schémas. Pour plus d'informations de référence, consultez [sam remote test-event put](sam-cli-command-reference-remote-test-event-put.md). # sam remote test-event delete Cette page fournit des informations de référence pour la AWS Serverless Application Model `sam remote test-event delete` sous-commande Command Line Interface (AWS SAMCLI). + Pour une introduction à la AWS SAMCLI, voir [Qu'est-ce que c'est AWS SAMCLI ?](what-is-sam-overview.md#what-is-sam-cli) + Pour obtenir de la documentation sur l'utilisation de la AWS SAMCLI `sam remote test-event` commande, consultez[Présentation des tests dans le cloud avec sam remote test-event](using-sam-cli-remote-test-event.md). La `sam remote test-event delete` sous-commande supprime un événement de test partageable du registre des schémas Amazon EventBridge . ## Usage ``` $ sam remote test-event delete ``` ## Arguments **ID de ressource** ID de la AWS Lambda fonction associée à l'événement de test partageable. Si vous fournissez un identifiant logique, vous devez également fournir une valeur pour la AWS CloudFormation pile associée à la fonction Lambda à l'aide de l'`--stack-name`option. *Valeurs valides* : ID logique ou ARN de la ressource. ## Options `--config-env TEXT` Le nom d’environnement spécifiant les valeurs de paramètre par défaut dans le fichier de configuration à utiliser. La valeur par défaut est « par défaut ». Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--config-file PATH` Le chemin d’accès et le nom du fichier de configuration contenant les valeurs de paramètres par défaut à utiliser. La valeur par défaut est « `samconfig.toml` » dans la racine du répertoire du projet. Pour plus d’informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--help, -h` Affichez le message d'aide, puis fermez. `--name TEXT` Nom de l'événement de test partageable à supprimer. `--stack-name TEXT` Nom de la CloudFormation pile associée à la fonction Lambda. Cette option est obligatoire si vous fournissez l'ID logique de la fonction Lambda en tant qu'argument. # sam remote test-event get Cette page fournit des informations de référence pour la AWS Serverless Application Model `sam remote test-event get` sous-commande Command Line Interface (AWS SAMCLI). + Pour une introduction à la AWS SAMCLI, voir [Qu'est-ce que c'est AWS SAMCLI ?](what-is-sam-overview.md#what-is-sam-cli) + Pour obtenir de la documentation sur l'utilisation de la AWS SAMCLI `sam remote test-event` commande, consultez[Présentation des tests dans le cloud avec sam remote test-event](using-sam-cli-remote-test-event.md). La `sam remote test-event get` sous-commande obtient un événement de test partageable depuis le registre des EventBridge schémas Amazon. ## Usage ``` $ sam remote test-event get ``` ## Arguments **ID de ressource** L'ID de la AWS Lambda fonction associée à l'événement de test partageable à obtenir. Si vous fournissez un identifiant logique, vous devez également fournir une valeur pour la AWS CloudFormation pile associée à la fonction Lambda à l'aide de l'`--stack-name`option. *Valeurs valides* : ID logique ou ARN de la ressource. ## Options `--config-env TEXT` Le nom d’environnement spécifiant les valeurs de paramètre par défaut dans le fichier de configuration à utiliser. La valeur par défaut est « par défaut ». Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--config-file PATH` Le chemin d’accès et le nom du fichier de configuration contenant les valeurs de paramètres par défaut à utiliser. La valeur par défaut est « `samconfig.toml` » dans la racine du répertoire du projet. Pour plus d’informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--help, -h` Affichez le message d'aide, puis fermez. `--name TEXT` Nom de l'événement de test partageable à obtenir. `--output-file FILENAME` Chemin et nom du fichier dans lesquels enregistrer l'événement sur votre ordinateur local. Si vous ne fournissez pas cette option, le contenu de l'événement de test partageable AWS SAM CLI sera affiché sur votre console. `--stack-name TEXT` Nom de la CloudFormation pile associée à la fonction Lambda. Cette option est obligatoire si vous fournissez l'ID logique de la fonction Lambda en tant qu'argument. # sam remote test-event list Cette page fournit des informations de référence pour la AWS Serverless Application Model `sam remote test-event list` sous-commande Command Line Interface (AWS SAMCLI). + Pour une introduction à la AWS SAMCLI, voir [Qu'est-ce que c'est AWS SAMCLI ?](what-is-sam-overview.md#what-is-sam-cli) + Pour obtenir de la documentation sur l'utilisation de la AWS SAMCLI `sam remote test-event` commande, consultez[Présentation des tests dans le cloud avec sam remote test-event](using-sam-cli-remote-test-event.md). La `sam remote test-event list` sous-commande répertorie les événements de test partageables existants pour une AWS Lambda fonction spécifique à partir du registre des EventBridge schémas Amazon. ## Usage ``` $ sam remote test-event list ``` ## Arguments **ID de ressource** ID de la fonction Lambda associée aux événements de test partageables. Si vous fournissez un identifiant logique, vous devez également fournir une valeur pour la AWS CloudFormation pile associée à la fonction Lambda à l'aide de l'`--stack-name`option. *Valeurs valides* : ID logique ou ARN de la ressource. ## Options `--config-env TEXT` Le nom d’environnement spécifiant les valeurs de paramètre par défaut dans le fichier de configuration à utiliser. La valeur par défaut est « par défaut ». Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--config-file PATH` Le chemin d’accès et le nom du fichier de configuration contenant les valeurs de paramètres par défaut à utiliser. La valeur par défaut est « `samconfig.toml` » dans la racine du répertoire du projet. Pour plus d’informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--help, -h` Affichez le message d'aide, puis fermez. `--stack-name TEXT` Nom de la CloudFormation pile associée à la fonction Lambda. Cette option est obligatoire si vous fournissez l'ID logique de la fonction Lambda en tant qu'argument. ## Exemples Pour des exemples d'utilisation de cette commande, reportez-vous à[Liste d'événements de test partageables](using-sam-cli-remote-test-event.md#using-sam-cli-remote-test-event-use-list). # sam remote test-event put Cette page fournit des informations de référence pour la AWS Serverless Application Model `sam remote test-event put` sous-commande Command Line Interface (AWS SAMCLI). + Pour une introduction à la AWS SAMCLI, voir [Qu'est-ce que c'est AWS SAMCLI ?](what-is-sam-overview.md#what-is-sam-cli) + Pour obtenir de la documentation sur l'utilisation de la AWS SAMCLI `sam remote test-event` commande, consultez[Présentation des tests dans le cloud avec sam remote test-event](using-sam-cli-remote-test-event.md). La `sam remote test-event put` sous-commande enregistre un événement de test partageable depuis votre machine locale dans le registre des EventBridge schémas Amazon. ## Usage ``` $ sam remote test-event put ``` ## Arguments **ID de ressource** ID de la AWS Lambda fonction associée à l'événement de test partageable. Si vous fournissez un identifiant logique, vous devez également fournir une valeur pour la AWS CloudFormation pile associée à la fonction Lambda à l'aide de l'`--stack-name`option. *Valeurs valides* : ID logique ou ARN de la ressource. ## Options `--config-env TEXT` Le nom d’environnement spécifiant les valeurs de paramètre par défaut dans le fichier de configuration à utiliser. La valeur par défaut est « par défaut ». Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--config-file PATH` Le chemin d’accès et le nom du fichier de configuration contenant les valeurs de paramètres par défaut à utiliser. La valeur par défaut est « `samconfig.toml` » dans la racine du répertoire du projet. Pour plus d’informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--file FILENAME` Chemin et nom du fichier de l'événement sur votre ordinateur local. Indiquez `-` comme valeur de nom de fichier à lire à partir de `stdin`. Cette option est obligatoire. `--force`, `-f` Remplacez un événement de test partageable portant le même nom. `--help, -h` Affichez le message d'aide, puis fermez. `--name TEXT` Nom sous lequel enregistrer l'événement de test partageable. Si un événement de test partageable portant le même nom existe dans le registre du EventBridge schéma, il ne le AWS SAM CLI remplacera pas. Pour le remplacer, ajoutez l'option `--force`. `--output-file FILENAME` Chemin et nom du fichier dans lesquels enregistrer l'événement sur votre ordinateur local. Si vous ne fournissez pas cette option, le contenu de l'événement de test partageable AWS SAM CLI sera affiché sur votre console. `--stack-name TEXT` Nom de la CloudFormation pile associée à la fonction Lambda. Cette option est obligatoire si vous fournissez l'ID logique de la fonction Lambda en tant qu'argument. ## Exemple Pour un exemple d'utilisation de cette commande, reportez-vous à[Enregistrement d'événements de test partageables](using-sam-cli-remote-test-event.md#using-sam-cli-remote-test-event-use-put). # sam sync Cette page fournit des informations de référence pour la AWS Serverless Application Model commande Command Line Interface (AWS SAMCLI)`sam sync`. + Pour une introduction à la AWS SAMCLI, voir [Qu'est-ce que c'est AWS SAMCLI ?](what-is-sam-overview.md#what-is-sam-cli) + Pour obtenir de la documentation sur l'utilisation du AWS SAMCLI, voir[AWS SAM CLI](using-sam-cli.md). La commande `sam sync` synchronise les modifications apportées de l’application locale à AWS Cloud. ## Usage ``` $ sam sync ``` ## Options `--base-dir, -s DIRECTORY` Résout les chemins relatifs au code source de la fonction ou de la couche par rapport à ce répertoire. Utilisez cette option pour modifier la façon dont les chemins d'accès relatifs aux dossiers de code source sont résolus. Par défaut, les chemins relatifs sont résolus en fonction de l'emplacement du AWS SAM modèle. Outre les ressources de l'application ou de la pile racine que vous créez, cette option s'applique également aux applications ou piles imbriquées. En outre, cette option s'applique aux types de ressources et propriétés suivants : + Type de ressource : propriété `AWS::Serverless::Function` : `CodeUri` + Type de ressource : attribut de ressource `AWS::Serverless::Function` : entrée `Metadata` : `DockerContext` + Type de ressource : propriété `AWS::Serverless::LayerVersion` : `ContentUri` + Type de ressource : propriété `AWS::Lambda::Function` : `Code` + Type de ressource : propriété `AWS::Lambda::LayerVersion` : `Content` `--build-image TEXT` L'URI de l'[image de conteneur](serverless-image-repositories.md#serverless-image-repository-uris) que vous souhaitez utiliser lors de la création de votre application. AWS SAM Utilise par défaut l'URI du référentiel d'images de conteneurs provenant d'[Amazon Elastic Container Registry (Amazon ECR) Public](https://docs.aws.amazon.com/AmazonECR/latest/public/what-is-ecr.html). Spécifiez cette option pour utiliser une autre image. Vous pouvez utiliser cette option plusieurs fois au sein d'une même commande. Chaque option accepte une chaîne de caractères ou une paire clé-valeur. + **Chaîne de caractères** : si vous spécifiez une chaîne de caractères, il s'agit de l'URI de l'image de conteneur qui sera utilisée par toutes les ressources de l'application. En voici un exemple : ``` $ sam sync --build-image amazon/aws-sam-cli-build-image-python3.8 ``` + **Paire clé-valeur** : spécifiez le nom de la ressource comme clé et l'URI de l'image du conteneur à utiliser avec cette ressource comme valeur. Utilisez ce format pour spécifier un URI d'image de conteneur différent pour chaque ressource de votre application. Voici un exemple : ``` $ sam sync --build-image Function1=amazon/aws-sam-cli-build-image-python3.8 ``` Cette option ne s’applique que si l’option `--use-container` est spécifiée, dans le cas contraire, une erreur se produit. `--build-in-source | --no-build-in-source` Fournit `--build-in-source` pour créer votre projet directement dans le dossier source. L'option `--build-in-source` prend en charge les systèmes d’exécution ainsi que les méthodes de création suivantes : + **exécutions** : toute méthode d’exécution Node.js prise en charge par l'option `sam init --runtime`. + **Méthodes de construction** : `Makefile`, `esbuild`. L'option `--build-in-source` n'est pas compatible avec celles suivantes : + `--use-container ` *Par défaut* : `--no-build-in-source` `--capabilities LIST` Liste des fonctionnalités que vous spécifiez pour CloudFormation autoriser la création de certaines piles. Certains modèles de pile peuvent inclure des ressources susceptibles d'affecter les autorisations de votre Compte AWS. Par exemple, en créant de nouveaux utilisateurs Gestion des identités et des accès AWS (IAM). Spécifiez cette option pour remplacer les valeurs par défaut. Les valeurs valides sont les suivantes : + CAPABILITY\$1IAM + CAPABILITY\$1NAMED\$1IAM + CAPABILITY\$1RESOURCE\$1POLICY + CAPABILITY\$1AUTO\$1EXPAND *Par défaut* : `CAPABILITY_NAMED_IAM` et `CAPABILITY_AUTO_EXPAND` `--code` Par défaut, AWS SAM synchronise toutes les ressources de votre application. Spécifiez cette option pour synchroniser uniquement les ressources de code, qui comprennent les éléments suivants : + `AWS::Serverless::Function` + `AWS::Lambda::Function` + `AWS::Serverless::LayerVersion` + `AWS::Lambda::LayerVersion` + `AWS::Serverless::Api` + `AWS::ApiGateway::RestApi` + `AWS::Serverless::HttpApi` + `AWS::ApiGatewayV2::Api` + `AWS::Serverless::StateMachine` + `AWS::StepFunctions::StateMachine` Pour synchroniser les ressources de code, AWS SAM utilise APIs directement le AWS service, au lieu de le déployer via AWS CloudFormation. Pour mettre à jour votre CloudFormation stack, exécutez **sam sync --watch** ou**sam deploy**. `--config-env TEXT` Le nom d’environnement spécifiant les valeurs de paramètre par défaut dans le fichier de configuration à utiliser. La valeur par défaut est « par défaut ». Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--config-file PATH` Le chemin d’accès et le nom du fichier de configuration contenant les valeurs de paramètres par défaut à utiliser. La valeur par défaut est « `samconfig.toml` » dans la racine du répertoire du projet. Pour plus d’informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--dependency-layer | --no-dependency-layer` Spécifie s'il faut séparer les dépendances des fonctions individuelles dans une autre couche pour accélérer le processus de synchronisation. *Par défaut* : `--dependency-layer` `--image-repository TEXT` Le nom du référentiel Amazon Elastic Container Registry (Amazon ECR) vers lequel cette commande télécharge l’image de la fonction. Requis pour les fonctions déclarées avec le type de package `Image`. `--image-repositories TEXT` Un mappage des fonctions vers l'URI de leur référentiel Amazon ECR. Référencez les fonctions par leur identifiant logique. Voici un exemple : ``` $ sam sync --image-repositories Function1=123456789012.dkr.ecr.us-east-1.amazonaws.com/my-repo ``` Vous pouvez spécifier cette option plusieurs fois au sein d'une même commande. `--kms-key-id TEXT` L'ID d'une clé AWS Key Management Service (AWS KMS) utilisée pour chiffrer les artefacts inactifs dans le compartiment Amazon S3. Si vous ne spécifiez pas cette option, AWS SAM utilise les clés de chiffrement gérées par Amazon S3. `--metadata` Un mappage de métadonnées à attacher à tous les artefacts que vous référencez dans votre modèle. `--notification-arns LIST` Liste des rubriques Amazon Simple Notification Service (Amazon SNS) ARNs associées à la CloudFormation pile. `--no-use-container` Option qui vous permet d'utiliser le kit d'outils IDE pour définir le comportement par défaut. `--parameter-overrides` Chaîne contenant des remplacements de CloudFormation paramètres codés sous forme de paires clé-valeur. Utilisez le même format que le AWS Command Line Interface (AWS CLI). Le AWS SAMCLI format est basé sur des mots clés et valeurs explicites, chaque remplacement étant séparé par un espace. Voici deux exemples : + `--parameter-overrides ParameterKey=hello,ParameterValue=world` + `--parameter-overrides ParameterKey=hello,ParameterValue=world ParameterKey=example1,ParameterValue=example2 ParameterKey=apple,ParameterValue=banana` `--resource TEXT` Spécifie le type de ressource à synchroniser. Pour synchroniser plusieurs ressources, vous pouvez spécifier cette option plusieurs fois. Cette option est prise en charge avec l'option `--code`. La valeur doit correspondre à l'une des ressources répertoriées sous `--code`. Par exemple, `--resource AWS::Serverless::Function --resource AWS::Serverless::LayerVersion`. `--resource-id TEXT` Spécifie l’identifiant de la ressource à synchroniser. Pour synchroniser plusieurs ressources, vous pouvez spécifier cette option plusieurs fois. Cette option est prise en charge avec l'option `--code`. Par exemple, `--resource-id Function1 --resource-id Function2`. `--role-arn TEXT` Nom de ressource Amazon (ARN) d'un rôle IAM CloudFormation assumé lors de l'application de l'ensemble de modifications. `--s3-bucket TEXT` Nom du compartiment Amazon Simple Storage Service (Amazon S3) dans lequel cette commande télécharge CloudFormation votre modèle. Si le modèle est supérieur à 51 200 octets, le `--s3-bucket` ou l’option `--resolve-s3` sont obligatoires. Si vous spécifiez les deux options `--s3-bucket` et `--resolve-s3`, une erreur se produit. `--s3-prefix TEXT` Le préfixe ajouté aux noms des artefacts que vous chargez dans le compartiment Amazon S3. Le nom du préfixe est un nom de chemin d’accès (nom de dossier) pour le compartiment Amazon S3. Cela s'applique uniquement aux fonctions déclarées avec le type de package `Zip`. `--save-params` Enregistre les paramètres que vous fournissez sur la ligne de commande dans le fichier AWS SAM de configuration. `--skip-deploy-sync | --no-skip-deploy-sync` Spécifie `--skip-deploy-sync` pour ignorer la synchronisation initiale de l'infrastructure si elle n'est pas requise. Le AWS SAMCLI comparera votre AWS SAM modèle local avec le CloudFormation modèle déployé et n'effectuera un déploiement que si une modification est détectée. Spécifie `--no-skip-deploy-sync` d'effectuer un CloudFormation déploiement à `sam sync` chaque exécution. Pour en savoir plus, veuillez consulter la section [Ignorer le CloudFormation déploiement initial](using-sam-cli-sync.md#using-sam-cli-sync-options-skip-deploy-sync). *Par défaut* : `--skip-deploy-sync` `--stack-name TEXT` Le nom de la CloudFormation pile de votre application. Cette option est obligatoire. `--tags LIST` Liste de balises à associer à la pile créée ou mise à jour. CloudFormation propage également ces balises aux ressources de la pile qui les supportent. `--template-file, --template, -t PATH` Le chemin et le nom du fichier où se trouve votre AWS SAM modèle. Si vous spécifiez cette option, AWS SAM déploie uniquement le modèle et les ressources locales vers lesquels il pointe. `--use-container, -u` Si vos fonctions dépendent de packages dont les dépendances sont compilées de manière native, utilisez cette option pour créer votre fonction dans un Docker conteneur AWS Lambda similaire. Actuellement, cette option n'est pas compatible avec `--dependency-layer`. Si vous utilisez `--use-container` avec `--dependency-layer`, la CLI  AWS SAM vous en informe et continue avec `--no-dependency-layer`. `--watch` Lance un processus qui surveille les modifications apportées par votre application locale et les synchronise automatiquement avec le AWS Cloud. Par défaut, lorsque vous spécifiez cette option, toutes les ressources de votre application sont AWS SAM synchronisées au fur et à mesure que vous les mettez à jour. Avec cette option, AWS SAM effectue un CloudFormation déploiement initial. AWS SAM Utilise ensuite le AWS service APIs pour mettre à jour les ressources du code. AWS SAM utilise CloudFormation pour mettre à jour les ressources de l'infrastructure lorsque vous mettez à jour votre AWS SAM modèle. `--watch-exclude TEXT` Empêche un fichier ou un dossier d’être observé en cas de modification de fichier. Pour utiliser cette option, `--watch` doit également être fournie. Cette option reçoit une paire clé-valeur : + **clé** : ID logique d'une fonction Lambda dans votre application. + **valeur** : nom du fichier ou du dossier associé à exclure. Lorsque vous mettez à jour des fichiers ou des dossiers spécifiés avec l'`--watch-exclude`option, aucune synchronisation ne AWS SAM CLI sera lancée. Toutefois, lorsqu'une mise à jour d'autres fichiers ou dossiers initie une synchronisation, ceux-ci ou sont inclus dans cette synchronisation. Vous pouvez fournir cette option plusieurs fois dans une seule commande. ## Exemples Pour des exemples d'utilisation de cette commande, reportez-vous à[Options pour la commande sam sync](using-sam-cli-sync.md#using-sam-cli-sync-options). # sam traces Cette page fournit des informations de référence pour la AWS Serverless Application Model commande Command Line Interface (AWS SAMCLI)`sam traces`. Pour une introduction à la AWS SAMCLI, voir [Qu'est-ce que c'est AWS SAMCLI ?](what-is-sam-overview.md#what-is-sam-cli) La `sam traces` commande récupère les AWS X-Ray traces Compte AWS dans votre fichier. Région AWS ## Usage ``` $ sam traces ``` ## Options `--config-env TEXT` Le nom d’environnement spécifiant les valeurs de paramètre par défaut dans le fichier de configuration à utiliser. La valeur par défaut est « par défaut ». Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--config-file PATH` Le chemin d’accès et le nom du fichier de configuration contenant les valeurs de paramètres par défaut à utiliser. La valeur par défaut est « `samconfig.toml` » dans la racine du répertoire du projet. Pour plus d’informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--end-time TEXT` Récupère les traces jusqu'à ce moment. L'heure peut être une valeur relative comme « il y a 5 minutes », « demain » ou un horodatage formaté comme « 2018-01-01 10:10:10 ». `--output TEXT` Spécifie le format de sortie pour les journaux. Pour imprimer des journaux formatés, spécifiez `text`. Pour imprimer les journaux au format JSON, spécifiez `json`. `--save-params` Enregistrez les paramètres que vous fournissez sur la ligne de commande dans le fichier AWS SAM de configuration. `--start-time TEXT` Récupère les traces en ce moment. L'heure peut être une valeur relative comme « il y a 5 minutes », « hier » ou un horodatage formaté comme « 2018-01-01 10:10:10 ». La valeur par défaut est « il y a 10 minutes ». `--tail` Suit la sortie de la trace. Cette méthode ignore l'argument des heures de fin de fin et continue d'afficher les traces au fur et à mesure qu'elles deviennent disponibles. `--trace-id TEXT` Identifiant unique pour une trace X-Ray. ## Exemples Exécutez la commande suivante pour récupérer les traces de X-Ray par identifiant. ``` $ sam traces --trace-id tracing-id-1 --trace-id tracing-id-2 ``` Exécutez la commande suivante pour suivre les traces X-Ray au fur et à mesure qu'elles deviennent disponibles. ``` $ sam traces --tail ``` # sam validate Cette page fournit des informations de référence pour la AWS Serverless Application Model commande Command Line Interface (AWS SAMCLI)`sam validate`. Pour une introduction à la AWS SAMCLI, voir [Qu'est-ce que c'est AWS SAMCLI ?](what-is-sam-overview.md#what-is-sam-cli) La `sam validate` commande vérifie si un fichier AWS SAM modèle est valide. ## Usage ``` $ sam validate ``` ## Options `--config-env TEXT` Le nom d’environnement spécifiant les valeurs de paramètre par défaut dans le fichier de configuration à utiliser. La valeur par défaut est « par défaut ». Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--config-file PATH` Le chemin d'accès et le nom du fichier de configuration contenant les valeurs de paramètres par défaut à utiliser. La valeur par défaut est « samconfig.toml » dans la racine du répertoire du projet. Pour plus d'informations sur les fichiers de configuration, consultez [Fichier de configuration CLI AWS SAM](serverless-sam-cli-config.md). `--debug` Active la journalisation de débogage pour imprimer le message de débogage généré par la CLI  AWS SAM et pour afficher les horodatages. `--lint` Exécutez la validation linting sur le modèle via **cfn-lint**. Créez un fichier de configuration `cfnlintrc` pour spécifier des paramètres supplémentaires. *Pour plus d'informations, consultez [cfn-lint dans le référentiel.](https://github.com/aws-cloudformation/cfn-lint)CloudFormation GitHub * `--profile TEXT` Le profil spécifique de votre fichier d'informations d'identification qui obtient les AWS informations d'identification. `--region TEXT` AWS Région dans laquelle le déploiement doit être effectué. Par exemple, us-east-1. `--save-params` Enregistrez les paramètres que vous fournissez sur la ligne de commande dans le fichier AWS SAM de configuration. `--template-file, --template, -t PATH` Le fichier AWS SAM modèle. La valeur par défaut est `template.[yaml|yml]`. Si votre modèle se trouve dans votre répertoire de travail actuel et qu'il est nommé `template.[yaml|yml|json]`, cette option n'est pas obligatoire. Si vous venez d'exécuter **sam build**, cette option n'est pas obligatoire. ## Exemple Pour un exemple d'utilisation de cette commande pour valider un modèle, reportez-vous à[Valider les fichiers AWS SAM modèles](serverless-sam-cli-using-validate.md). Pour un exemple d'utilisation de cette commande avec cfn-lint, reportez-vous à. [Validez vos AWS SAM applications avec CloudFormation Linter](validate-cfn-lint.md)