Options de ligne de commande dans AWS CLI - AWS Command Line Interface
Comment utiliser les options de ligne de commandeAWS CLI options de ligne de commande globales prises en chargeUtilisations courantes des options de ligne de commande

Cette documentation concerne AWS CLI uniquement la version 1 du. 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 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.

Comment utiliser les 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, consultezSpécifier les valeurs des paramètres dans le 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 de la variable d'AWS_CA_BUNDLEenvironnement.

--cli-connect-timeout <integer>

Spécifie temps de connexion maximal du socket en secondes. Si la valeur est définie sur 0, la connexion du socket attend indéfiniment (est bloquante) sans délai d'expiration.

--cli-read-timeout <integer>

Spécifie temps de lecture maximal du socket en secondes. Si la valeur est définie sur 0, la lecture du socket attend indéfiniment sans délai d'expiration.

--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'--debugoption fournit les journaux Python complets. Cela inclut des informations stderr de diagnostic supplémentaires sur le fonctionnement de la commande qui peuvent être utiles pour résoudre les problèmes liés aux résultats inattendus d'une commande. 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. Vous pouvez le faire en utilisant l'une des méthodes suivantes.

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

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

Pour envoyer à la fois les informations stderr de sortie et de diagnostic, &> debug.txt ajoutez debug.txt le nom que vous souhaitez 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

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. Les paramètres de configuration du point de AWS CLI terminaison sont prioritaires dans l'ordre suivant :

  1. L'option --endpoint-url de ligne de commande.

  2. Si cette option est activée, la variable d'environnement AWS_IGNORE_CONFIGURED_ENDPOINT_URLS global du point de terminaison ou le paramètre ignore_configure_endpoint_urls de profil ignore les points de terminaison personnalisés.

  3. La valeur fournie par une variable d'environnement spécifique au serviceAWS_ENDPOINT_URL_<SERVICE>, telle que. AWS_ENDPOINT_URL_DYNAMODB

  4. Les valeurs fournies par les variables d'AWS_ENDPOINT_URLenvironnement AWS_USE_DUALSTACK_ENDPOINTAWS_USE_FIPS_ENDPOINT, et.

  5. La valeur du point de terminaison spécifique au service fournie par le endpoint_url paramètre dans une services section du fichier partagéconfig.

  6. La valeur fournie par le endpoint_url paramètre dans un profile config fichier partagé.

  7. use_dualstack_endpointuse_fips_endpoint, et endpoint_url paramètres.

  8. Toute URL de point de terminaison par défaut pour le point de terminaison correspondant Service AWS est utilisée en dernier. Pour afficher la liste des points de terminaison de service disponibles dans chaque région, consultez Régions et points de terminaison AWS dans le document Référence générale d'Amazon Web Services.

--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 une bonne pratique. 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, consultezErreurs de 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 formatée sous forme de chaîne JSON.

  • text— La sortie est formatée sous la forme de plusieurs lignes de valeurs de chaîne séparées par des tabulations. Cela peut être utile pour transmettre le résultat à un processeur de texte, comme grepsed, ouawk.

  • table— La sortie est formatée sous forme de tableau en utilisant les caractères +|- pour former 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 le 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 document Référence générale d'Amazon Web Services.

--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                                       |||
...