Options de ligne de commande

Dans leAWS 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
example-bucket-1
example-bucket-2
...

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écifiez les valeurs des paramètres pour AWS CLI.

AWS CLIoptions 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-auto-prompt

Active le mode d'invite automatique pour une seule commande. Comme le montrent les exemples suivants, vous pouvez le spécifier à tout moment.

$ aws --cli-auto-prompt
$ aws dynamodb --cli-auto-prompt
$ aws dynamodb describe-table --cli-auto-prompt

Cette option remplace la variable d'aws_cli_auto_promptenvironnement et le paramètre de cli_auto_prompt profil.

Pour plus d'informations sur la fonctionnalité d'invite automatique de la AWS CLI version 2, consultezVous êtes AWS CLI invité à saisir des commandes.

--cli-binary-format

Spécifie la manière dont la AWS CLI version 2 interprète les paramètres d'entrée binaires. Il peut avoir l'une des valeurs suivantes :

• base64 — Il s'agit de la valeur par défaut. Un paramètre d'entrée qui est saisi comme un objet BLOB accepte une chaîne codée en base64. Pour transmettre le contenu binaire réel, placez le contenu dans un fichier et indiquez le chemin d'accès et le nom du fichier avec le préfixe fileb:// comme valeur du paramètre. Pour transmettre du texte codé en base64 contenu dans un fichier, indiquez le chemin d'accès et le nom du fichier avec le préfixe file:// comme valeur du paramètre.

• raw-in-base64-out — Valeur par défaut pour la AWS CLI version 1. Si la valeur du paramètre estraw-in-base64-out, les fichiers référencés à l'aide du file:// préfixe sont lus sous forme de texte, puis les AWS CLI tentatives de codage en binaire sont tentées.

Cela remplace le paramètre de configuration cli_binary_format du fichier.

$ aws lambda invoke \
    --cli-binary-format raw-in-base64-out \
    --function-name my-function \
    --invocation-type Event \
    --payload '{ "name": "Bob" }' \
    response.json

Si vous référencez une valeur binaire dans un fichier en utilisant la notation de préfixe fileb://, l'AWS CLI s'attend toujours à ce que le fichier contienne du contenu binaire brut et ne tente pas de convertir la valeur.

Si vous référencez une valeur binaire dans un fichier à l'aide de la notation de préfixe file://, l'AWS CLI gère le fichier en fonction du paramètre cli_binary_format actuel. Si la valeur de ce paramètre est base64 (la valeur par défaut lorsqu'elle n'est pas définie explicitement), le fichier AWS CLI s'attend à ce que le fichier contienne du texte codé en base64. Si la valeur de ce paramètre estraw-in-base64-out, le fichier AWS CLI s'attend à ce que le fichier contienne du contenu binaire brut.

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

--color <chaîne>

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 CLIPar 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'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-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-cli-auto-prompt

Désactive le mode d'invite automatique pour une seule commande.

$ aws dynamodb describe-table --table-name Table1 --no-cli-auto-prompt

Cette option remplace la variable d'aws_cli_auto_promptenvironnement et le paramètre de cli_auto_prompt profil.

Pour plus d'informations sur la fonctionnalité d'invite automatique de la AWS CLI version 2, consultezVous êtes AWS CLI invité à saisir des commandes.

--no-cli-pager

Commutateur booléen qui désactive l'utilisation d'un pager pour la sortie de la commande.

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

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

--output <chaîne>

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.

• yaml— La sortie est formatée sous forme de chaîne YAML.

• yaml-stream— La sortie est diffusée et formatée sous forme de chaîne YAML. Le streaming permet de traiter plus rapidement de gros types de données.

• 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 à l'aide des 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.

--profile <chaîne>

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>

--query <chaîne>

Spécifie une requête JMESPath à utiliser dans le filtrage des données de réponse. Pour plus d'informations, consultez AWS CLI Sortie du filtre.

--region <chaîne>

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