Obtenez de l'aide concernant le AWS CLI

Cette rubrique décrit comment accéder au contenu d'aide pour le AWS Command Line Interface (AWS CLI).

La commande d'AWS CLIaide intégrée

Vous pouvez obtenir de l'aide avec n'importe quelle commande en utilisant l'AWS Command Line Interface (AWS CLI). Pour cela, il vous suffit de saisir help à la fin d'un nom de commande.

Par exemple, la commande suivante affiche l'aide pour les options générales de l'AWS CLI et les commandes de niveau supérieur disponibles.

$ aws help

La commande suivante affiche les commandes spécifiques à Amazon Elastic Compute Cloud (Amazon EC2) disponibles.

$ aws ec2 help

L'exemple suivant affiche une aide détaillée pour le fonctionnement d'Amazon EC2. DescribeInstances L'aide inclut des descriptions de ses paramètres d'entrée, les filtres disponibles, et ce qui est inclus dans la sortie. Il inclut également des exemples illustrant la façon de saisir des variations courantes de la commande.

$ aws ec2 describe-instances help

L'aide de chaque commande est divisée en six sections :

Nom

Le nom de la commande.

NAME
       describe-instances -

Description

Une description de l'opération d'API que la commande appelle.

DESCRIPTION
       Describes one or more of your instances.

       If you specify one or more instance IDs, Amazon EC2 returns information
       for those instances. If you do not specify  instance  IDs,  Amazon  EC2
       returns  information  for  all  relevant  instances.  If you specify an
       instance ID that is not valid, an error is returned. If you specify  an
       instance  that  you  do  not  own,  it  is not included in the returned
       results.
...

Résumé

La syntaxe de base pour utiliser la commande et ses options. Si une option est affichée entre crochets, elle est facultative ou elle a une valeur par défaut, ou bien une autre option peut être utilisée à la place.

SYNOPSIS
            describe-instances
          [--dry-run | --no-dry-run]
          [--instance-ids <value>]
          [--filters <value>]
          [--cli-input-json <value>]
          [--starting-token <value>]
          [--page-size <value>]
          [--max-items <value>]
          [--generate-cli-skeleton]

Par exemple, describe-instances a un comportement par défaut qui décrit toutes les instances du compte et de la région AWS actuels. Si vous le souhaitez, vous pouvez spécifier une liste d'instance-ids pour décrire une ou plusieurs instances. dry-run est un indicateur booléen facultatif qui ne prend aucune valeur. Pour utiliser un indicateur booléen, indiquez la valeur affichée, dans le cas présent --dry-run ou --no-dry-run. De même, --generate-cli-skeleton ne prend pas de valeur. S'il existe des conditions sur l'utilisation d'une option, elles sont décrites dans la section OPTIONS, ou mentionnées dans les exemples.

Options

Une description de chacune des options affichées dans le résumé.

OPTIONS
       --dry-run | --no-dry-run (boolean)
          Checks whether you have the required  permissions  for  the  action,
          without actually making the request, and provides an error response.
          If you have the required permissions, the error response is  DryRun-
          Operation . Otherwise, it is UnauthorizedOperation .

       --instance-ids (list)
          One or more instance IDs.

          Default: Describes all your instances.
...

Exemples

Des exemples illustrant l'utilisation de la commande et de ses options. Si aucun exemple n'est disponible pour une commande ou un cas d'utilisation dont vous avez besoin, demandez-en un à l'aide du lien d'envoi de commentaires sur cette page, ou dans la référence des commandes de l'AWS CLI sur la page d'aide de la commande.

    EXAMPLES
    To describe an Amazon EC2 instance

    Command:
    
    aws ec2 describe-instances --instance-ids i-5203422c
    
    To describe all instances with the instance type m1.small
    
    Command:
    
    aws ec2 describe-instances --filters "Name=instance-type,Values=m1.small"
    
    To describe all instances with an Owner tag
    
    Command:
    
    aws ec2 describe-instances --filters "Name=tag-key,Values=Owner"
...

Sortie

Des descriptions de chaque champ et type de données inclus dans la réponse d'AWS.

Pour describe-instances, la sortie est une liste d'objets de réservation, chacun comportant plusieurs champs et des objets contenant des informations sur les instances qui lui sont associées. Ces informations proviennent de la documentation de l'API pour le type de données de réservation utilisé par Amazon EC2.

OUTPUT
       Reservations -> (list)
          One or more reservations.

          (structure)
              Describes a reservation.

              ReservationId -> (string)
                 The ID of the reservation.

              OwnerId -> (string)
                 The ID of the AWS account that owns the reservation.

              RequesterId -> (string)
                 The ID of the requester that launched the instances  on  your
                 behalf (for example, AWS Management Console or Auto Scaling).

              Groups -> (list)
                 One or more security groups.

                 (structure)
                     Describes a security group.

                     GroupName -> (string)
                        The name of the security group.

                     GroupId -> (string)
                        The ID of the security group.

              Instances -> (list)
                 One or more instances.

                 (structure)
                     Describes an instance.

                     InstanceId -> (string)
                        The ID of the instance.

                     ImageId -> (string)
                        The ID of the AMI used to launch the instance.

                     State -> (structure)
                        The current state of the instance.

                        Code -> (integer)
                            The  low  byte represents the state. The high byte
                            is an opaque internal value and should be ignored.
...

Lorsque la sortie est rendue au format JSON par l'AWS CLI, elle devient un tableau d'objets de réservation, similaire à l'exemple suivant.

{
    "Reservations": [
        {
            "OwnerId": "012345678901",
            "ReservationId": "r-4c58f8a0",
            "Groups": [],
            "RequesterId": "012345678901",
            "Instances": [
                {
                    "Monitoring": {
                        "State": "disabled"
                    },
                    "PublicDnsName": "ec2-52-74-16-12.us-west-2.compute.amazonaws.com",
                    "State": {
                        "Code": 16,
                        "Name": "running"
                    },
...

Chaque objet de réservation contient les champs décrivant la réservation et un tableau des objets de l'instance, chacun avec ses propres champs (PublicDnsName, par exemple) et des objets (State, par exemple) qui le décrivent.

Utilisateurs Windows:

Vous pouvez acheminer (|) la sortie de la commande d'aide vers la commande more pour afficher le fichier d'aide une page à la fois. Appuyez sur la barre d'espace ou PgDnpour afficher une plus grande partie du document, puis q pour quitter.

C:\> aws ec2 describe-instances help | more

AWS CLIguide de référence

Les fichiers d'aide contiennent des liens qui ne peuvent pas être affichés ou accédés depuis la ligne de commande. Vous pouvez consulter ces liens et interagir avec eux en utilisant le , version 2. La référence contient également le contenu d'aide pour toutes les AWS CLI commandes. Les descriptions sont présentées pour faciliter la navigation et l'affichage sur les téléphones portables, les tablettes ou les écrans de bureau.

Documentation sur les API

Toutes les commandes dans l'AWS CLI correspondent aux demandes effectuées vers une API publique d'un service AWS. Chaque service doté d'une API publique possède une référence d'API qui se trouve sur la page d'accueil du service sur le site Web de AWS documentation. Le contenu d'une référence d'API varie en fonction de la manière dont l'API est construite et du protocole qui est utilisé. En général, une référence d'API contient des informations détaillées sur les actions prises en charge par l'API, les données envoyées vers et depuis le service et les conditions d'erreur que le service peut signaler.

Sections de la documentation d'API

• Actions : informations détaillées sur chaque opération et ses paramètres (y compris les contraintes de longueur ou de contenu et les valeurs par défaut). Elle répertorie les erreurs qui peuvent se produire pour cette action. Chaque opération correspond à une sous-commande dans l'AWS CLI.

• Types de données : informations détaillées sur les structures qu'une commande peut nécessiter en tant que paramètre ou renvoyées en réponse à une demande.

• Paramètres communs : informations détaillées sur les paramètres communs à toutes les actions du service.

• Erreurs courantes : informations détaillées sur les erreurs pouvant être renvoyées par n'importe quelle opération du service.

Le nom et la disponibilité de chaque section peuvent varier en fonction du service.

Interfaces de ligne de commande spécifiques à un service

Certains services disposent d'une CLI distincte datant d'avant la création d'une AWS CLI unique qui fonctionne avec tous les services. Ces interfaces de ligne de commande spécifiques à un service possèdent une documentation distincte qui est liée à la page de documentation du service. La documentation relative aux CLI spécifiques à un service ne s'applique pas au. AWS CLI

Résolution des erreurs

Pour obtenir de l'aide sur le diagnostic et la correction des AWS CLI erreurs, consultezRésoudre les erreurs AWS CLI.

Aide supplémentaire

Pour obtenir de l'aide supplémentaire AWS CLI concernant vos problèmes, consultez la AWS CLIcommunauté sur GitHub.