aws-doc-sdk-examples icon indicating copy to clipboard operation
aws-doc-sdk-examples copied to clipboard

[EPIC]: Tech debt for paginated actions

Open rlhagerm opened this issue 1 year ago • 2 comments

Address tech debt to meet the following requirements for any service action examples that support pagination (use a continuation token). Going forward, the team MUST do SOMETHING with the continuation tokens for calls that support paging. Examples should do one of the following:

  1. If the intent is listing "all" items, pagination should be included to return all pages of data.
  2. If the intent is to list X number of items, this should be explicitly stated and checked for.
  3. Hello World examples that do not list or return all items must still demonstrate that paging could be used by checking the continuation token. This can include a message to the user that more items exist.

Each language will need a tech debt item to address existing examples.

  • [ ] #5808
  • Bash Pagination tech debt (Nothing to do. CLI paginates by default)
  • [x] #6219
  • [ ] Go Pagination tech debt
  • [ ] #6458
  • [ ] Java Pagination tech debt
  • [ ] PHP Pagination tech debt
  • [ ] Python Pagination tech debt
  • [ ] Ruby Pagination tech debt
  • [ ] Rust Pagination tech debt
  • [ ] Switch Pagination tech debt

rlhagerm avatar Nov 29 '23 19:11 rlhagerm

Hi, on Bash Pagination tech debt (Nothing to do. CLI paginates by default) - aws s3control list-access-points does not paginate by default. A bash example would be nice.

stevencasey avatar Jun 06 '24 02:06 stevencasey

The aws cli uses boto3, and it uses the boto3 paginator when available. It has a global --no-paginate option to turn off use of the paginator. In some cases, like aws s3control list-access-points, the results are limited to a specific number, 1000 for access points. This is a different issue.

You can create a separate issue for this and request a code example.

meyertst-aws avatar Jun 06 '24 13:06 meyertst-aws