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.
AWS CLI les squelettes et les fichiers d'entrée dans AWS CLI
La plupart des AWS CLI commandes acceptent toutes les entrées de paramètres d'un fichier. Ces modèles peuvent être générés à l'aide de l'generate-cli-skeletonoption.
Rubriques
À propos des AWS CLI squelettes et des fichiers d'entrée
La plupart des commandes AWS Command Line Interface (AWS CLI) permettent d'accepter toutes les entrées de paramètres d'un fichier à l'aide du --cli-input-yaml paramètre s --cli-input-json et.
Ces mêmes commandes fournissent le --generate-cli-skeleton paramètre permettant de générer un fichier dans l'un JSONou l'autre YAML format avec tous les paramètres que vous pouvez modifier et renseigner. Ensuite, vous pouvez exécuter la commande avec le paramètre --cli-input-json ou --cli-input-yaml et pointer vers le fichier rempli.
Important
Plusieurs AWS CLI commandes ne sont pas directement associées à AWS API des opérations individuelles, telles que commandes--generate-cli-skeleton ni --cli-input-json et --cli-input-yaml présentés dans cette rubrique. Si vous ne savez pas si une commande spécifique prend en charge ces paramètres, exécutez la commande suivante en remplaçant service and command des noms avec ceux qui vous intéressent.
$ aws service command helpLa sortie inclut une section Synopsis qui indique les paramètres pris en charge par la commande spécifiée.
$aws iam list-users help... SYNOPSIS list-users ... [--cli-input-json | --cli-input-yaml] ... [--generate-cli-skeleton <value>] ...
Le paramètre --generate-cli-skeleton entraîne la non-exécution de la commande, mais à la place génère et affiche un modèle de paramètre que vous pouvez personnaliser, puis utiliser comme entrée sur une commande ultérieure. 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 commeJSON. 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 commeYAML. -
output— Le modèle généré inclut tous les paramètres de sortie formatés commeJSON. Vous ne pouvez actuellement pas demander les paramètres de sortie en tant queYAML.
Comme il AWS CLI s'agit essentiellement d'une « enveloppe » qui entoure le serviceAPI, le fichier squelette attend de vous que vous référenciez tous les paramètres par leurs noms de API paramètres sous-jacents. Il est probablement différent du nom du AWS CLI paramètre. Par exemple, un AWS CLI paramètre nommé user-name peut être mappé au API paramètre nommé du AWS service UserName (notez la modification des majuscules et l'absence du tiret). 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 API référence du service pour connaître les noms de 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ètres pour la commande Amazon Elastic Compute Cloud (AmazonEC2)run-instances.
Génération d'un squelette de commande
Pour générer et utiliser un fichier de squelette de paramètre
-
Exécutez la commande avec le
--generate-cli-skeletonparamètre pour produire l'un JSONou l'autre YAML et dirigez 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 valide JSON ou YAML après avoir supprimé les éléments dont vous n'avez pas besoin.
Dans cet exemple, nous laissons le
DryRunparamètre défini surtruepour utiliser la fonctionnalité Amazon EC2 Dry Run. 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 indiquons le type d'instance, le nom de clé, le groupe de sécurité et l'identifiant de l'Amazon Machine Image (AMI) à utiliser. Cet exemple suppose la AWS région par défaut. AMI
ami-dfc39aefIl s'agit d'une image Amazon Linux 64 bits hébergée dans laus-west-2région. Si vous utilisez une autre région, vous devez trouver le bon AMI identifiant à utiliser. -
Exécutez la commande avec les paramètres complétés en transmettant le fichier modèle terminé au
cli-input-yamlparamètre--cli-input-jsonor -- en utilisant lefile://préfixe. Le chemin AWS CLI est interprété comme étant relatif à votre répertoire de travail actuel. Ainsi, dans l'exemple suivant, qui affiche uniquement le nom du fichier sans chemin, il recherche le fichier directement dans le répertoire de travail actuel.L'erreur de fonctionnement à sec indique que le JSON ou YAML est correctement formé 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. -
Exécutez la commande, lancez
run-instancesréellement une EC2 instance Amazon et affichez 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.
