Accesso all'aiuto e alle risorse per AWS CLI - AWS Command Line Interface

Questa documentazione è valida AWS CLI solo per la versione 1. Per la documentazione relativa alla versione 2 di AWS CLI, consulta la Guida per l'utente della versione 2.

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Accesso all'aiuto e alle risorse per AWS CLI

Questo argomento descrive come accedere ai contenuti di aiuto per AWS Command Line Interface (AWS CLI).

Il comando AWS CLI help integrato

È possibile ottenere assistenza con qualsiasi comando quando si utilizza il comando AWS Command Line Interface (AWS CLI). Per farlo, basta digitare help al termine del nome di un comando.

Ad esempio, il comando seguente mostra la guida per le AWS CLI opzioni generali e i comandi di primo livello disponibili.

$ aws help

Il comando seguente mostra i comandi specifici di Amazon Elastic Compute Cloud (AmazonEC2) disponibili.

$ aws ec2 help

L'esempio seguente mostra una guida dettagliata per il EC2 DescribeInstances funzionamento di Amazon. L'assistenza include le descrizioni dei parametri di input, i filtri disponibili e tutto ciò che è incluso nell'output. Include anche esempi che mostrano come digitare varianti comuni del comando.

$ aws ec2 describe-instances help

Le informazioni della Guida per ciascun comando sono suddivise in sei sezioni:

Nome

Nome del comando.

NAME describe-instances -
Descrizione

Una descrizione dell'APIoperazione 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. ...
Riepilogo

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 corrente e nella regione. AWS 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.

Opzioni

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

Esempi che mostrano l'utilizzo del comando e delle relative opzioni. Se non è disponibile alcun esempio per un comando o un caso d'uso di cui hai bisogno, richiedine uno utilizzando il link di feedback in questa pagina o nel riferimento al AWS CLI comando nella pagina di aiuto del 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" ...
Output

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 APIdocumentazione relativa al tipo di dati di prenotazione utilizzato da AmazonEC2.

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 inJSON, questo diventa una matrice 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.

Utenti Windows

Puoi eseguire il piping (|) dell'output del comando help su more per visualizzare il file della guida una pagina alla volta. Premete la barra spaziatrice o PgDnper visualizzare altre parti del documento e q per uscire.

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

AWS CLI guida di riferimento

I file della guida contengono collegamenti che non possono essere visualizzati o esplorati dalla riga di comando. È possibile visualizzare e interagire con questi collegamenti utilizzando la guida di riferimento online AWS CLI versione 1 (guida di . Il riferimento contiene anche il contenuto della guida per tutti AWS CLI i comandi. Le descrizioni sono presentate in modo da semplificare la navigazione e la visualizzazione su dispositivi mobili, tablet o schermi del desktop.

APIdocumentazione

Tutti i comandi in the AWS CLI corrispondono alle richieste fatte al pubblico di un AWS servizioAPI. Ogni servizio con un pubblico API ha un API riferimento che può essere trovato nella home page del servizio sul sito Web della AWS documentazione. Il contenuto di un API riferimento varia in base a come API è costruito e al protocollo utilizzato. In genere, un API riferimento contiene informazioni dettagliate sulle operazioni supportate daAPI, sui dati inviati e dal servizio e sulle eventuali condizioni di errore segnalate dal servizio.

APISezioni della documentazione
  • Azioni: informazioni dettagliate su ciascuna operazione e sui relativi parametri (inclusi vincoli di lunghezza o contenuto e valori predefiniti). Vengono elencati gli errori che possono verificarsi per questa operazione. Ogni operazione corrisponde a un sottocomando in. AWS CLI

  • Tipi di dati: informazioni dettagliate sulle strutture che un comando potrebbe richiedere come parametro o restituire in risposta a una richiesta.

  • Parametri comuni: informazioni dettagliate sui parametri condivisi da tutte le azioni del servizio.

  • Errori comuni: informazioni dettagliate sugli errori che possono essere restituiti da qualsiasi operazione del servizio.

Il nome e la disponibilità di ogni sezione possono variare a seconda del servizio.

Specifico del servizio CLIs

Alcuni servizi hanno un codice separato CLI che risale a prima che ne AWS CLI venisse creato uno specifico per funzionare con tutti i servizi. Questi servizi specifici CLIs hanno una documentazione separata che è collegata alla pagina della documentazione del servizio. La documentazione relativa ai servizi specifici CLIs non si applica a. AWS CLI

Risoluzione degli errori

Per informazioni sulla diagnosi e la correzione degli AWS CLI errori, vedere. Risoluzione degli errori per AWS CLI

Aiuto aggiuntivo

Per ulteriore assistenza con i tuoi AWS CLI problemi, visita la AWS CLI community su GitHub.