Structure de commande dans l’AWS CLI

Cette rubrique explique comment la commande de l’AWS Command Line Interface (AWS CLI) est structurée et comment utiliser les commandes wait.

Structure de commande

L’AWS CLI utilise une structure en plusieurs parties sur la ligne de commande qui doit être spécifiée dans l’ordre suivant :

1. L’appel de base au programme aws.

2. La commande de niveau supérieur, qui correspond généralement à un service AWS pris en charge par l’AWS CLI.

3. La sous-commande qui spécifie l’opération à effectuer.

4. Les options d’AWS CLI générales ou les paramètres requis par l’opération. Vous pouvez les spécifier dans n’importe quel ordre tant qu’ils suivent les trois premières parties. Si un paramètre exclusif est spécifié plusieurs fois, seule la dernière valeur s’applique.

$ aws <command> <subcommand> [options and parameters]

Les paramètres peuvent prendre différents types de valeurs d’entrée, comme des chiffres, des chaînes, des listes, des mappages et des structures JSON. Ce qui est pris en charge dépend de la commande et de la sous-commande que vous spécifiez.

Exemples

Amazon S3

L’exemple suivant répertorie tous les compartiments Amazon S3.

$ aws s3 ls
2018-12-11 17:08:50 amzn-s3-demo-bucket1
2018-12-14 14:55:44 amzn-s3-demo-bucket2

Pour plus d’informations sur les commandes Amazon S3, consultez aws s3 dans la Référence des commandes de l’AWS CLI.

AWS CloudFormation

L’exemple de commande create-change-set suivant remplace le nom de la pile cloudformation par my-change-set.

$ aws cloudformation create-change-set --stack-name my-stack --change-set-name my-change-set

Pour plus d’informations sur les commandes AWS CloudFormation, consultez aws cloudformation dans la Référence des commandes de l’AWS CLI.

Commandes wait

Des commandes wait sont disponibles pour certains services AWS. Toute commande utilisant aws wait attend généralement qu’une commande soit terminée avant de passer à l’étape suivante. C’est particulièrement utile pour les commandes en plusieurs parties ou les scripts, car vous pouvez utiliser une commande wait pour empêcher de passer aux étapes suivantes en cas d’échec de la commande wait.

L’AWS CLI utilise une structure en plusieurs parties sur la ligne de commande pour la commande wait qui doit être spécifiée dans l’ordre suivant :

1. L’appel de base au programme aws.

2. La commande de niveau supérieur, qui correspond généralement à un service AWS pris en charge par l’AWS CLI.

3. La commande wait.

4. La sous-commande qui spécifie l’opération à effectuer.

5. Les options CLI générales ou les paramètres requis par l’opération. Vous pouvez les spécifier dans n’importe quel ordre tant qu’ils suivent les trois premières parties. Si un paramètre exclusif est spécifié plusieurs fois, seule la dernière valeur s’applique.

$ aws <command> wait <subcommand> [options and parameters]

Les paramètres peuvent prendre différents types de valeurs d’entrée, comme des chiffres, des chaînes, des listes, des mappages et des structures JSON. Ce qui est pris en charge dépend de la commande et de la sous-commande que vous spécifiez.

Note

Tous les services AWS ne prennent pas en charge les commandes wait. Consultez le guide de référence de l’AWS CLI version 2 pour voir si votre service prend en charge les commandes wait.

Exemples

AWS CloudFormation

Les exemples de commande wait change-set-create-complete suivants s’interrompent et reprennent uniquement après avoir confirmé que le jeu de modifications my-change-set défini dans la pile my-stack est prêt pour exécution.

$ aws cloudformation wait change-set-create-complete --stack-name my-stack --change-set-name my-change-set

Pour plus d’informations sur les commandes wait d’AWS CloudFormation, consultez wait dans la Référence des commandes de l’AWS CLI.

AWS CodeDeploy

Les exemples de commande wait deployment-successful suivants sont mis en pause jusqu’à ce que le déploiement d-A1B2C3111 soit terminé.

$ aws deploy wait deployment-successful --deployment-id d-A1B2C3111

Pour plus d’informations sur les commandes wait d’AWS CodeDeploy, consultez wait dans la Référence des commandes de l’AWS CLI.