Options de ligne de commande dans le AWS CLI - AWS Command Line Interface

Cette documentation concerne AWS CLI uniquement la version 1 du.

Nous avons annoncé la sortie end-of-support de la AWS CLI version 1. Nous vous recommandons de migrer vers la AWS CLI version 2. Pour les dates, les détails supplémentaires et les informations sur la façon de migrer, consultez l'annonce. Pour la documentation relative à la version 2 du AWS CLI, consultez le guide de l'utilisateur de la version 2.

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.

Options de ligne de commande dans le AWS CLI

Dans le AWS CLI, les options de ligne de commande sont des paramètres globaux que vous pouvez utiliser pour remplacer les paramètres de configuration par défaut, tout paramètre de profil correspondant ou le paramètre de variable d'environnement pour cette commande unique. Vous ne pouvez pas utiliser les options de ligne de commande pour spécifier directement des informations d’identification, bien que vous puissiez spécifier le profil à utiliser.

Utilisation des options de ligne de commande

La plupart des options de ligne de commande sont de simples chaînes, comme le nom du profil profile1 dans l’exemple suivant :

$ aws s3 ls --profile profile1 amzn-s3-demo-bucket1 amzn-s3-demo-bucket2 ...

Chaque option qui prend un argument nécessite un espace ou un signe égal (=) qui sépare l’argument du nom de l’option. Si la valeur d’argument est une chaîne qui contient un espace, vous devez placer l’argument entre guillemets. Pour plus de détails sur les types d’arguments et le formatage des paramètres, consultez Spécification des valeurs des paramètres dans l’AWS CLI.

AWS CLI options de ligne de commande globales prises en charge

Dans le, AWS CLI vous pouvez utiliser les options de ligne de commande suivantes pour remplacer les paramètres de configuration par défaut, tout paramètre de profil correspondant ou le paramètre de variable d'environnement pour cette commande unique.

--ca-bundle <string>

Spécifie l’ensemble de certificats d’autorité de certification (CA) à utiliser lors de la vérification des certificats SSL.

Si elle est définie, cette option remplace la valeur du paramètre de profil ca_bundle et la variable d’environnement AWS_CA_BUNDLE.

--cli-connect-timeout <integer>

Spécifie le temps de connexion maximal du socket en secondes. Si la valeur est définie sur zéro (0), la connexion du socket attend indéfiniment (est bloquante) sans délai d’expiration. La valeur par défaut est de 60 secondes.

--cli-read-timeout <integer>

Spécifie le temps de lecture maximal du socket en secondes. Si la valeur est définie sur zéro (0), la lecture du socket attend indéfiniment (est bloquante) sans délai d’expiration. La valeur par défaut est de 60 secondes.

--couleur <string>

Spécifie la prise en charge de la sortie couleur. Les valeurs valides sont on, off et auto. La valeur par défaut est auto.

--debug

Commutateur booléen qui active la journalisation du débogage. AWS CLI Par défaut, fournit des informations nettoyées concernant les succès ou les échecs concernant les résultats des commandes dans la sortie de commande. L’option --debug fournit les journaux Python complets. Cela englobe des informations de diagnostic stderr supplémentaires sur l’opération de la commande qui peuvent être utiles pour déterminer pourquoi une commande fournit des résultats inattendus. Pour consulter facilement les journaux de débogage, nous vous suggérons de les envoyer dans un fichier afin de rechercher plus facilement les informations. Pour ce faire, utilisez l’une des méthodes suivantes.

Pour envoyer uniquement les informations de diagnostic stderr, ajoutez 2> debug.txtdebug.txt est le nom que vous voulez utiliser pour votre fichier de débogage :

$ aws servicename commandname options --debug 2> debug.txt

Pour envoyer à la fois la sortie et les informations de diagnostic stderr, ajoutez &> debug.txtdebug.txt est le nom que vous voulez utiliser pour votre fichier de débogage :

$ aws servicename commandname options --debug &> debug.txt
--endpoint-url <string>

Spécifie l’URL à laquelle envoyer la requête. Pour la plupart des commandes, l'URL est AWS CLI automatiquement déterminée en fonction du service sélectionné et de la AWS région spécifiée. Toutefois, certaines commandes nécessitent que vous spécifiez une URL propre au compte. Vous pouvez également configurer certains AWS services pour héberger un point de terminaison directement dans votre VPC privé, qui devra peut-être ensuite être spécifié.

L’exemple de commande suivant utilise une URL de point de terminaison Amazon S3 personnalisée.

$ aws s3 ls --endpoint-url http://localhost:4567
Priorité des points de terminaison

Les paramètres de configuration du point de terminaison se trouvent à plusieurs endroits, tels que les variables d'environnement système ou utilisateur, les fichiers de AWS configuration locaux, ou sont explicitement déclarés sur la ligne de commande en tant que paramètre. AWS CLI vérifie ces paramètres de point de terminaison dans un ordre particulier et utilise le paramètre de point de terminaison ayant la priorité la plus élevée. Pour la liste des priorités des points de terminaison, consultez Configuration du point de terminaison et priorité des paramètres.

--no-paginate

Commutateur booléen qui désactive les multiples appels effectués automatiquement pour recevoir tous les résultats de commande, AWS CLI ce qui crée une pagination de la sortie. Cela signifie que seule la première page de votre sortie est affichée.

--no-sign-request

Commutateur booléen qui désactive la signature des requêtes HTTP vers le point de terminaison du AWS service. Cela empêche le chargement d’informations d’identification.

--no-verify-ssl

Par défaut, le protocole SSL est AWS CLI utilisé pour communiquer avec AWS les services. Pour chaque connexion et appel SSL, les certificats SSL sont AWS CLI vérifiés. L’utilisation de cette option remplace le comportement par défaut de vérification des certificats SSL.

Avertissement

Cette option n’est pas la bonne pratique recommandée. Si vous l'utilisez--no-verify-ssl, votre trafic entre votre client et les AWS services n'est plus sécurisé. Cela signifie que votre trafic représente un risque de sécurité et est vulnérable aux man-in-the-middle exploits. Si vous rencontrez des problèmes avec les certificats, il est préférable de les résoudre. Pour les étapes de résolution des problèmes liés aux certificats, consultez Erreurs liées à un certificat SSL.

--sortie <string>

Spécifie le format de sortie à utiliser pour cette commande. Vous pouvez spécifier les valeurs suivantes :

  • json : la sortie est au format d’une chaîne JSON.

  • text : la sortie a le format de plusieurs lignes de valeurs de chaîne séparées par des tabulations. Cela peut être utile pour transmettre la sortie à un processeur de texte, comme grep, sed ou awk.

  • table : la sortie est au format d’un tableau utilisant les caractères +|- pour délimiter les bordures des cellules. La présentation des informations est dans un format beaucoup plus lisible par l’utilisateur que les autres, mais peu pratique du point de vue programmation.

--profil <string>

Spécifie le profil nommé à utiliser pour cette commande. Pour configurer des profils nommés supplémentaires, vous pouvez utiliser la commande aws configure avec l’option --profile.

$ aws configure --profile <profilename>
--requête <string>

Spécifie une JMESPath requête à utiliser pour filtrer les données de réponse. Pour de plus amples informations, veuillez consulter Filtrage de la sortie dans l’AWS CLI.

--région <string>

Spécifie AWS la région à laquelle envoyer la AWS demande de cette commande. Pour obtenir la liste de toutes les régions que vous pouvez spécifier, consultez Régions et points de terminaison AWS dans le Référence générale d'Amazon Web Services.

--v2-debug

Active le mode de débogage de mise à niveau v1-v2. Dans ce mode, il AWS CLI détectera l'utilisation des fonctionnalités mises à jour avec des modifications importantes dans AWS CLI la version 2 et affichera des avertissements pour chaque utilisation détectée potentiellement affectée. Vous pouvez utiliser ce mode pour préparer votre environnement et votre AWS CLI utilisation en vue de la mise à niveau vers la version v2.

Cette option remplace la variable d'AWS_CLI_UPGRADE_DEBUG_MODEenvironnement.

Pour plus d'informations sur le mode de débogage de mise AWS CLI à niveau v1-v2, voir Utilisation du mode de débogage de mise à niveau pour mettre à niveau la AWS version 1 de la CLI vers la version 2 de la CLI. AWS

--version

Commutateur booléen qui affiche la version actuelle du AWS CLI programme en cours d'exécution.

Utilisations courantes des options de ligne de commande

Ces options de ligne de commande sont couramment utilisées pour vérifier vos ressources dans plusieurs régions AWS et modifier le format de sortie pour l’éligibilité ou la facilité d’utilisation lors de l’utilisation de scripts. Dans les exemples suivants, nous exécutons la commande describe-instances sur chaque région jusqu’à ce que nous trouvions la région dans laquelle se trouve notre instance.

$ aws ec2 describe-instances --output table --region us-west-1 ------------------- |DescribeInstances| +-----------------+ $ aws ec2 describe-instances --output table --region us-west-2 ------------------------------------------------------------------------------ | DescribeInstances | +----------------------------------------------------------------------------+ || Reservations || |+-------------------------------------+------------------------------------+| || OwnerId | 012345678901 || || ReservationId | r-abcdefgh || |+-------------------------------------+------------------------------------+| ||| Instances ||| ||+------------------------+-----------------------------------------------+|| ||| AmiLaunchIndex | 0 ||| ||| Architecture | x86_64 ||| ...