Verwenden von AWS CLI-Paginierungsoptionen - 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.

Verwenden von AWS CLI-Paginierungsoptionen

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

Serverseitige Paginierung

Einige Befehle können eine umfangreiche Liste mit Elementen zurückgeben. Die AWS Command Line Interface (AWS CLI) bietet mehrere Optionen, mit denen Sie die Anzahl der Elemente in der Ausgabe steuern können, wenn die AWS CLI die API eines Service aufruft, um die Liste zu füllen.

Standardmäßig verwendet die AWS CLI eine vom einzelnen Service festgelegte Seitengröße 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 AWS CLI standardmäßig automatisch mehrere Aufrufe durch, um alle möglichen Ergebnisse zum Erstellen einer Paginierung zurückzugeben. Ein Aufruf für jede Seite. Beim Deaktivieren der Paginierung wird der AWS CLI-Aufruf nur einmal für die erste Seite der Befehlsergebnisse angezeigt.

Wenn Sie beispielsweise aws s3api list-objects in einem Amazon-S3-Bucket ausführen, der 3 500 Objekte enthält, führt AWS CLI nur den ersten Aufruf an Amazon S3 durch und gibt nur die ersten 1 000 Objekte in der endgültigen Ausgabe 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 es bei Aufrufen von AWS-Services zu Zeitüberschreitungen kommt und ein Zeitüberschreitungsfehler generiert wird. Sie können die Option --page-size verwenden, um anzugeben, dass die AWS CLI eine geringere Anzahl an Elementen bei Aufrufen des AWS-Services anfordert. Die AWS CLI wird weiterhin die vollständige Liste abrufen, aber eine größere Anzahl von Service-API-Aufrufen im Hintergrund verarbeiten und bei jedem Aufruf eine geringere Anzahl von Elementen abrufen. Dadurch ist es wahrscheinlicher, dass Aufrufe nicht zu einem Zeitüberschreitungsfehler führen. Das Ändern der Seitengröße hat keine Auswirkungen auf die Ausgabe. Es wirkt sich nur auf die Anzahl der API-Aufrufe aus, die erforderlich sind, um die Ausgabe zu generieren.

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

So verwenden Sie den –max-items-Parameter

Verwenden Sie die Option --max-items, damit bei einem Aufruf weniger Elemente in der AWS CLI-Ausgabe enthalten sind. Die AWS CLI verarbeitet die Paginierung im Service weiterhin wie vorher beschrieben, druckt jedoch jeweils nur die Anzahl der Elemente, 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 ausgegebenen Elemente (--max-items) geringer als die Gesamtanzahl der Elemente ist, die von den zugrunde liegenden API-Aufrufen zurückgeliefert werden, enthält die Ausgabe ein NextToken. Dieses können Sie in einem anschließenden Befehl zum Abrufen der nächsten Gruppe von Elementen übergeben. 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-Service gibt Elemente möglicherweise nicht bei jedem Aufruf in der gleichen 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.