View a markdown version of this page

Paginasi - AWS SDK dan Alat

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Paginasi

Banyak operasi AWS layanan dapat mengembalikan lebih banyak hasil daripada yang sesuai dalam satu respons. Ketika ini terjadi, respons menyertakan token pagination yang menunjukkan lebih banyak hasil yang tersedia. Untuk mengambil halaman hasil berikutnya, Anda menyertakan token itu dalam permintaan berikutnya. Proses ini berulang sampai tidak ada token yang dikembalikan, menunjukkan bahwa Anda telah menerima semua hasil.

Cara kerja pagination

Saat Anda memanggil operasi API berpaginasi, layanan mengembalikan jumlah item maksimum tetap per respons. Jika jumlah total item melebihi maksimum ini, layanan menyertakan token pagination dalam respons. Nama spesifik token ini bervariasi menurut layanan—nama umum termasukNextToken,, MarkerContinuationToken, dan. ExclusiveStartKey Untuk meminta halaman berikutnya, Anda meneruskan nilai token ini di parameter permintaan yang sesuai dari panggilan Anda berikutnya.

Sebagian besar operasi paginasi juga mendukung parameter yang mengontrol jumlah maksimum item yang dikembalikan per halaman. Nama umum untuk parameter ini termasukMaxResults,MaxItems,MaxKeys,MaxRecords, danLimit.

Token pagination hanya valid jika Anda menerimanya dalam respons sebelumnya dari operasi yang sama. Jika respons tidak menyertakan token, tidak ada lagi hasil untuk diambil.

Menggunakan paginator

Alih-alih melacak token pagination secara manual, semua AWS SDK menyediakan abstraksi pag inator. Paginator menangani manajemen token secara otomatis, membuat panggilan API berturut-turut dan menghasilkan hasil sampai semua halaman diambil. Menggunakan paginator menyederhanakan kode Anda dan mengurangi risiko kesalahan seperti lupa meneruskan token atau menggunakannya secara tidak benar.

Karakteristik utama paginator di seluruh SDK:

  • Paginator menerima parameter input yang sama dengan operasi API yang mendasarinya.

  • Paginator secara otomatis mendeteksi ketika lebih banyak halaman tersedia dan mengambilnya.

  • Paginator berhenti membuat permintaan ketika tidak ada token pagination yang dikembalikan dalam respons.

  • Beberapa SDK juga menyediakan mekanisme untuk membatasi jumlah total halaman atau item yang diambil.

Lihat panduan pengembang SDK spesifik Anda untuk sintaks paginator dan pola penggunaan yang tersedia dalam bahasa Anda.

Dukungan oleh AWS SDK dan alat

SDK berikut mendukung fitur dan pengaturan yang dijelaskan dalam topik ini. Setiap pengecualian sebagian dicatat. Setiap pengaturan properti sistem JVM didukung oleh AWS SDK untuk Java dan AWS SDK untuk Kotlin satu-satunya.

SDK Didukung Catatan atau informasi lebih lanjut
AWS CLI v2 Ya Built-in pagination otomatis untuk semua perintah. Gunakan --no-paginate untuk menonaktifkan.
SDK untuk C++ Tidak Diperlukan penanganan token manual.
SDK untuk Go V2 (1.x) Ya Gunakan New<OperationName>Paginator jenis.
SDK untuk Go 1.x (V1) Ya Gunakan <OperationName>Pages metode.
SDK untuk Java 2.x Ya Gunakan <operationName>Paginator metode pada klien.
SDK untuk Java 1.x Ya
SDK untuk JavaScript 3.x Ya Gunakan paginate<OperationName> fungsi.
SDK untuk JavaScript 2.x Tidak Diperlukan penanganan token manual.
SDK para Kotlin Ya Gunakan fungsi <operationName>Paginated ekstensi.
SDK untuk.NET 4.x Ya Gunakan IPaginator antarmuka.
SDK untuk.NET 3.x Ya Gunakan IPaginator antarmuka.
SDK para PHP 3.x Ya Gunakan getPaginator pada klien.
SDK untuk Python (Boto3) Ya Gunakan get_paginator pada klien.
SDK para Ruby 3.x Ya Gunakan .each pada tanggapan yang mendukung pagination.
SDK para Rust Ya Gunakan pembangun .into_paginator() berdasarkan permintaan.
SDK para Swift Ya Gunakan PaginatedSequence jenis.
Alat untuk PowerShell V5 Ya Built-in paginasi otomatis. Gunakan -NoAutoIteration untuk menonaktifkan.
Alat untuk PowerShell V4 Ya