Activation et utilisation des invites de commande dans l’AWS CLI - AWS Command Line Interface
FonctionnementFonctionnalités d’invite automatiqueModes d’invite automatiqueConfiguration de l’invite automatique

Activation et utilisation des invites de commande dans l’AWS CLI

Vous pouvez faire en sorte que la version 2 de l’AWS CLI vous invite à fournir des commandes, des paramètres et des ressources lorsque vous exécutez une commande aws.

Fonctionnement

Si cette option est activée, l’invite automatique vous permet d’utiliser la touche ENTRÉE pour terminer une commande partiellement saisie. Une fois que vous avez appuyé sur la touche ENTRÉE, des commandes, des paramètres et des ressources sont suggérés en fonction de ce que vous continuez à saisir. Les suggestions indiquent le nom de la commande, du paramètre ou de la ressource sur la gauche et leur description sur la droite. Pour sélectionner et utiliser une suggestion, utilisez les flèches pour mettre en évidence une ligne, puis appuyez sur la touche ESPACE. Lorsque vous avez fini de saisir votre commande, appuyez sur ENTRÉE pour l’utiliser. L’exemple suivant montre à quoi ressemble une liste suggérée à partir d’une invite automatique.

$ aws
> aws a
       accessanalyzer                Access Analyzer
       acm                           AWS Certificate Manager
       acm-pca                       AWS Certificate Manager Private Certificate Authority
       alexaforbusiness              Alexa For Business
       amplify                       AWS Amplify

Fonctionnalités d’invite automatique

L’invite automatique contient les fonctionnalités utiles suivantes :

Panneau de documentation

Fournit la documentation d’aide pour la commande en cours. Pour ouvrir la documentation, appuyez sur la touche F3.

Saisie automatique des commandes

Suggère des commandes aws à utiliser. Pour voir une liste, entrez partiellement la commande. L’exemple suivant recherche un service commençant par la lettre a.

$ aws
> aws a
       accessanalyzer                Access Analyzer
       acm                           AWS Certificate Manager
       acm-pca                       AWS Certificate Manager Private Certificate Authority
       alexaforbusiness              Alexa For Business
       amplify                       AWS Amplify
Saisie automatique d’un paramètre

Une fois qu’une commande est saisie, l’invite automatique commence à suggérer des paramètres. Les descriptions des paramètres incluent le type de valeur et une description de ce qu’est le paramètre. Les paramètres obligatoires sont répertoriés en premier et sont étiquetés comme obligatoires. L’exemple suivant montre la liste de paramètres générée par l’invite automatique pour aws dynamodb describe-table.

$ aws dynamodb describe-table
> aws dynamodb describe-table 
                              --table-name (required)  [string] The name of the table to describe.
                               --cli-input-json         [string] Reads arguments from the JSON string provided. The JSON string follows the format provide...
                               --cli-input-yaml         [string] Reads arguments from the YAML string provided. The YAML string follows the format provide...
                               --generate-cli-skeleton  [string] Prints a JSON skeleton to standard output without sending an API request. If provided wit...
Saisie automatique des ressources

L’invite automatique effectue des appels d’API AWS en utilisant les propriétés des ressources AWS disponibles pour suggérer des valeurs de ressources. Cela permet à l’invite automatique de suggérer d’éventuelles ressources que vous possédez lors de la saisie des paramètres. Dans l’exemple suivant, l’invite automatique affiche la liste des noms de tables lorsque vous saisissez le paramètre --table-name de la commande aws dynamodb describe-table.

$ aws dynamodb describe-table
> aws dynamodb describe-table --table-name 
                                            Table1
                                            Table2
                                            Table3
Saisie automatique d’une syntaxe raccourcie

Pour les paramètres utilisant une syntaxe raccourcie, l’invite automatique suggère les valeurs à utiliser. Dans l’exemple suivant, l’invite automatique affiche la liste de valeurs de syntaxe raccourcie pour le paramètre --placement de la commande aws ec2 run-instances.

$ aws ec2 run-instances
> aws ec2 run-instances --placement 
 AvailabilityZone=      [string] The Availability Zone of the instance. If not specified, an Availability Zone wil...
 Affinity=              [string] The affinity setting for the instance on the Dedicated Host. This parameter is no...
 GroupName=             [string] The name of the placement group the instance is in.
 PartitionNumber=       [integer] The number of the partition the instance is in. Valid only if the placement grou...
Saisie automatique du fichier

Lorsque vous remplissez des paramètres dans des commandes aws, la saisie automatique suggère des noms de fichiers locaux après utilisation du préfixe file:// ou fileb://. Dans l’exemple suivant, l’invite automatique suggère des fichiers locaux après la saisie de --item file:// pour la commande aws ec2 run-instances.

$ aws ec2 run-instances
> aws ec2 run-instances --item file:// 
                         item1.txt
                         file1.json
                         file2.json
Saisie automatique de région

Lorsque vous utilisez le paramètre global --region, l’invite automatique affiche la liste des régions qu’il est possible de sélectionner. Dans l’exemple suivant, l’invite automatique suggère des régions dans l’ordre alphabétique après la saisie de --region pour la commande aws dynamodb list-tables.

$ aws dynamodb list-tables
> aws dynamodb list-tables --region 
                                     af-south-1
                                     ap-east-1
                                     ap-northeast-1
                                     ap-northeast-2
Saisie automatique de profil

Lors de l’utilisation du paramètre global --profile, l’invite automatique affiche la liste de vos profils. Dans l’exemple suivant, l’invite automatique suggère vos profils après la saisie de --profile pour la commande aws dynamodb list-tables.

$ aws dynamodb list-tables
> aws dynamodb list-tables --profile 
                                     profile1
                                     profile2
                                     profile3
Recherches approximatives

Commandes et valeurs complètes contenant un jeu de caractères spécifique. Dans l’exemple suivant, l’invite automatique suggère des régions qui contiennent eu après la saisie de --region eu pour la commande aws dynamodb list-tables.

$ aws dynamodb list-tables
> aws dynamodb list-tables --region west
                                         eu-west-1
                                         eu-west-2
                                         eu-west-3
                                         us-west-1
Historique

Pour afficher et exécuter les commandes précédemment utilisées en mode invite automatique, appuyez sur CTRL + R. L’historique répertorie les commandes précédentes que vous pouvez sélectionner à l’aide des touches fléchées. Dans l’exemple suivant, l’historique du mode d’invite automatique est affiché.

$ aws
> aws 
        dynamodb list-tables
        s3 ls

Modes d’invite automatique

L’invite automatique pour la version 2 de l’AWS CLI dispose de 2 modes qui peuvent être configurés :

  • Mode complet : utilise l’invite automatique chaque fois que vous essayez d’exécuter une commande aws, que vous l’appeliez manuellement à l’aide du paramètre --cli-auto-prompt ou que vous l’activiez définitivement. Cela inclut le fait d’appuyer sur ENTRÉE après la saisie d’une commande complète ou incomplète.

  • Mode partiel : utilise l’invite automatique si une commande est incomplète ou ne peut pas être exécutée en raison d’erreurs de validation côté client. Ce mode est particulièrement utile si vous avez des scripts ou des dossiers d’exploitation préexistants, ou si vous souhaitez uniquement être automatiquement invité à entrer des commandes que vous ne connaissez pas au lieu d’être invité à chaque commande.

Configuration de l’invite automatique

Pour configurer l’invite automatique, vous pouvez utiliser les méthodes suivantes par ordre de priorité :

  • Les options de ligne de commande activent ou désactivent l’invite automatique d’une commande unique. Utilisez --cli-auto-prompt pour appeler l’invite automatique et --no-cli-auto-prompt pour désactiver l’invite automatique.

  • Les variables d’environnement utilisent la variable aws_cli_auto_prompt.

  • Les fichiers de configuration partagés utilisent le paramètre cli_auto_prompt.