使用 中的分頁選項 AWS CLI - AWS Command Line Interface
伺服器端分頁

本文件 AWS CLI 僅適用於 第 1 版。如需 第 2 版的相關文件 AWS CLI，請參閱 第 2 版使用者指南。

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

使用 中的分頁選項 AWS CLI

本主題說明從 AWS Command Line Interface () 分頁輸出的不同方式AWS CLI。

伺服器端分頁

對於傳回大量項目清單的大多數命令， AWS CLI 具有多個伺服器端選項，可在 AWS CLI 呼叫服務的 API 填入清單時控制輸出中包含的項目數量。中的伺服器端分頁由 AWS 服務 API AWS CLI 啟用，因此這些選項只有在服務 API 啟用時才有效。

大多數 AWS CLI 命令的選項包括下列項目：

根據預設， AWS CLI 會使用由個別服務決定的頁面大小，並擷取所有可用的項目。例如，Amazon S3 的預設頁面大小為 1000。例如，如果您在包含 3,500 個物件的 Amazon S3 儲存貯體上執行 aws s3api list-objects， AWS CLI 會自動對 Amazon S3 進行 4 次呼叫、在背景為您處理服務特定的分頁邏輯，並在最終輸出中傳回全部 3,500 個物件。

如需特定命令是否具有伺服器端分頁的詳細資訊，請參閱AWS CLI 參考指南第 。

如何使用 --no-paginate 參數

--no-paginate 選項在客户端停用以下分頁標記。使用命令時， 預設 AWS CLI 會自動進行多次呼叫，以傳回所有可能的結果來建立分頁。每個頁面一個呼叫。停用分頁對於命令結果的第一頁 AWS CLI 只有一次呼叫。

例如，如果您在包含 3，500 個物件的 Amazon S3 儲存貯體aws s3api list-objects上執行 ，則 AWS CLI 只會對 Amazon S3 進行第一次呼叫，並在最終輸出中僅傳回前 1，000 個物件。

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

如何使用 --page-size 參數

如果您在針對大量資源執行清單命令時發生問題，可能是預設頁面大小太高。這可能會導致對 AWS 服務的呼叫超過允許的最長時間，並產生「逾時」錯誤。您可以使用 --page-size選項指定從每次呼叫到 AWS 服務 AWS CLI 請求較少數量的項目。 AWS CLI 仍會擷取完整清單，但在背景中執行更多次的服務 API 呼叫，並在每次呼叫時擷取較少數量的項目。這可讓每次呼叫不逾時的成功機會更高。變更頁面大小不會影響輸出；它只會影響產生輸出所需進行的 API 呼叫數量。

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

如何使用 --max-items 參數

若要一次在 AWS CLI 輸出中包含較少的項目，請使用 --max-items選項。 AWS CLI 仍會依先前所述使用 服務處理分頁，但一次只會列印您指定的項目數量。

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

如何使用 --starting-token 參數

如果項目輸出數量 (--max-items) 少於基礎 API 呼叫傳回的項目總數，則輸出會包含一個 NextToken，提供您在後續命令中傳送以擷取下一組項目。以下範例說明如何使用前一範例傳回的 NextToken 值，並讓您擷取第二批的 100 個項目。

注意

參數 --starting-token 不能為 null 或空白。如果先前的命令未傳回 NextToken 值，表示已沒有更多項目可傳回，您也不需要再次呼叫命令。

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

指定的 AWS 服務可能不會在您每次呼叫時以相同的順序傳回項目。如果您為 --page-size 和 --max-items 指定不同的數值，您可能會取得意外的結果，並發生遺漏或重複的項目。欲避免此情況，請對 --page-size 和 --max-items 使用相同數字，以同步 AWS CLI 和基礎服務的分頁。您亦可擷取整個清單，並於本機執行所需的分頁操作。