AWS CLI Paginierungsoptionen verwenden - AWS Command Line Interface

Diese Dokumentation bezieht sich AWS CLI nur auf Version 1 von. Dokumentation zu Version 2 von finden Sie im Benutzerhandbuch für Version 2. AWS CLI

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

AWS CLI Paginierungsoptionen verwenden

In diesem Thema werden die verschiedenen Möglichkeiten beschrieben, die Ausgabe der AWS CLI zu paginieren.

Serverseitige Paginierung

Bei Befehlen, die eine große Liste von Elementen zurückgeben können, bietet AWS Command Line Interface (AWS CLI) mehrere Optionen, um die Anzahl der Elemente zu steuern, die in der Ausgabe enthalten sind, wenn der API Dienst die Liste AWS CLI auffüllt.

Standardmäßig AWS CLI verwendet der eine Seitengröße, die vom jeweiligen Dienst bestimmt wird, und ruft alle verfügbaren Elemente ab. Amazon S3 hat beispielsweise eine Standardseitengröße von 1 000. Wenn Sie aws s3api list-objects auf einem Amazon-S3-Bucket ausführen, der 3 500 Objekte enthält, ruft die AWS CLI Amazon S3 automatisch vier Mal auf, verarbeitet die servicespezifische Paginierungslogik für Sie im Hintergrund und gibt alle 3 500 Objekte in der endgültigen Ausgabe zurück.

So verwenden Sie den --no-paginate-Parameter

Die --no-paginate-Option deaktiviert folgende Paginierungs-Token auf der Client-Seite. Wenn Sie einen Befehl verwenden, führt der standardmäßig AWS CLI automatisch mehrere Aufrufe durch, um alle möglichen Ergebnisse zurückzugeben und eine Seitennummerierung zu erstellen. Ein Aufruf für jede Seite. Beim Deaktivieren der Paginierung wird die erste Seite mit Befehlsergebnissen AWS CLI nur einmal aufgerufen.

Wenn Sie beispielsweise einen aws s3api list-objects Amazon S3-Bucket verwenden, der 3.500 Objekte enthält, ruft der Amazon S3 AWS CLI nur zum ersten Mal auf und gibt in der endgültigen Ausgabe nur die ersten 1.000 Objekte zurück.

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

So verwenden Sie den –page-size-Parameter

Wenn beim Ausführen von Listenbefehlen für eine große Anzahl von Ressourcen Probleme auftreten, ist die Standardseitengröße möglicherweise zu hoch. Dies kann dazu führen, dass Aufrufe von AWS Diensten die maximal zulässige Zeit überschreiten und zu einem „Timeout“ -Fehler führen. Sie können die --page-size Option verwenden, um anzugeben, dass bei jedem Aufruf des AWS Dienstes eine geringere Anzahl von Elementen AWS CLI angefordert wird. Der ruft AWS CLI immer noch die vollständige Liste ab, führt jedoch eine größere Anzahl von API Serviceaufrufen im Hintergrund durch und ruft bei jedem Aufruf eine geringere Anzahl von Elementen ab. Dadurch ist es wahrscheinlicher, dass Aufrufe nicht zu einem Zeitüberschreitungsfehler führen. Eine Änderung der Seitengröße wirkt sich nicht auf die Ausgabe aus, sondern nur auf die Anzahl der API Aufrufe, die zur Generierung der Ausgabe erforderlich sind.

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

So verwenden Sie den –max-items-Parameter

Verwenden Sie die --max-items Option, um weniger Elemente gleichzeitig in die AWS CLI Ausgabe aufzunehmen. Der verarbeitet die Seitennummerierung mit dem Service AWS CLI weiterhin wie zuvor beschrieben, druckt aber nur die Anzahl der Elemente gleichzeitig aus, die Sie angeben.

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

So verwenden Sie den –starting-token-Parameter

Wenn die Anzahl der Output (--max-items) -Elemente geringer ist als die Gesamtzahl der von den zugrunde liegenden API Aufrufen zurückgegebenen Elemente, enthält die Ausgabe eine, NextToken die Sie an einen nachfolgenden Befehl übergeben können, um die nächste Gruppe von Elementen abzurufen. Im folgenden Beispiel wird gezeigt, wie Sie den Wert NextToken aus dem vorherigen Beispiel verwenden und die zweiten hundert Elemente abrufen.

Anmerkung

Der Parameter --starting-token kann nicht null oder leer sein. Wenn der vorherige Befehl keinen NextToken-Wert zurückgibt, können keine weiteren Elemente zurückgegeben werden und Sie müssen den Befehl nicht erneut aufrufen.

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

Der angegebene AWS Dienst gibt möglicherweise nicht bei jedem Aufruf Elemente in derselben Reihenfolge zurück. Wenn Sie verschiedene Werte für --page-size und --max-items angeben, können Sie unerwartete Ergebnisse mit fehlenden oder doppelten Elementen bekommen. Um dies zu verhindern, verwenden Sie dieselbe Zahl für --page-size und --max-items, um die Paginierung der AWS CLI mit der Paginierung der zugrunde liegenden Services zu synchronisieren. Sie können auch die gesamte Liste abrufen und erforderliche Paginierungsvorgänge lokal durchführen.