Attivazione e utilizzo dei prompt dei comandi in AWS CLI

È possibile fare in modo che la versione 2 della AWS CLI richieda comandi, parametri e risorse quando si esegue un comando aws.

Come funziona

Se abilitato, il prompt automatico consente di utilizzare il tasto INVIO per completare un comando immesso parzialmente. Dopo aver premuto il tasto INVIO, vengono suggeriti comandi, parametri e risorse in base a ciò che si continua a digitare. I suggerimenti elencano il nome del comando, del parametro o della risorsa a sinistra e una descrizione a destra. Per selezionare e utilizzare un suggerimento, utilizza i tasti freccia per evidenziare una riga, quindi premi il tasto SPAZIO. Dopo aver immesso il comando, premi INVIO per utilizzare il comando. L’esempio seguente mostra l’aspetto di un elenco suggerito dal prompt automatico.

$ aws
> aws a
       accessanalyzer                Access Analyzer
       acm                           AWS Certificate Manager
       acm-pca                       AWS Certificate Manager Private Certificate Authority
       alexaforbusiness              Alexa For Business
       amplify                       AWS Amplify

Funzionalità di prompt automatico

Il prompt automatico contiene le seguenti utili funzionalità:

Pannello della documentazione

Fornisce la documentazione di aiuto per il comando corrente. Per aprire la documentazione, premi il tasto F3.

Completamento dei comandi

Suggerisce i comandi aws da utilizzare. Per visualizzare un elenco, inserisci parzialmente il comando. L’esempio seguente è la ricerca di un servizio che inizia con la lettera a.

$ aws
> aws a
       accessanalyzer                Access Analyzer
       acm                           AWS Certificate Manager
       acm-pca                       AWS Certificate Manager Private Certificate Authority
       alexaforbusiness              Alexa For Business
       amplify                       AWS Amplify

Completamento dei parametri

Dopo aver digitato un comando, il prompt automatico inizia a suggerire i parametri. Le descrizioni dei parametri includono il tipo di valore e una descrizione del parametro. I parametri obbligatori vengono elencati per primi e sono etichettati come obbligatori. L’esempio seguente mostra l’elenco di parametri con prompt automatico per aws dynamodb describe-table.

$ aws dynamodb describe-table
> aws dynamodb describe-table 
                              --table-name (required)  [string] The name of the table to describe.
                               --cli-input-json         [string] Reads arguments from the JSON string provided. The JSON string follows the format provide...
                               --cli-input-yaml         [string] Reads arguments from the YAML string provided. The YAML string follows the format provide...
                               --generate-cli-skeleton  [string] Prints a JSON skeleton to standard output without sending an API request. If provided wit...

Completamento delle risorse

Il prompt automatico effettua chiamate API AWS utilizzando le proprietà delle risorse AWS disponibili per suggerire i valori delle risorse. Ciò consente al prompt automatico di suggerire possibili risorse di tua proprietà quando inserisci i parametri. Nell’esempio seguente, il prompt automatico elenca i nomi delle tabelle durante la compilazione del parametro --table-name per il comando aws dynamodb describe-table.

$ aws dynamodb describe-table
> aws dynamodb describe-table --table-name 
                                            Table1
                                            Table2
                                            Table3

Completamento abbreviato

Per i parametri che utilizzano una sintassi abbreviata, il prompt automatico suggerisce i valori da utilizzare. Nell’esempio seguente, il prompt automatico elenca i valori di sintassi abbreviata per il parametro --placement nel comando aws ec2 run-instances.

$ aws ec2 run-instances
> aws ec2 run-instances --placement 
 AvailabilityZone=      [string] The Availability Zone of the instance. If not specified, an Availability Zone wil...
 Affinity=              [string] The affinity setting for the instance on the Dedicated Host. This parameter is no...
 GroupName=             [string] The name of the placement group the instance is in.
 PartitionNumber=       [integer] The number of the partition the instance is in. Valid only if the placement grou...

Completamento del file

Durante la compilazione dei parametri nei comandi aws, il completamento automatico suggerisce i nomi di file locali dopo aver usato il prefisso file:// o fileb://. Nell’esempio seguente, il prompt automatico suggerisce i file locali dopo aver immesso --item file:// per il comando aws ec2 run-instances.

$ aws ec2 run-instances
> aws ec2 run-instances --item file:// 
                         item1.txt
                         file1.json
                         file2.json

Completamento della Regione

Quando si utilizza il parametro globale --region, il prompt automatico elenca le possibili Regioni tra cui scegliere. Nell’esempio seguente, il prompt automatico suggerisce le Regioni in ordine alfabetico dopo aver immesso --region per il comando aws dynamodb list-tables.

$ aws dynamodb list-tables
> aws dynamodb list-tables --region 
                                     af-south-1
                                     ap-east-1
                                     ap-northeast-1
                                     ap-northeast-2

Completamento del profilo

Quando si utilizza il parametro globale --profile, il prompt automatico elenca i profili. Nell’esempio seguente, il prompt automatico suggerisce i profili dopo aver immesso --profile per il comando aws dynamodb list-tables.

$ aws dynamodb list-tables
> aws dynamodb list-tables --profile 
                                     profile1
                                     profile2
                                     profile3

Ricerche fuzzy

Comandi e valori completi che contengono un set di caratteri specifico. Nell’esempio seguente, il prompt automatico suggerisce le Regioni che contengono eu dopo aver immesso --region eu per il comando aws dynamodb list-tables.

$ aws dynamodb list-tables
> aws dynamodb list-tables --region west
                                         eu-west-1
                                         eu-west-2
                                         eu-west-3
                                         us-west-1

Cronologia

Per visualizzare ed eseguire i comandi utilizzati in precedenza in modalità prompt automatico, premere CTRL + R. La cronologia elenca i comandi precedenti che è possibile selezionare utilizzando i tasti freccia. Nell’esempio seguente, viene visualizzata la cronologia della modalità di prompt automatico.

$ aws
> aws 
        dynamodb list-tables
        s3 ls

Modalità di prompt automatico

Il prompt automatico per la versione 2 della AWS CLI dispone di 2 modalità configurabili:

• Modalità completa: utilizza il prompt automatico ogni volta che tenti di eseguire un comando aws, sia che lo si richiami manualmente utilizzando il parametro --cli-auto-prompt sia che venga abilitato in modo permanente. Include il dover premere INVIO dopo un comando completo o incompleto.

• Modalità parziale: utilizza il prompt automatico se un comando è incompleto o non può essere eseguito a causa di errori di convalida lato client. Questa modalità è particolarmente utile se sono disponibili script e runbook preesistenti o per ricevere un prompt automatico solo per i comandi che non si conoscono piuttosto che per ogni comando.

Configurare il prompt automatico

Per configurare il prompt automatico puoi utilizzare i seguenti metodi in ordine di precedenza:

• Opzioni della riga di comando abilitano o disabilitano il prompt automatico per un singolo comando. Utilizza --cli-auto-prompt per chiamare il prompt automatico e --no-cli-auto-prompt per disabilitare il prompt automatico.

• Le variabili di ambiente utilizzano la variabile aws_cli_auto_prompt.

• I file di configurazione condivisi utilizzano l’impostazione cli_auto_prompt.