Skip to content

Clarify pagination description in API Reference. #9548

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: v2
Choose a base branch
from
+11 −1
Draft

Clarify pagination description in API Reference. #9548

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
df1badb
Clarify pagination description in API Reference.
aemous Jun 13, 2025
5594263
Update awscli/customizations/paginate.py
aemous Jun 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion awscli/customizations/paginate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 results in a single request '
'for the first page of results for the command.'
)
% help_command.name
)
Expand All @@ -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 '
'<https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-pagination.html>`__ '
'in the *AWS Command Line Interface User Guide*.'
)
)


def unify_paging_params(
Expand Down
Loading