From df1badba1b958b96cb9aa92a8249944d752281d1 Mon Sep 17 00:00:00 2001 From: aemous Date: Fri, 13 Jun 2025 15:42:14 -0400 Subject: [PATCH 1/2] Clarify pagination description in API Reference. --- awscli/customizations/paginate.py | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/awscli/customizations/paginate.py b/awscli/customizations/paginate.py index bb8f31914dc4..5f1a25fae62c 100644 --- a/awscli/customizations/paginate.py +++ b/awscli/customizations/paginate.py @@ -110,7 +110,9 @@ def add_paging_description(help_command, **kwargs): ( '``%s`` is a paginated operation. Multiple API calls may be issued ' 'in order to retrieve the entire data set of results. You can ' - 'disable pagination by providing the ``--no-paginate`` argument.' + 'disable automatic pagination by providing the ``--no-paginate`` ' + 'argument. Disabling automatic pagination has the AWS CLI only call ' + 'once for the first page of command results.' ) % help_command.name ) @@ -128,6 +130,14 @@ def add_paging_description(help_command, **kwargs): ) % queries ) + # Link to AWS User Guide for more information on pagination + help_command.doc.writeln( + ( + 'For more information, see `Using the pagination options in the AWS CLI ' + '`__ ' + 'in the *AWS Command Line Interface User Guide*.' + ) + ) def unify_paging_params( From 5594263ccfb8ded2c30567f428eff2fa32740eac Mon Sep 17 00:00:00 2001 From: Ahmed Moustafa <35640105+aemous@users.noreply.github.com> Date: Mon, 16 Jun 2025 09:10:19 -0400 Subject: [PATCH 2/2] Update awscli/customizations/paginate.py Co-authored-by: Kenneth Daily --- awscli/customizations/paginate.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/awscli/customizations/paginate.py b/awscli/customizations/paginate.py index 5f1a25fae62c..ca8085556bb1 100644 --- a/awscli/customizations/paginate.py +++ b/awscli/customizations/paginate.py @@ -111,8 +111,8 @@ def add_paging_description(help_command, **kwargs): '``%s`` is a paginated operation. Multiple API calls may be issued ' 'in order to retrieve the entire data set of results. You can ' 'disable automatic pagination by providing the ``--no-paginate`` ' - 'argument. Disabling automatic pagination has the AWS CLI only call ' - 'once for the first page of command results.' + 'argument. Disabling automatic pagination results in a single request ' + 'for the first page of results for the command.' ) % help_command.name )