Skip to content
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

Jump to bottom

ec2 describe-regions: meaning of --no-paginate is unclear #8281

Closed
NotizMe opened this issue Oct 31, 2023 · 3 comments
Closed

ec2 describe-regions: meaning of --no-paginate is unclear #8281

NotizMe opened this issue Oct 31, 2023 · 3 comments
Assignees
@RyanFitzSimmonsAK
Labels
documentation This is a problem with documentation. feature-request A feature should be added or improved. has-pr This issue has a PR associated with it. p3 This is a minor priority issue paginator

Comments

@NotizMe
Copy link

NotizMe commented Oct 31, 2023

Describe the issue

Issue

The documentation for the Global Option --no-paginate is unclear. As a reader I thought this was about client-side pagination using a tool like less.

Solution

It would be good to mention it disables making more then one call for fetching of subsequent pages. Please also add a link to Use AWS CLI pagination options.

Proposal

--no-paginate (boolean)

Disables automatically making multiple calls to return all possible results. Disabling pagination has the AWS CLI only call once for the first page of command results.

See Use AWS CLI pagination options

Links

https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-regions.html#global-options
@NotizMe NotizMe added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Oct 31, 2023
@RyanFitzSimmonsAK RyanFitzSimmonsAK self-assigned this Oct 31, 2023
@RyanFitzSimmonsAK RyanFitzSimmonsAK added p3 This is a minor priority issue and removed needs-triage This issue or PR still needs to be triaged. labels Oct 31, 2023
@RyanFitzSimmonsAK RyanFitzSimmonsAK added the investigating This issue is being investigated and/or work is in progress to resolve the issue. label Dec 20, 2023
@RyanFitzSimmonsAK RyanFitzSimmonsAK mentioned this issue Jun 7, 2024
Closed
@RyanFitzSimmonsAK RyanFitzSimmonsAK added has-pr This issue has a PR associated with it. feature-request A feature should be added or improved. and removed investigating This issue is being investigated and/or work is in progress to resolve the issue. labels Jun 11, 2024
@RyanFitzSimmonsAK
Copy link
Contributor

Hi @NotizMe, thanks for your patience. I've cut a PR to add a bit more detail to the description of no-paginate parameter.

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

This was referenced Sep 11, 2024
Merged
Merged
@RyanFitzSimmonsAK
Copy link
Contributor

The PRs were merged; this is done. Thanks for submitting this!

@github-actions GitHub Actions
Copy link

This issue is now closed. Comments on closed issues are hard for our team to see.
If you need more assistance, please open a new issue that references this one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@RyanFitzSimmonsAK RyanFitzSimmonsAK

Labels
documentation This is a problem with documentation. feature-request A feature should be added or improved. has-pr This issue has a PR associated with it. p3 This is a minor priority issue paginator
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@NotizMe @RyanFitzSimmonsAK @tim-finnigan