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.
Fichiers d’entrées et squelettes de l’AWS CLI dans l’AWS CLI
La plupart des commandes de l’AWS CLI acceptent l’importation des entrées de paramètres à partir d’un fichier. Ces modèles peuvent être générés à l’aide de l’option generate-cli-skeleton, puis importés à l’aide des paramètres --cli-input-json et --cli-input-yaml.
Rubriques
À propos des fichiers d’entrée et des squelettes de l’AWS CLI
La plupart des commandes de l’AWS Command Line Interface (AWS CLI) prennent en charge la possibilité d’accepter les entrées de paramètres à partir d’un fichier à l’aide des paramètres --cli-input-json et --cli-input-yaml.
Ces mêmes commandes utilisent le paramètre --generate-cli-skeleton pour générer un fichier soit au format JSON, soit au format YAML, avec tous les paramètres que vous pouvez modifier et renseigner. Vous pouvez ensuite exécuter la commande avec le paramètre --cli-input-json ou --cli-input-yaml et pointer vers le fichier renseigné.
Important
Les commandes personnalisées de l’AWS CLI, comme les commandes aws s3, ne prennent pas en charge les paramètres --generate-cli-skeleton ou --cli-input-json et --cli-input-yaml décrits dans cette rubrique. Pour vérifier si une commande spécifique prend en charge ces paramètres, exécutez la commande help pour la commande que vous souhaitez utiliser, ou consultez le ou le Guide de référence de la version 2 de l’AWS CLI.
--generate-cli-skeleton génère et affiche un modèle de paramètres que vous pouvez personnaliser et utiliser comme entrée dans une commande. Le modèle généré inclut tous les paramètres pris en charge par la commande.
Le paramètre --generate-cli-skeleton accepte l'une des valeurs suivantes :
-
input: le modèle généré inclut tous les paramètres d’entrée formatés en JSON. C’est la valeur par défaut. -
yaml-input: le modèle généré inclut tous les paramètres d’entrée formatés en YAML. -
output: le modèle généré inclut tous les paramètres de sortie formatés en JSON. Vous ne pouvez pas demander les paramètres de sortie en tant que YAML.
Comme l'AWS CLI est essentiellement un « wrapper » autour de l'API du service, le fichier de squelette s'attend à ce que vous référenciez tous les paramètres par leur nom de paramètre d'API sous-jacent. Ceci est probablement différent du nom du paramètre AWS CLI. Par exemple, un paramètre AWS CLI appelé user-name peut être mappé au paramètre d'API du service AWS nommé UserName (notez les majuscules modifiées et le tiret manquant). Nous vous recommandons d'utiliser l'option --generate-cli-skeleton pour générer le modèle avec les noms de paramètres « corrects » afin d'éviter des erreurs. Vous pouvez également consulter le Guide de référence des API pour le service afin de connaître le nom des paramètres attendus. Vous pouvez supprimer dans le modèle tous les paramètres qui ne sont pas obligatoires et pour lesquels vous ne souhaitez pas fournir de valeur.
Par exemple, si vous exécutez la commande suivante, elle génère le modèle de paramètre pour la commande run-instances Amazon Elastic Compute Cloud (Amazon EC2).
Génération et importation d’un squelette de commande
Pour générer et utiliser un fichier de squelette de paramètre
-
Exécutez la commande avec le paramètre
--generate-cli-skeletonpour produire soit un format JSON, soit un format YAML, et diriger la sortie vers un fichier pour l’enregistrer. -
Ouvrez le fichier de squelette de paramètre dans votre éditeur de texte et supprimez les paramètres dont vous n'avez pas besoin. Par exemple, vous pouvez supprimer le modèle comme suit. Assurez-vous que le fichier est toujours dans un format JSON ou YAML valide après avoir supprimé les éléments dont vous n’avez pas besoin.
Dans cet exemple, nous laissons le paramètre
DryRundéfini surtruepour utiliser la fonctionnalité d’essai Amazon EC2. Cette fonctionnalité vous permet de tester la commande en toute sécurité sans créer ou modifier de ressources. -
Remplissez les valeurs restantes avec les valeurs appropriées pour votre scénario. Dans cet exemple, nous fournissons le type d’instance, le nom de la clé, le groupe de sécurité et l’identifiant de l’AMI à utiliser. Cet exemple présume la Région AWS par défaut. L’AMI
ami-dfc39aefest une image Amazon Linux 64 bits hébergée dans la régionus-west-2. Si vous utilisez une autre région, vous devez identifier le bon ID d'AMI à utiliser. -
Exécutez la commande avec les paramètres complétés en passant le fichier de modèle terminé soit au paramètre
--cli-input-json, soit au paramètre --cli-input-yamlà l’aide du préfixefile://. L’AWS CLI interprète le chemin comme étant relatif au répertoire de travail actuel. Dans l’exemple suivant, l’AWS CLI recherche le fichier dans le répertoire de travail actuel.L’erreur d’essai indique que le fichier JSON ou YAML est correctement mis en forme et que les valeurs des paramètres sont valides. Si d'autres problèmes sont signalés dans la sortie, corrigez-les et répétez l'étape précédente jusqu'à ce que le message
Request would have succeededs'affiche. -
Vous pouvez maintenant définir le paramètre
DryRuncommefalsepour désactiver l'essai. -
Quand vous exécutez la commande,
run-instanceslance réellement une instance EC2 et affiche les détails générés par le lancement réussi. Le format de la sortie est contrôlé par le paramètre--output, séparément du format de votre modèle de paramètre d'entrée.
Combinaison de fichiers d’entrée et de paramètres de ligne de commande
Un fichier d’entrée peut être utilisé pour tous les paramètres ou peut être combiné avec les paramètres spécifiés dans l’AWS CLI. Vous pouvez utiliser cette fonctionnalité pour les paramètres que vous réutilisez fréquemment dans un fichier d’entrée, tout en conservant vos paramètres individuels dans la commande elle-même.
Les exemples aws ec2 run-instances suivants combinent l’utilisation d’un fichier d’entrée et de paramètres. Nous fournissons le type d’instance, le nom de la clé, le groupe de sécurité et l’identifiant Amazon Machine Image (AMI), et présumons la Région AWS par défaut. L’AMI ami-dfc39aef est une image Amazon Linux 64 bits hébergée dans la région us-west-2. Si vous utilisez une autre région, vous devez identifier le bon ID d'AMI à utiliser
L’exemple suivant utilise le fichier d’entrée en combinaison avec le paramètre --dry-run pour exécuter un essai de la commande afin de confirmer que vous disposez des autorisations requises et que vous avez renseigné le fichier avec des valeurs valides.
L’exemple suivant utilise ensuite le même fichier d’entrée, mais avec le paramètre --no-dry-run afin d’exécuter la commande dans son intégralité.
