Cette documentation concerne uniquement la version 1 de l’AWS CLI. Pour la documentation relative à la version 2 de l’AWS CLI, consultez le Guide de l’utilisateur de la version 2.
Option de ligne de commande dans l’AWS CLI
Dans l’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 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.
Rubriques
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 --profileprofile1amzn-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.
Options de ligne de commande globales prises en charge par l’AWS CLI
Dans l’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 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_bundleet la variable d’environnementAWS_CA_BUNDLE. - --cli-connect-timeout
<entier> -
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
<entier> -
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.
- --color
<string> -
Spécifie la prise en charge de la sortie couleur. Les valeurs valides sont
on,offetauto. La valeur par défaut estauto. - --debug
-
Commutateur booléen qui active la journalisation du débogage. L’AWS CLI fournit par défaut des informations nettoyées sur les succès ou les échecs concernant les résultats des commandes dans la sortie de commande. L’option
--debugfournit les journaux Python complets. Cela englobe des informations de diagnosticstderrsupplé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, ajoutez2> debug.txtoùdebug.txtest le nom que vous voulez utiliser pour votre fichier de débogage :$aws2>servicenamecommandnameoptions--debugdebug.txtPour envoyer à la fois la sortie et les informations de diagnostic
stderr, ajoutez&> debug.txtoùdebug.txtest le nom que vous voulez utiliser pour votre fichier de débogage :$aws&>servicenamecommandnameoptions--debugdebug.txt - --endpoint-url
<string> -
Spécifie l’URL à laquelle envoyer la requête. Pour la plupart des commandes, l’AWS CLI détermine automatiquement l’URL en fonction du service sélectionné et de la région AWS spécifiée. Toutefois, certaines commandes nécessitent que vous spécifiez une URL propre au compte. Vous pouvez également configurer certains services AWS pour héberger un point de terminaison directement au sein de votre VPC privé, qui doit parfois être spécifié par la suite.
L’exemple de commande suivant utilise une URL de point de terminaison Amazon S3 personnalisée.
$aws s3 ls --endpoint-urlhttp://localhost:4567Priorité des points de terminaison
Les paramètres de configuration du point de terminaison se trouvent à différents endroits, tels que les variables d’environnement du système ou de l’utilisateur, les fichiers de configuration AWS locaux, ou sont explicitement déclarés sur la ligne de commande en tant que paramètre. L’AWS CLI vérifie ces paramètres de point de terminaison dans un ordre particulier, et elle 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 par l’AWS CLI pour recevoir tous les résultats de commande, 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
-
Un commutateur booléen qui désactive la signature des requêtes HTTP au point de terminaison des services AWS. Cela empêche le chargement d’informations d’identification.
- --no-verify-ssl
-
Par défaut, l’AWS CLI utilise le protocole SSL pour communiquer avec les services AWS. Pour chaque connexion et appel SSL, l’AWS CLI vérifie les certificats SSL. 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 utilisez
--no-verify-ssl, le trafic entre votre client et les services AWS n’est plus sécurisé. Cela signifie que votre trafic représente un risque de sécurité et est vulnérable aux exploits de type « man-in-the-middle ». 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. - --output
<string> -
Spécifie le format de sortie à utiliser pour cette commande. Vous pouvez spécifier les valeurs suivantes :
-
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,sedouawk. -
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.
- --profile
<string> -
Spécifie le profil nommé à utiliser pour cette commande. Pour configurer des profils nommés supplémentaires, vous pouvez utiliser la commande
aws configureavec l’option--profile.$aws configure --profile<profilename> - --query
<string> -
Spécifie une requête JMESPath
à utiliser dans le filtrage des données de réponse. Pour plus d’informations, consultez Filtrage de la sortie dans l’AWS CLI. - --region
<string> -
Spécifie la région AWS à laquelle envoyer la requête AWS 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 document Référence générale d'Amazon Web Services.
- --version
-
Commutateur booléen qui affiche la version actuelle du programme de l’AWS CLI 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 --regionus-west-1------------------- |DescribeInstances| +-----------------+$aws ec2 describe-instances --output table --regionus-west-2------------------------------------------------------------------------------ | DescribeInstances | +----------------------------------------------------------------------------+ || Reservations || |+-------------------------------------+------------------------------------+| || OwnerId | 012345678901 || || ReservationId | r-abcdefgh || |+-------------------------------------+------------------------------------+| ||| Instances ||| ||+------------------------+-----------------------------------------------+|| ||| AmiLaunchIndex | 0 ||| ||| Architecture | x86_64 ||| ...
