Utilizzo delle opzioni di impaginazione in AWS CLI - AWS Command Line Interface

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

Utilizzo delle opzioni di impaginazione in AWS CLI

Questo argomento descrive i diversi modi per impaginare l'output di AWS Command Line Interface ()AWS CLI.

Esistono principalmente due modi per controllare la paginazione dalla AWS CLI.

I parametri di paginazione lato server elaborano e qualsiasi output viene inviato alla paginazione lato client.

Paginazione lato server

Per la maggior parte dei comandi che restituiscono un ampio elenco di elementi, AWS CLI dispone di diverse opzioni lato server per controllare il numero di elementi inclusi nell'output quando AWS CLI chiama l'API di un servizio per compilare l'elenco. L'impaginazione lato server in AWS CLI è abilitata dall'API del AWS servizio, pertanto queste opzioni funzionano solo se l'API del servizio le abilita.

Le opzioni per la maggior parte dei AWS CLI comandi includono:

Per impostazione predefinita, AWS CLI utilizza una dimensione di pagina determinata dal singolo servizio e recupera tutti gli elementi disponibili. Ad esempio, Amazon S3 ha una dimensione di pagina predefinita di 1000. Se esegui aws s3api list-objects in un bucket che contiene 3500 oggetti, la AWS CLI effettua automaticamente quattro chiamate a Amazon S3, gestendo la logica di paginazione specifica del servizio in background e restituendo tutti i 3500 oggetti nell’output finale.

Per informazioni sull'impaginazione lato server di uno specifico comando, consultate la guida di riferimento AWS CLI versione 2 della .

Come utilizzare il parametro --no-paginate

L’opzione --no-paginate disabilita i token di paginazione seguenti sul lato client. Quando si utilizza un comando, per impostazione predefinita effettua AWS CLI automaticamente più chiamate per restituire tutti i risultati possibili per creare l'impaginazione. Una chiamata per ogni pagina. La disattivazione dell'impaginazione comporta l' AWS CLI unica chiamata una volta per la prima pagina dei risultati del comando.

Ad esempio, se esegui aws s3api list-objects su un bucket Amazon S3 che contiene 3.500 oggetti, effettua AWS CLI solo la prima chiamata ad Amazon S3, restituendo solo i primi 1.000 oggetti nell'output finale.

$ aws s3api list-objects \ --bucket amzn-s3-demo-bucket \ --no-paginate { "Contents": [ ...

Come utilizzare il parametro --page-size

Se vengono rilevati errori quando esegui i comandi dell’elenco per un numero elevato di risorse, le dimensioni di pagina predefinite potrebbero essere eccessive. Ciò può far sì che le chiamate ai AWS servizi superino il tempo massimo consentito e generare un errore di «timeout». È possibile utilizzare l'--page-sizeopzione per specificare che si AWS CLI richiede un numero inferiore di elementi per ogni chiamata al AWS servizio. Continua AWS CLI a recuperare l'elenco completo, ma esegue un numero maggiore di chiamate API di servizio in background e recupera un numero inferiore di elementi a ogni chiamata. In questo modo, le chiamate individuali hanno una migliore possibilità di completamento prima della scadenza. La modifica delle dimensioni della pagina non pregiudica l'output, ma solo il numero di chiamate API che deve essere effettuato per generare l'output.

$ aws s3api list-objects \ --bucket amzn-s3-demo-bucket \ --page-size 100 { "Contents": [ ...

Come utilizzare il parametro --max-items

Per includere nell' AWS CLI output un numero inferiore di elementi alla volta, utilizzate l'--max-itemsopzione. The AWS CLI still gestisce l'impaginazione con il servizio come descritto in precedenza, ma stampa solo il numero di elementi alla volta specificato.

$ aws s3api list-objects \ --bucket amzn-s3-demo-bucket \ --max-items 100 { "NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAxfQ==", "Contents": [ ...

Come utilizzare il parametro --starting-token

Se l'output del numero di elementi (--max-items) è inferiore rispetto al numero totale di elementi restituito dalle chiamate API sottostanti, l'output include NextToken, che può essere trasferito a un comando successivo per recuperare il set di elementi successivo. L'esempio seguente mostra come usare il valore NextToken restituito dall'esempio precedente e consente di recuperare il secondo centinaio di elementi.

Nota

Il parametro --starting-token non può essere null o vuoto. Se il comando precedente non restituisce un valore NextToken, non esistono altre voci da restituire e non dovrai richiamare di nuovo il comando.

$ aws s3api list-objects \ --bucket amzn-s3-demo-bucket \ --max-items 100 \ --starting-token eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAxfQ== { "Contents": [ ...

Il AWS servizio specificato potrebbe non restituire gli articoli nello stesso ordine ogni volta che si chiama. Se si specificano valori diversi per --page-size e --max-items, puoi ottenere risultati imprevisti con elementi mancanti o duplicati. Per evitarlo, utilizza lo stesso numero per --page-size e --max-items per sincronizzare la paginazione della AWS CLI con quella del servizio sottostante. Puoi anche recuperare l'intero elenco ed eseguire tutte le operazioni di paginazione necessarie in locale.

Pager lato client

AWS CLI la versione 2 prevede l'uso di un programma pager sul lato client per l'output. Per impostazione predefinita, questa caratteristica restituisce tutto l'output attraverso il programma pager predefinito del sistema operativo.

In ordine di precedenza, puoi specificare il pager di output nei seguenti modi:

  • Utilizzando l’impostazione cli_pager nel file config nel profilo di default o denominato.

  • Utilizzando la variabile di ambiente AWS_PAGER.

  • Utilizzando la variabile di ambiente PAGER.

In ordine di precedenza, è possibile disabilitare qualsiasi utilizzo di un programma di paging esterno nei seguenti modi:

  • Utilizza l’opzione della riga di comando --no-cli-pager per disabilitare il pager per l’utilizzo di un singolo comando.

  • Imposta la configurazione cli_pager o la variabile AWS_PAGER su una stringa vuota.

Argomenti di pager lato client:

Come utilizzare l’impostazione cli_pager

Puoi salvare le impostazioni di configurazione e le credenziali utilizzate di frequente nei file gestiti da AWS CLI. Le impostazioni nel profilo del nome hanno la precedenza sulle impostazioni del profilo di default. Per ulteriori informazioni sulle impostazioni di configurazione, consulta Impostazioni dei file di configurazione e credenziali in AWS CLI.

L’esempio seguente imposta il pager di output predefinito sul programma less.

[default] cli_pager=less

L'esempio seguente configura l'impostazione predefinita per disabilitare l'uso di un pager.

[default] cli_pager=

Come impostare la variabile di ambiente AWS_PAGER

L’esempio seguente imposta il pager di output predefinito sul programma less. Per ulteriori informazioni sulle variabili di ambiente, consulta Configurazione delle variabili di ambiente per AWS CLI.

Linux and macOS
$ export AWS_PAGER="less"
Windows
C:\> setx AWS_PAGER "less"

Come usare l'no-cli-pager opzione --

Per disabilitare l’uso di un pager su un singolo comando, utilizza l’opzione --no-cli-pager. Per ulteriori informazioni, sulle opzioni della riga di comando, consulta Opzioni della riga di comando in AWS CLI.

$ aws s3api list-objects \ --bucket amzn-s3-demo-bucket \ --no-cli-pager { "Contents": [ ...

Come utilizzare i flag del pager

È possibile specificare i flag da utilizzare automaticamente con il programma di paging. I flag dipendono dal programma di paging utilizzato. Gli esempi seguenti riguardano le impostazioni predefinite tipiche di less e more.

Linux and macOS

Se non si specifica diversamente, il pager utilizzato per impostazione predefinita dalla AWS CLI versione 2 èless. Se la variabile di LESS ambiente non è impostata, la AWS CLI versione 2 utilizza i FRX flag. È possibile combinare i flag specificandoli durante l'impostazione del cercapersone. AWS CLI

Nell’esempio seguente viene utilizzato il flag S. Questo flag si combina quindi con i flag FRX predefiniti per creare un flag FRXS.

$ export AWS_PAGER="less -S"

Se non desideri nessuno di questi flag FRX, puoi annullarli. L’esempio seguente nega il flag F per creare un flag RX finale.

$ export AWS_PAGER="less -+F"

Per ulteriori informazioni sui flag less, consulta less su manpages.org.

Windows

Se non specificate diversamente, il pager utilizzato per impostazione predefinita dalla AWS CLI versione 2 non prevede flag aggiuntivimore.

Nell’esempio seguente viene utilizzato il parametro /c.

C:\> setx AWS_PAGER "more /c"

Per ulteriori informazioni sui flag more, consulta more su Microsoft Docs.