Accesso all’aiuto e alle risorse per AWS CLI

Nome del comando.

NAME
       describe-instances -

Descrizione dell'operazione API richiamata dal comando.

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

Sintassi di base per l'utilizzo del comando e delle relative opzioni. Le opzioni tra parentesi quadre sono facoltative, hanno un valore predefinito oppure hanno un'opzione che può essere utilizzata in alternativa.

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]

Ad esempio, describe-instances ha un comportamento predefinito che descrive tutte le istanze nell'account e nella regione AWS correnti. Puoi specificare, a tua discrezione, un elenco di instance-ids per descrivere una o più istanze. dry-run è un flag booleano opzionale che non utilizza un valore. Per usare un flag booleano specifica il valore mostrato, in questo caso --dry-run o --no-dry-run. Anche --generate-cli-skeleton non utilizza un valore. Se per l'utilizzo di un'opzione sono previste condizioni, queste sono descritte nella sezione OPTIONS o mostrate negli esempi.

Descrizione di ogni singola opzione mostrata nella sinossi.

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

Esempi che mostrano l'utilizzo del comando e delle relative opzioni. Se non è disponibile l'esempio per un comando o un caso d'uso specifico, richiedine uno utilizzando il collegamento di feedback in questa pagina o nella guida di riferimento ai comandi di AWS CLI nella pagina della Guida relativa al comando.

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

Descrizioni di ciascuno dei campi e dei tipi di dati inclusi nella risposta di AWS.

Per describe-instances, l'output è un elenco di oggetti prenotazione, ciascuno dei quali contiene diversi campi e oggetti che includono informazioni sulle istanze a essi associate. Queste informazioni provengono dalla documentazione API per il tipo di dati di prenotazione utilizzato da 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.
...

Quando AWS CLI esegue il rendering dell'output in formato JSON, diventa un array di oggetti di prenotazione, simile all'esempio seguente.

{
    "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"
                    },
...

Ogni oggetto prenotazione contiene campi che descrivono la prenotazione e una serie di oggetti istanza, ognuno con specifici campi (ad esempio, PublicDnsName) e oggetti (ad esempio, State) che lo descrivono.

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